[#2] Update spec

Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
This commit is contained in:
Denis Kirillov 2022-12-16 12:51:08 +03:00 committed by Alex Vanin
parent 087a1c79db
commit 24817701ee
62 changed files with 171 additions and 205 deletions

View file

@ -14,7 +14,7 @@ import (
"github.com/go-openapi/validate" "github.com/go-openapi/validate"
) )
// Action Rule execution result action in NeoFS EACL. Either allows or denies access if the rule's filters match. // Action Rule execution result action in FrostFS EACL. Either allows or denies access if the rule's filters match.
// //
// swagger:model Action // swagger:model Action
type Action string type Action string

View file

@ -14,7 +14,7 @@ import (
"github.com/go-openapi/validate" "github.com/go-openapi/validate"
) )
// Address Address of the object in NeoFS. // Address Address of the object in FrostFS.
// Example: {"containerId":"5HZTn5qkRnmgSz9gSrw22CEdPPk6nQhkwf2Mgzyvkikv","objectId":"8N3o7Dtr6T1xteCt6eRwhpmJ7JhME58Hyu1dvaswuTDd"} // Example: {"containerId":"5HZTn5qkRnmgSz9gSrw22CEdPPk6nQhkwf2Mgzyvkikv","objectId":"8N3o7Dtr6T1xteCt6eRwhpmJ7JhME58Hyu1dvaswuTDd"}
// //
// swagger:model Address // swagger:model Address

View file

@ -15,7 +15,7 @@ import (
"github.com/go-openapi/validate" "github.com/go-openapi/validate"
) )
// Eacl EACL NeoFS table. // Eacl EACL FrostFS table.
// Example: {"containerId":"5HZTn5qkRnmgSz9gSrw22CEdPPk6nQhkwf2Mgzyvkikv","records":[{"action":"GET","filters":[{"headerType":"OBJECT","key":"FileName","matchType":"STRING_EQUAL","value":"myfile"}],"operation":"ALLOW","targets":[{"role":"OTHERS"}]}]} // Example: {"containerId":"5HZTn5qkRnmgSz9gSrw22CEdPPk6nQhkwf2Mgzyvkikv","records":[{"action":"GET","filters":[{"headerType":"OBJECT","key":"FileName","matchType":"STRING_EQUAL","value":"myfile"}],"operation":"ALLOW","targets":[{"role":"OTHERS"}]}]}
// //
// swagger:model Eacl // swagger:model Eacl

View file

@ -14,7 +14,7 @@ import (
"github.com/go-openapi/validate" "github.com/go-openapi/validate"
) )
// Filter Filter in NeoFS EACL to check particular properties of the request or the object. // Filter Filter in FrostFS EACL to check particular properties of the request or the object.
// Example: {"headerType":"OBJECT","key":"FileName","matchType":"STRING_NOT_EQUAL","value":"myfile"} // Example: {"headerType":"OBJECT","key":"FileName","matchType":"STRING_NOT_EQUAL","value":"myfile"}
// //
// swagger:model Filter // swagger:model Filter

View file

@ -14,7 +14,7 @@ import (
"github.com/go-openapi/validate" "github.com/go-openapi/validate"
) )
// HeaderType Enumeration of possible sources of Headers to apply filters in NeoFS EACL. // HeaderType Enumeration of possible sources of Headers to apply filters in FrostFS EACL.
// //
// swagger:model HeaderType // swagger:model HeaderType
type HeaderType string type HeaderType string

View file

@ -14,7 +14,7 @@ import (
"github.com/go-openapi/validate" "github.com/go-openapi/validate"
) )
// MatchType Match type in NeoFS EACL filter. // MatchType Match type in FrostFS EACL filter.
// //
// swagger:model MatchType // swagger:model MatchType
type MatchType string type MatchType string

View file

@ -14,7 +14,7 @@ import (
"github.com/go-openapi/validate" "github.com/go-openapi/validate"
) )
// Operation Request's operation type to match in NeoFS EACL if the rule is applicable to a particular request. // Operation Request's operation type to match in FrostFS EACL if the rule is applicable to a particular request.
// //
// swagger:model Operation // swagger:model Operation
type Operation string type Operation string

View file

@ -15,7 +15,7 @@ import (
"github.com/go-openapi/validate" "github.com/go-openapi/validate"
) )
// Record A single NeoFS EACL rule. // Record A single FrostFS EACL rule.
// Example: {"action":"ALLOW","filters":[],"operation":"GET","targets":[{"keys":[],"role":"OTHERS"}]} // Example: {"action":"ALLOW","filters":[],"operation":"GET","targets":[{"keys":[],"role":"OTHERS"}]}
// //
// swagger:model Record // swagger:model Record

View file

@ -1,8 +1,8 @@
// Code generated by go-swagger; DO NOT EDIT. // Code generated by go-swagger; DO NOT EDIT.
// Package restapi REST API NeoFS // Package restapi REST API FrostFS
// //
// REST API for native integration with NeoFS. // REST API for native integration with FrostFS.
// Schemes: // Schemes:
// http // http
// Host: localhost:8090 // Host: localhost:8090

View file

@ -23,8 +23,8 @@ func init() {
], ],
"swagger": "2.0", "swagger": "2.0",
"info": { "info": {
"description": "REST API for native integration with NeoFS.", "description": "REST API for native integration with FrostFS.",
"title": "REST API NeoFS", "title": "REST API FrostFS",
"version": "v1" "version": "v1"
}, },
"host": "localhost:8090", "host": "localhost:8090",
@ -33,11 +33,11 @@ func init() {
"/accounting/balance/{address}": { "/accounting/balance/{address}": {
"get": { "get": {
"security": [], "security": [],
"description": "Getting balance of provided wallet address in NeoFS.", "description": "Getting balance of provided wallet address in FrostFS.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"summary": "Get balance in NeoFS", "summary": "Get balance in FrostFS",
"operationId": "getBalance", "operationId": "getBalance",
"parameters": [ "parameters": [
{ {
@ -50,7 +50,7 @@ func init() {
], ],
"responses": { "responses": {
"200": { "200": {
"description": "Balance of address in NeoFS", "description": "Balance of address in FrostFS",
"schema": { "schema": {
"$ref": "#/definitions/Balance" "$ref": "#/definitions/Balance"
}, },
@ -263,7 +263,7 @@ func init() {
} }
}, },
"put": { "put": {
"summary": "Create new container in NeoFS", "summary": "Create new container in FrostFS",
"operationId": "putContainer", "operationId": "putContainer",
"parameters": [ "parameters": [
{ {
@ -531,7 +531,7 @@ func init() {
"produces": [ "produces": [
"application/json" "application/json"
], ],
"summary": "Upload object to NeoFS", "summary": "Upload object to FrostFS",
"operationId": "putObject", "operationId": "putObject",
"parameters": [ "parameters": [
{ {
@ -755,7 +755,7 @@ func init() {
} }
}, },
"delete": { "delete": {
"summary": "Remove object from NeoFS", "summary": "Remove object from FrostFS",
"operationId": "deleteObject", "operationId": "deleteObject",
"parameters": [ "parameters": [
{ {
@ -823,7 +823,7 @@ func init() {
}, },
"definitions": { "definitions": {
"Action": { "Action": {
"description": "Rule execution result action in NeoFS EACL. Either allows or denies access if the rule's filters match.", "description": "Rule execution result action in FrostFS EACL. Either allows or denies access if the rule's filters match.",
"type": "string", "type": "string",
"enum": [ "enum": [
"ALLOW", "ALLOW",
@ -831,7 +831,7 @@ func init() {
] ]
}, },
"Address": { "Address": {
"description": "Address of the object in NeoFS.", "description": "Address of the object in FrostFS.",
"type": "object", "type": "object",
"required": [ "required": [
"containerId", "containerId",
@ -1097,7 +1097,7 @@ func init() {
} }
}, },
"Eacl": { "Eacl": {
"description": "EACL NeoFS table.", "description": "EACL FrostFS table.",
"type": "object", "type": "object",
"required": [ "required": [
"records" "records"
@ -1170,7 +1170,7 @@ func init() {
] ]
}, },
"Filter": { "Filter": {
"description": "Filter in NeoFS EACL to check particular properties of the request or the object.", "description": "Filter in FrostFS EACL to check particular properties of the request or the object.",
"type": "object", "type": "object",
"required": [ "required": [
"headerType", "headerType",
@ -1200,7 +1200,7 @@ func init() {
} }
}, },
"HeaderType": { "HeaderType": {
"description": "Enumeration of possible sources of Headers to apply filters in NeoFS EACL.", "description": "Enumeration of possible sources of Headers to apply filters in FrostFS EACL.",
"type": "string", "type": "string",
"enum": [ "enum": [
"REQUEST", "REQUEST",
@ -1209,7 +1209,7 @@ func init() {
] ]
}, },
"MatchType": { "MatchType": {
"description": "Match type in NeoFS EACL filter.", "description": "Match type in FrostFS EACL filter.",
"type": "string", "type": "string",
"enum": [ "enum": [
"STRING_EQUAL", "STRING_EQUAL",
@ -1373,7 +1373,7 @@ func init() {
} }
}, },
"Operation": { "Operation": {
"description": "Request's operation type to match in NeoFS EACL if the rule is applicable to a particular request.", "description": "Request's operation type to match in FrostFS EACL if the rule is applicable to a particular request.",
"type": "string", "type": "string",
"enum": [ "enum": [
"GET", "GET",
@ -1389,7 +1389,7 @@ func init() {
"type": "string" "type": "string"
}, },
"Record": { "Record": {
"description": "A single NeoFS EACL rule.", "description": "A single FrostFS EACL rule.",
"type": "object", "type": "object",
"required": [ "required": [
"action", "action",
@ -1646,14 +1646,14 @@ func init() {
"signatureScheme": { "signatureScheme": {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use wallet connect signature scheme or native NeoFS signature.", "description": "Use wallet connect signature scheme or native FrostFS signature.",
"name": "walletConnect", "name": "walletConnect",
"in": "query" "in": "query"
} }
}, },
"securityDefinitions": { "securityDefinitions": {
"BearerAuth": { "BearerAuth": {
"description": "Bearer token body to provide with NeoFS request. Must have 'Bearer ' prefix.", "description": "Bearer token body to provide with FrostFS request. Must have 'Bearer ' prefix.",
"type": "apiKey", "type": "apiKey",
"name": "Authorization", "name": "Authorization",
"in": "header" "in": "header"
@ -1671,8 +1671,8 @@ func init() {
], ],
"swagger": "2.0", "swagger": "2.0",
"info": { "info": {
"description": "REST API for native integration with NeoFS.", "description": "REST API for native integration with FrostFS.",
"title": "REST API NeoFS", "title": "REST API FrostFS",
"version": "v1" "version": "v1"
}, },
"host": "localhost:8090", "host": "localhost:8090",
@ -1681,11 +1681,11 @@ func init() {
"/accounting/balance/{address}": { "/accounting/balance/{address}": {
"get": { "get": {
"security": [], "security": [],
"description": "Getting balance of provided wallet address in NeoFS.", "description": "Getting balance of provided wallet address in FrostFS.",
"produces": [ "produces": [
"application/json" "application/json"
], ],
"summary": "Get balance in NeoFS", "summary": "Get balance in FrostFS",
"operationId": "getBalance", "operationId": "getBalance",
"parameters": [ "parameters": [
{ {
@ -1698,7 +1698,7 @@ func init() {
], ],
"responses": { "responses": {
"200": { "200": {
"description": "Balance of address in NeoFS", "description": "Balance of address in FrostFS",
"schema": { "schema": {
"$ref": "#/definitions/Balance" "$ref": "#/definitions/Balance"
}, },
@ -1827,7 +1827,7 @@ func init() {
{ {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use wallet connect signature scheme or native NeoFS signature.", "description": "Use wallet connect signature scheme or native FrostFS signature.",
"name": "walletConnect", "name": "walletConnect",
"in": "query" "in": "query"
} }
@ -1922,7 +1922,7 @@ func init() {
} }
}, },
"put": { "put": {
"summary": "Create new container in NeoFS", "summary": "Create new container in FrostFS",
"operationId": "putContainer", "operationId": "putContainer",
"parameters": [ "parameters": [
{ {
@ -1940,7 +1940,7 @@ func init() {
{ {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use wallet connect signature scheme or native NeoFS signature.", "description": "Use wallet connect signature scheme or native FrostFS signature.",
"name": "walletConnect", "name": "walletConnect",
"in": "query" "in": "query"
}, },
@ -2057,7 +2057,7 @@ func init() {
{ {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use wallet connect signature scheme or native NeoFS signature.", "description": "Use wallet connect signature scheme or native FrostFS signature.",
"name": "walletConnect", "name": "walletConnect",
"in": "query" "in": "query"
} }
@ -2156,7 +2156,7 @@ func init() {
{ {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use wallet connect signature scheme or native NeoFS signature.", "description": "Use wallet connect signature scheme or native FrostFS signature.",
"name": "walletConnect", "name": "walletConnect",
"in": "query" "in": "query"
}, },
@ -2228,7 +2228,7 @@ func init() {
"produces": [ "produces": [
"application/json" "application/json"
], ],
"summary": "Upload object to NeoFS", "summary": "Upload object to FrostFS",
"operationId": "putObject", "operationId": "putObject",
"parameters": [ "parameters": [
{ {
@ -2246,7 +2246,7 @@ func init() {
{ {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use wallet connect signature scheme or native NeoFS signature.", "description": "Use wallet connect signature scheme or native FrostFS signature.",
"name": "walletConnect", "name": "walletConnect",
"in": "query" "in": "query"
}, },
@ -2334,7 +2334,7 @@ func init() {
{ {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use wallet connect signature scheme or native NeoFS signature.", "description": "Use wallet connect signature scheme or native FrostFS signature.",
"name": "walletConnect", "name": "walletConnect",
"in": "query" "in": "query"
}, },
@ -2445,7 +2445,7 @@ func init() {
{ {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use wallet connect signature scheme or native NeoFS signature.", "description": "Use wallet connect signature scheme or native FrostFS signature.",
"name": "walletConnect", "name": "walletConnect",
"in": "query" "in": "query"
}, },
@ -2501,7 +2501,7 @@ func init() {
} }
}, },
"delete": { "delete": {
"summary": "Remove object from NeoFS", "summary": "Remove object from FrostFS",
"operationId": "deleteObject", "operationId": "deleteObject",
"parameters": [ "parameters": [
{ {
@ -2519,7 +2519,7 @@ func init() {
{ {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use wallet connect signature scheme or native NeoFS signature.", "description": "Use wallet connect signature scheme or native FrostFS signature.",
"name": "walletConnect", "name": "walletConnect",
"in": "query" "in": "query"
}, },
@ -2591,7 +2591,7 @@ func init() {
}, },
"definitions": { "definitions": {
"Action": { "Action": {
"description": "Rule execution result action in NeoFS EACL. Either allows or denies access if the rule's filters match.", "description": "Rule execution result action in FrostFS EACL. Either allows or denies access if the rule's filters match.",
"type": "string", "type": "string",
"enum": [ "enum": [
"ALLOW", "ALLOW",
@ -2599,7 +2599,7 @@ func init() {
] ]
}, },
"Address": { "Address": {
"description": "Address of the object in NeoFS.", "description": "Address of the object in FrostFS.",
"type": "object", "type": "object",
"required": [ "required": [
"containerId", "containerId",
@ -2865,7 +2865,7 @@ func init() {
} }
}, },
"Eacl": { "Eacl": {
"description": "EACL NeoFS table.", "description": "EACL FrostFS table.",
"type": "object", "type": "object",
"required": [ "required": [
"records" "records"
@ -2938,7 +2938,7 @@ func init() {
] ]
}, },
"Filter": { "Filter": {
"description": "Filter in NeoFS EACL to check particular properties of the request or the object.", "description": "Filter in FrostFS EACL to check particular properties of the request or the object.",
"type": "object", "type": "object",
"required": [ "required": [
"headerType", "headerType",
@ -2968,7 +2968,7 @@ func init() {
} }
}, },
"HeaderType": { "HeaderType": {
"description": "Enumeration of possible sources of Headers to apply filters in NeoFS EACL.", "description": "Enumeration of possible sources of Headers to apply filters in FrostFS EACL.",
"type": "string", "type": "string",
"enum": [ "enum": [
"REQUEST", "REQUEST",
@ -2977,7 +2977,7 @@ func init() {
] ]
}, },
"MatchType": { "MatchType": {
"description": "Match type in NeoFS EACL filter.", "description": "Match type in FrostFS EACL filter.",
"type": "string", "type": "string",
"enum": [ "enum": [
"STRING_EQUAL", "STRING_EQUAL",
@ -3141,7 +3141,7 @@ func init() {
} }
}, },
"Operation": { "Operation": {
"description": "Request's operation type to match in NeoFS EACL if the rule is applicable to a particular request.", "description": "Request's operation type to match in FrostFS EACL if the rule is applicable to a particular request.",
"type": "string", "type": "string",
"enum": [ "enum": [
"GET", "GET",
@ -3157,7 +3157,7 @@ func init() {
"type": "string" "type": "string"
}, },
"Record": { "Record": {
"description": "A single NeoFS EACL rule.", "description": "A single FrostFS EACL rule.",
"type": "object", "type": "object",
"required": [ "required": [
"action", "action",
@ -3414,14 +3414,14 @@ func init() {
"signatureScheme": { "signatureScheme": {
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Use wallet connect signature scheme or native NeoFS signature.", "description": "Use wallet connect signature scheme or native FrostFS signature.",
"name": "walletConnect", "name": "walletConnect",
"in": "query" "in": "query"
} }
}, },
"securityDefinitions": { "securityDefinitions": {
"BearerAuth": { "BearerAuth": {
"description": "Bearer token body to provide with NeoFS request. Must have 'Bearer ' prefix.", "description": "Bearer token body to provide with FrostFS request. Must have 'Bearer ' prefix.",
"type": "apiKey", "type": "apiKey",
"name": "Authorization", "name": "Authorization",
"in": "header" "in": "header"

View file

@ -29,10 +29,10 @@ func NewAuth(ctx *middleware.Context, handler AuthHandler) *Auth {
return &Auth{Context: ctx, Handler: handler} return &Auth{Context: ctx, Handler: handler}
} }
/* /* Auth swagger:route POST /auth auth
Auth swagger:route POST /auth auth
Form bearer token to further requests Form bearer token to further requests
*/ */
type Auth struct { type Auth struct {
Context *middleware.Context Context *middleware.Context

View file

@ -16,8 +16,7 @@ import (
// AuthOKCode is the HTTP code returned for type AuthOK // AuthOKCode is the HTTP code returned for type AuthOK
const AuthOKCode int = 200 const AuthOKCode int = 200
/* /*AuthOK Base64 encoded stable binary marshaled bearer token bodies.
AuthOK Base64 encoded stable binary marshaled bearer token bodies.
swagger:response authOK swagger:response authOK
*/ */
@ -86,8 +85,7 @@ func (o *AuthOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer
// AuthBadRequestCode is the HTTP code returned for type AuthBadRequest // AuthBadRequestCode is the HTTP code returned for type AuthBadRequest
const AuthBadRequestCode int = 400 const AuthBadRequestCode int = 400
/* /*AuthBadRequest Bad request
AuthBadRequest Bad request
swagger:response authBadRequest swagger:response authBadRequest
*/ */

View file

@ -31,10 +31,10 @@ func NewDeleteContainer(ctx *middleware.Context, handler DeleteContainerHandler)
return &DeleteContainer{Context: ctx, Handler: handler} return &DeleteContainer{Context: ctx, Handler: handler}
} }
/* /* DeleteContainer swagger:route DELETE /containers/{containerId} deleteContainer
DeleteContainer swagger:route DELETE /containers/{containerId} deleteContainer
Delete container by id Delete container by id
*/ */
type DeleteContainer struct { type DeleteContainer struct {
Context *middleware.Context Context *middleware.Context

View file

@ -52,7 +52,7 @@ type DeleteContainerParams struct {
In: path In: path
*/ */
ContainerID string ContainerID string
/*Use wallet connect signature scheme or native NeoFS signature. /*Use wallet connect signature scheme or native FrostFS signature.
In: query In: query
Default: false Default: false
*/ */

View file

@ -16,8 +16,7 @@ import (
// DeleteContainerOKCode is the HTTP code returned for type DeleteContainerOK // DeleteContainerOKCode is the HTTP code returned for type DeleteContainerOK
const DeleteContainerOKCode int = 200 const DeleteContainerOKCode int = 200
/* /*DeleteContainerOK Successful deletion.
DeleteContainerOK Successful deletion.
swagger:response deleteContainerOK swagger:response deleteContainerOK
*/ */
@ -83,8 +82,7 @@ func (o *DeleteContainerOK) WriteResponse(rw http.ResponseWriter, producer runti
// DeleteContainerBadRequestCode is the HTTP code returned for type DeleteContainerBadRequest // DeleteContainerBadRequestCode is the HTTP code returned for type DeleteContainerBadRequest
const DeleteContainerBadRequestCode int = 400 const DeleteContainerBadRequestCode int = 400
/* /*DeleteContainerBadRequest Bad request.
DeleteContainerBadRequest Bad request.
swagger:response deleteContainerBadRequest swagger:response deleteContainerBadRequest
*/ */

View file

@ -31,10 +31,10 @@ func NewDeleteObject(ctx *middleware.Context, handler DeleteObjectHandler) *Dele
return &DeleteObject{Context: ctx, Handler: handler} return &DeleteObject{Context: ctx, Handler: handler}
} }
/* /* DeleteObject swagger:route DELETE /objects/{containerId}/{objectId} deleteObject
DeleteObject swagger:route DELETE /objects/{containerId}/{objectId} deleteObject
Remove object from FrostFS
Remove object from NeoFS
*/ */
type DeleteObject struct { type DeleteObject struct {
Context *middleware.Context Context *middleware.Context

View file

@ -66,7 +66,7 @@ type DeleteObjectParams struct {
In: path In: path
*/ */
ObjectID string ObjectID string
/*Use wallet connect signature scheme or native NeoFS signature. /*Use wallet connect signature scheme or native FrostFS signature.
In: query In: query
Default: false Default: false
*/ */

View file

@ -16,8 +16,7 @@ import (
// DeleteObjectOKCode is the HTTP code returned for type DeleteObjectOK // DeleteObjectOKCode is the HTTP code returned for type DeleteObjectOK
const DeleteObjectOKCode int = 200 const DeleteObjectOKCode int = 200
/* /*DeleteObjectOK Successful deletion.
DeleteObjectOK Successful deletion.
swagger:response deleteObjectOK swagger:response deleteObjectOK
*/ */
@ -83,8 +82,7 @@ func (o *DeleteObjectOK) WriteResponse(rw http.ResponseWriter, producer runtime.
// DeleteObjectBadRequestCode is the HTTP code returned for type DeleteObjectBadRequest // DeleteObjectBadRequestCode is the HTTP code returned for type DeleteObjectBadRequest
const DeleteObjectBadRequestCode int = 400 const DeleteObjectBadRequestCode int = 400
/* /*DeleteObjectBadRequest Bad request.
DeleteObjectBadRequest Bad request.
swagger:response deleteObjectBadRequest swagger:response deleteObjectBadRequest
*/ */

View file

@ -31,10 +31,10 @@ func NewFormBinaryBearer(ctx *middleware.Context, handler FormBinaryBearerHandle
return &FormBinaryBearer{Context: ctx, Handler: handler} return &FormBinaryBearer{Context: ctx, Handler: handler}
} }
/* /* FormBinaryBearer swagger:route GET /auth/bearer formBinaryBearer
FormBinaryBearer swagger:route GET /auth/bearer formBinaryBearer
Form binary bearer token Form binary bearer token
*/ */
type FormBinaryBearer struct { type FormBinaryBearer struct {
Context *middleware.Context Context *middleware.Context

View file

@ -47,7 +47,7 @@ type FormBinaryBearerParams struct {
In: header In: header
*/ */
XBearerSignatureKey *string XBearerSignatureKey *string
/*Use wallet connect signature scheme or native NeoFS signature. /*Use wallet connect signature scheme or native FrostFS signature.
In: query In: query
Default: false Default: false
*/ */

View file

@ -16,8 +16,7 @@ import (
// FormBinaryBearerOKCode is the HTTP code returned for type FormBinaryBearerOK // FormBinaryBearerOKCode is the HTTP code returned for type FormBinaryBearerOK
const FormBinaryBearerOKCode int = 200 const FormBinaryBearerOKCode int = 200
/* /*FormBinaryBearerOK Base64 encoded stable binary marshaled bearer token.
FormBinaryBearerOK Base64 encoded stable binary marshaled bearer token.
swagger:response formBinaryBearerOK swagger:response formBinaryBearerOK
*/ */
@ -83,8 +82,7 @@ func (o *FormBinaryBearerOK) WriteResponse(rw http.ResponseWriter, producer runt
// FormBinaryBearerBadRequestCode is the HTTP code returned for type FormBinaryBearerBadRequest // FormBinaryBearerBadRequestCode is the HTTP code returned for type FormBinaryBearerBadRequest
const FormBinaryBearerBadRequestCode int = 400 const FormBinaryBearerBadRequestCode int = 400
/* /*FormBinaryBearerBadRequest Bad request
FormBinaryBearerBadRequest Bad request
swagger:response formBinaryBearerBadRequest swagger:response formBinaryBearerBadRequest
*/ */

View file

@ -117,7 +117,7 @@ func NewFrostfsRestGwAPI(spec *loads.Document) *FrostfsRestGwAPI {
} }
} }
/*FrostfsRestGwAPI REST API for native integration with NeoFS. */ /*FrostfsRestGwAPI REST API for native integration with FrostFS. */
type FrostfsRestGwAPI struct { type FrostfsRestGwAPI struct {
spec *loads.Document spec *loads.Document
context *middleware.Context context *middleware.Context

View file

@ -29,12 +29,12 @@ func NewGetBalance(ctx *middleware.Context, handler GetBalanceHandler) *GetBalan
return &GetBalance{Context: ctx, Handler: handler} return &GetBalance{Context: ctx, Handler: handler}
} }
/* /* GetBalance swagger:route GET /accounting/balance/{address} getBalance
GetBalance swagger:route GET /accounting/balance/{address} getBalance
# Get balance in NeoFS Get balance in FrostFS
Getting balance of provided wallet address in FrostFS.
Getting balance of provided wallet address in NeoFS.
*/ */
type GetBalance struct { type GetBalance struct {
Context *middleware.Context Context *middleware.Context

View file

@ -16,8 +16,7 @@ import (
// GetBalanceOKCode is the HTTP code returned for type GetBalanceOK // GetBalanceOKCode is the HTTP code returned for type GetBalanceOK
const GetBalanceOKCode int = 200 const GetBalanceOKCode int = 200
/* /*GetBalanceOK Balance of address in FrostFS
GetBalanceOK Balance of address in NeoFS
swagger:response getBalanceOK swagger:response getBalanceOK
*/ */
@ -83,8 +82,7 @@ func (o *GetBalanceOK) WriteResponse(rw http.ResponseWriter, producer runtime.Pr
// GetBalanceBadRequestCode is the HTTP code returned for type GetBalanceBadRequest // GetBalanceBadRequestCode is the HTTP code returned for type GetBalanceBadRequest
const GetBalanceBadRequestCode int = 400 const GetBalanceBadRequestCode int = 400
/* /*GetBalanceBadRequest Bad request
GetBalanceBadRequest Bad request
swagger:response getBalanceBadRequest swagger:response getBalanceBadRequest
*/ */

View file

@ -29,10 +29,10 @@ func NewGetContainer(ctx *middleware.Context, handler GetContainerHandler) *GetC
return &GetContainer{Context: ctx, Handler: handler} return &GetContainer{Context: ctx, Handler: handler}
} }
/* /* GetContainer swagger:route GET /containers/{containerId} getContainer
GetContainer swagger:route GET /containers/{containerId} getContainer
Get container by id Get container by id
*/ */
type GetContainer struct { type GetContainer struct {
Context *middleware.Context Context *middleware.Context

View file

@ -29,10 +29,10 @@ func NewGetContainerEACL(ctx *middleware.Context, handler GetContainerEACLHandle
return &GetContainerEACL{Context: ctx, Handler: handler} return &GetContainerEACL{Context: ctx, Handler: handler}
} }
/* /* GetContainerEACL swagger:route GET /containers/{containerId}/eacl getContainerEAcl
GetContainerEACL swagger:route GET /containers/{containerId}/eacl getContainerEAcl
Get container EACL by id Get container EACL by id
*/ */
type GetContainerEACL struct { type GetContainerEACL struct {
Context *middleware.Context Context *middleware.Context

View file

@ -16,8 +16,7 @@ import (
// GetContainerEACLOKCode is the HTTP code returned for type GetContainerEACLOK // GetContainerEACLOKCode is the HTTP code returned for type GetContainerEACLOK
const GetContainerEACLOKCode int = 200 const GetContainerEACLOKCode int = 200
/* /*GetContainerEACLOK Container EACL information.
GetContainerEACLOK Container EACL information.
swagger:response getContainerEAclOK swagger:response getContainerEAclOK
*/ */
@ -83,8 +82,7 @@ func (o *GetContainerEACLOK) WriteResponse(rw http.ResponseWriter, producer runt
// GetContainerEACLBadRequestCode is the HTTP code returned for type GetContainerEACLBadRequest // GetContainerEACLBadRequestCode is the HTTP code returned for type GetContainerEACLBadRequest
const GetContainerEACLBadRequestCode int = 400 const GetContainerEACLBadRequestCode int = 400
/* /*GetContainerEACLBadRequest Bad request.
GetContainerEACLBadRequest Bad request.
swagger:response getContainerEAclBadRequest swagger:response getContainerEAclBadRequest
*/ */

View file

@ -16,8 +16,7 @@ import (
// GetContainerOKCode is the HTTP code returned for type GetContainerOK // GetContainerOKCode is the HTTP code returned for type GetContainerOK
const GetContainerOKCode int = 200 const GetContainerOKCode int = 200
/* /*GetContainerOK Container info.
GetContainerOK Container info.
swagger:response getContainerOK swagger:response getContainerOK
*/ */
@ -83,8 +82,7 @@ func (o *GetContainerOK) WriteResponse(rw http.ResponseWriter, producer runtime.
// GetContainerBadRequestCode is the HTTP code returned for type GetContainerBadRequest // GetContainerBadRequestCode is the HTTP code returned for type GetContainerBadRequest
const GetContainerBadRequestCode int = 400 const GetContainerBadRequestCode int = 400
/* /*GetContainerBadRequest Bad request.
GetContainerBadRequest Bad request.
swagger:response getContainerBadRequest swagger:response getContainerBadRequest
*/ */

View file

@ -31,10 +31,10 @@ func NewGetObjectInfo(ctx *middleware.Context, handler GetObjectInfoHandler) *Ge
return &GetObjectInfo{Context: ctx, Handler: handler} return &GetObjectInfo{Context: ctx, Handler: handler}
} }
/* /* GetObjectInfo swagger:route GET /objects/{containerId}/{objectId} getObjectInfo
GetObjectInfo swagger:route GET /objects/{containerId}/{objectId} getObjectInfo
Get object info by address Get object info by address
*/ */
type GetObjectInfo struct { type GetObjectInfo struct {
Context *middleware.Context Context *middleware.Context

View file

@ -89,7 +89,7 @@ type GetObjectInfoParams struct {
In: query In: query
*/ */
RangeOffset *int64 RangeOffset *int64
/*Use wallet connect signature scheme or native NeoFS signature. /*Use wallet connect signature scheme or native FrostFS signature.
In: query In: query
Default: false Default: false
*/ */

View file

@ -16,8 +16,7 @@ import (
// GetObjectInfoOKCode is the HTTP code returned for type GetObjectInfoOK // GetObjectInfoOKCode is the HTTP code returned for type GetObjectInfoOK
const GetObjectInfoOKCode int = 200 const GetObjectInfoOKCode int = 200
/* /*GetObjectInfoOK Object info
GetObjectInfoOK Object info
swagger:response getObjectInfoOK swagger:response getObjectInfoOK
*/ */
@ -83,8 +82,7 @@ func (o *GetObjectInfoOK) WriteResponse(rw http.ResponseWriter, producer runtime
// GetObjectInfoBadRequestCode is the HTTP code returned for type GetObjectInfoBadRequest // GetObjectInfoBadRequestCode is the HTTP code returned for type GetObjectInfoBadRequest
const GetObjectInfoBadRequestCode int = 400 const GetObjectInfoBadRequestCode int = 400
/* /*GetObjectInfoBadRequest Bad request
GetObjectInfoBadRequest Bad request
swagger:response getObjectInfoBadRequest swagger:response getObjectInfoBadRequest
*/ */

View file

@ -29,10 +29,10 @@ func NewListContainers(ctx *middleware.Context, handler ListContainersHandler) *
return &ListContainers{Context: ctx, Handler: handler} return &ListContainers{Context: ctx, Handler: handler}
} }
/* /* ListContainers swagger:route GET /containers listContainers
ListContainers swagger:route GET /containers listContainers
Get list of containers Get list of containers
*/ */
type ListContainers struct { type ListContainers struct {
Context *middleware.Context Context *middleware.Context

View file

@ -16,8 +16,7 @@ import (
// ListContainersOKCode is the HTTP code returned for type ListContainersOK // ListContainersOKCode is the HTTP code returned for type ListContainersOK
const ListContainersOKCode int = 200 const ListContainersOKCode int = 200
/* /*ListContainersOK Containers info.
ListContainersOK Containers info.
swagger:response listContainersOK swagger:response listContainersOK
*/ */
@ -83,8 +82,7 @@ func (o *ListContainersOK) WriteResponse(rw http.ResponseWriter, producer runtim
// ListContainersBadRequestCode is the HTTP code returned for type ListContainersBadRequest // ListContainersBadRequestCode is the HTTP code returned for type ListContainersBadRequest
const ListContainersBadRequestCode int = 400 const ListContainersBadRequestCode int = 400
/* /*ListContainersBadRequest Bad request.
ListContainersBadRequest Bad request.
swagger:response listContainersBadRequest swagger:response listContainersBadRequest
*/ */

View file

@ -29,10 +29,10 @@ func NewOptionsAuth(ctx *middleware.Context, handler OptionsAuthHandler) *Option
return &OptionsAuth{Context: ctx, Handler: handler} return &OptionsAuth{Context: ctx, Handler: handler}
} }
/* /* OptionsAuth swagger:route OPTIONS /auth optionsAuth
OptionsAuth swagger:route OPTIONS /auth optionsAuth
OptionsAuth options auth API OptionsAuth options auth API
*/ */
type OptionsAuth struct { type OptionsAuth struct {
Context *middleware.Context Context *middleware.Context

View file

@ -29,10 +29,10 @@ func NewOptionsAuthBearer(ctx *middleware.Context, handler OptionsAuthBearerHand
return &OptionsAuthBearer{Context: ctx, Handler: handler} return &OptionsAuthBearer{Context: ctx, Handler: handler}
} }
/* /* OptionsAuthBearer swagger:route OPTIONS /auth/bearer optionsAuthBearer
OptionsAuthBearer swagger:route OPTIONS /auth/bearer optionsAuthBearer
OptionsAuthBearer options auth bearer API OptionsAuthBearer options auth bearer API
*/ */
type OptionsAuthBearer struct { type OptionsAuthBearer struct {
Context *middleware.Context Context *middleware.Context

View file

@ -14,8 +14,7 @@ import (
// OptionsAuthBearerOKCode is the HTTP code returned for type OptionsAuthBearerOK // OptionsAuthBearerOKCode is the HTTP code returned for type OptionsAuthBearerOK
const OptionsAuthBearerOKCode int = 200 const OptionsAuthBearerOKCode int = 200
/* /*OptionsAuthBearerOK CORS
OptionsAuthBearerOK CORS
swagger:response optionsAuthBearerOK swagger:response optionsAuthBearerOK
*/ */

View file

@ -14,8 +14,7 @@ import (
// OptionsAuthOKCode is the HTTP code returned for type OptionsAuthOK // OptionsAuthOKCode is the HTTP code returned for type OptionsAuthOK
const OptionsAuthOKCode int = 200 const OptionsAuthOKCode int = 200
/* /*OptionsAuthOK CORS
OptionsAuthOK CORS
swagger:response optionsAuthOK swagger:response optionsAuthOK
*/ */

View file

@ -29,10 +29,10 @@ func NewOptionsContainersEACL(ctx *middleware.Context, handler OptionsContainers
return &OptionsContainersEACL{Context: ctx, Handler: handler} return &OptionsContainersEACL{Context: ctx, Handler: handler}
} }
/* /* OptionsContainersEACL swagger:route OPTIONS /containers/{containerId}/eacl optionsContainersEAcl
OptionsContainersEACL swagger:route OPTIONS /containers/{containerId}/eacl optionsContainersEAcl
OptionsContainersEACL options containers e ACL API OptionsContainersEACL options containers e ACL API
*/ */
type OptionsContainersEACL struct { type OptionsContainersEACL struct {
Context *middleware.Context Context *middleware.Context

View file

@ -14,8 +14,7 @@ import (
// OptionsContainersEACLOKCode is the HTTP code returned for type OptionsContainersEACLOK // OptionsContainersEACLOKCode is the HTTP code returned for type OptionsContainersEACLOK
const OptionsContainersEACLOKCode int = 200 const OptionsContainersEACLOKCode int = 200
/* /*OptionsContainersEACLOK CORS
OptionsContainersEACLOK CORS
swagger:response optionsContainersEAclOK swagger:response optionsContainersEAclOK
*/ */

View file

@ -29,10 +29,10 @@ func NewOptionsContainersGetDelete(ctx *middleware.Context, handler OptionsConta
return &OptionsContainersGetDelete{Context: ctx, Handler: handler} return &OptionsContainersGetDelete{Context: ctx, Handler: handler}
} }
/* /* OptionsContainersGetDelete swagger:route OPTIONS /containers/{containerId} optionsContainersGetDelete
OptionsContainersGetDelete swagger:route OPTIONS /containers/{containerId} optionsContainersGetDelete
OptionsContainersGetDelete options containers get delete API OptionsContainersGetDelete options containers get delete API
*/ */
type OptionsContainersGetDelete struct { type OptionsContainersGetDelete struct {
Context *middleware.Context Context *middleware.Context

View file

@ -14,8 +14,7 @@ import (
// OptionsContainersGetDeleteOKCode is the HTTP code returned for type OptionsContainersGetDeleteOK // OptionsContainersGetDeleteOKCode is the HTTP code returned for type OptionsContainersGetDeleteOK
const OptionsContainersGetDeleteOKCode int = 200 const OptionsContainersGetDeleteOKCode int = 200
/* /*OptionsContainersGetDeleteOK CORS
OptionsContainersGetDeleteOK CORS
swagger:response optionsContainersGetDeleteOK swagger:response optionsContainersGetDeleteOK
*/ */

View file

@ -29,10 +29,10 @@ func NewOptionsContainersPutList(ctx *middleware.Context, handler OptionsContain
return &OptionsContainersPutList{Context: ctx, Handler: handler} return &OptionsContainersPutList{Context: ctx, Handler: handler}
} }
/* /* OptionsContainersPutList swagger:route OPTIONS /containers optionsContainersPutList
OptionsContainersPutList swagger:route OPTIONS /containers optionsContainersPutList
OptionsContainersPutList options containers put list API OptionsContainersPutList options containers put list API
*/ */
type OptionsContainersPutList struct { type OptionsContainersPutList struct {
Context *middleware.Context Context *middleware.Context

View file

@ -14,8 +14,7 @@ import (
// OptionsContainersPutListOKCode is the HTTP code returned for type OptionsContainersPutListOK // OptionsContainersPutListOKCode is the HTTP code returned for type OptionsContainersPutListOK
const OptionsContainersPutListOKCode int = 200 const OptionsContainersPutListOKCode int = 200
/* /*OptionsContainersPutListOK CORS
OptionsContainersPutListOK CORS
swagger:response optionsContainersPutListOK swagger:response optionsContainersPutListOK
*/ */

View file

@ -29,10 +29,10 @@ func NewOptionsObjectsGetDelete(ctx *middleware.Context, handler OptionsObjectsG
return &OptionsObjectsGetDelete{Context: ctx, Handler: handler} return &OptionsObjectsGetDelete{Context: ctx, Handler: handler}
} }
/* /* OptionsObjectsGetDelete swagger:route OPTIONS /objects/{containerId}/{objectId} optionsObjectsGetDelete
OptionsObjectsGetDelete swagger:route OPTIONS /objects/{containerId}/{objectId} optionsObjectsGetDelete
OptionsObjectsGetDelete options objects get delete API OptionsObjectsGetDelete options objects get delete API
*/ */
type OptionsObjectsGetDelete struct { type OptionsObjectsGetDelete struct {
Context *middleware.Context Context *middleware.Context

View file

@ -14,8 +14,7 @@ import (
// OptionsObjectsGetDeleteOKCode is the HTTP code returned for type OptionsObjectsGetDeleteOK // OptionsObjectsGetDeleteOKCode is the HTTP code returned for type OptionsObjectsGetDeleteOK
const OptionsObjectsGetDeleteOKCode int = 200 const OptionsObjectsGetDeleteOKCode int = 200
/* /*OptionsObjectsGetDeleteOK CORS
OptionsObjectsGetDeleteOK CORS
swagger:response optionsObjectsGetDeleteOK swagger:response optionsObjectsGetDeleteOK
*/ */

View file

@ -29,10 +29,10 @@ func NewOptionsObjectsPut(ctx *middleware.Context, handler OptionsObjectsPutHand
return &OptionsObjectsPut{Context: ctx, Handler: handler} return &OptionsObjectsPut{Context: ctx, Handler: handler}
} }
/* /* OptionsObjectsPut swagger:route OPTIONS /objects optionsObjectsPut
OptionsObjectsPut swagger:route OPTIONS /objects optionsObjectsPut
OptionsObjectsPut options objects put API OptionsObjectsPut options objects put API
*/ */
type OptionsObjectsPut struct { type OptionsObjectsPut struct {
Context *middleware.Context Context *middleware.Context

View file

@ -14,8 +14,7 @@ import (
// OptionsObjectsPutOKCode is the HTTP code returned for type OptionsObjectsPutOK // OptionsObjectsPutOKCode is the HTTP code returned for type OptionsObjectsPutOK
const OptionsObjectsPutOKCode int = 200 const OptionsObjectsPutOKCode int = 200
/* /*OptionsObjectsPutOK CORS
OptionsObjectsPutOK CORS
swagger:response optionsObjectsPutOK swagger:response optionsObjectsPutOK
*/ */

View file

@ -29,10 +29,10 @@ func NewOptionsObjectsSearch(ctx *middleware.Context, handler OptionsObjectsSear
return &OptionsObjectsSearch{Context: ctx, Handler: handler} return &OptionsObjectsSearch{Context: ctx, Handler: handler}
} }
/* /* OptionsObjectsSearch swagger:route OPTIONS /objects/{containerId}/search optionsObjectsSearch
OptionsObjectsSearch swagger:route OPTIONS /objects/{containerId}/search optionsObjectsSearch
OptionsObjectsSearch options objects search API OptionsObjectsSearch options objects search API
*/ */
type OptionsObjectsSearch struct { type OptionsObjectsSearch struct {
Context *middleware.Context Context *middleware.Context

View file

@ -14,8 +14,7 @@ import (
// OptionsObjectsSearchOKCode is the HTTP code returned for type OptionsObjectsSearchOK // OptionsObjectsSearchOKCode is the HTTP code returned for type OptionsObjectsSearchOK
const OptionsObjectsSearchOKCode int = 200 const OptionsObjectsSearchOKCode int = 200
/* /*OptionsObjectsSearchOK Base64 encoded stable binary marshaled bearer token.
OptionsObjectsSearchOK Base64 encoded stable binary marshaled bearer token.
swagger:response optionsObjectsSearchOK swagger:response optionsObjectsSearchOK
*/ */

View file

@ -36,10 +36,10 @@ func NewPutContainer(ctx *middleware.Context, handler PutContainerHandler) *PutC
return &PutContainer{Context: ctx, Handler: handler} return &PutContainer{Context: ctx, Handler: handler}
} }
/* /* PutContainer swagger:route PUT /containers putContainer
PutContainer swagger:route PUT /containers putContainer
Create new container in FrostFS
Create new container in NeoFS
*/ */
type PutContainer struct { type PutContainer struct {
Context *middleware.Context Context *middleware.Context

View file

@ -31,10 +31,10 @@ func NewPutContainerEACL(ctx *middleware.Context, handler PutContainerEACLHandle
return &PutContainerEACL{Context: ctx, Handler: handler} return &PutContainerEACL{Context: ctx, Handler: handler}
} }
/* /* PutContainerEACL swagger:route PUT /containers/{containerId}/eacl putContainerEAcl
PutContainerEACL swagger:route PUT /containers/{containerId}/eacl putContainerEAcl
Set container EACL by id Set container EACL by id
*/ */
type PutContainerEACL struct { type PutContainerEACL struct {
Context *middleware.Context Context *middleware.Context

View file

@ -62,7 +62,7 @@ type PutContainerEACLParams struct {
In: body In: body
*/ */
Eacl *models.Eacl Eacl *models.Eacl
/*Use wallet connect signature scheme or native NeoFS signature. /*Use wallet connect signature scheme or native FrostFS signature.
In: query In: query
Default: false Default: false
*/ */

View file

@ -16,8 +16,7 @@ import (
// PutContainerEACLOKCode is the HTTP code returned for type PutContainerEACLOK // PutContainerEACLOKCode is the HTTP code returned for type PutContainerEACLOK
const PutContainerEACLOKCode int = 200 const PutContainerEACLOKCode int = 200
/* /*PutContainerEACLOK Successful EACL updating.
PutContainerEACLOK Successful EACL updating.
swagger:response putContainerEAclOK swagger:response putContainerEAclOK
*/ */
@ -83,8 +82,7 @@ func (o *PutContainerEACLOK) WriteResponse(rw http.ResponseWriter, producer runt
// PutContainerEACLBadRequestCode is the HTTP code returned for type PutContainerEACLBadRequest // PutContainerEACLBadRequestCode is the HTTP code returned for type PutContainerEACLBadRequest
const PutContainerEACLBadRequestCode int = 400 const PutContainerEACLBadRequestCode int = 400
/* /*PutContainerEACLBadRequest Bad request.
PutContainerEACLBadRequest Bad request.
swagger:response putContainerEAclBadRequest swagger:response putContainerEAclBadRequest
*/ */

View file

@ -65,7 +65,7 @@ type PutContainerParams struct {
Default: false Default: false
*/ */
NameScopeGlobal *bool NameScopeGlobal *bool
/*Use wallet connect signature scheme or native NeoFS signature. /*Use wallet connect signature scheme or native FrostFS signature.
In: query In: query
Default: false Default: false
*/ */

View file

@ -16,8 +16,7 @@ import (
// PutContainerOKCode is the HTTP code returned for type PutContainerOK // PutContainerOKCode is the HTTP code returned for type PutContainerOK
const PutContainerOKCode int = 200 const PutContainerOKCode int = 200
/* /*PutContainerOK Identifier of the created container.
PutContainerOK Identifier of the created container.
swagger:response putContainerOK swagger:response putContainerOK
*/ */
@ -83,8 +82,7 @@ func (o *PutContainerOK) WriteResponse(rw http.ResponseWriter, producer runtime.
// PutContainerBadRequestCode is the HTTP code returned for type PutContainerBadRequest // PutContainerBadRequestCode is the HTTP code returned for type PutContainerBadRequest
const PutContainerBadRequestCode int = 400 const PutContainerBadRequestCode int = 400
/* /*PutContainerBadRequest Bad request.
PutContainerBadRequest Bad request.
swagger:response putContainerBadRequest swagger:response putContainerBadRequest
*/ */

View file

@ -31,10 +31,10 @@ func NewPutObject(ctx *middleware.Context, handler PutObjectHandler) *PutObject
return &PutObject{Context: ctx, Handler: handler} return &PutObject{Context: ctx, Handler: handler}
} }
/* /* PutObject swagger:route PUT /objects putObject
PutObject swagger:route PUT /objects putObject
Upload object to FrostFS
Upload object to NeoFS
*/ */
type PutObject struct { type PutObject struct {
Context *middleware.Context Context *middleware.Context

View file

@ -66,7 +66,7 @@ type PutObjectParams struct {
In: body In: body
*/ */
Object *models.ObjectUpload Object *models.ObjectUpload
/*Use wallet connect signature scheme or native NeoFS signature. /*Use wallet connect signature scheme or native FrostFS signature.
In: query In: query
Default: false Default: false
*/ */

View file

@ -16,8 +16,7 @@ import (
// PutObjectOKCode is the HTTP code returned for type PutObjectOK // PutObjectOKCode is the HTTP code returned for type PutObjectOK
const PutObjectOKCode int = 200 const PutObjectOKCode int = 200
/* /*PutObjectOK Address of uploaded objects
PutObjectOK Address of uploaded objects
swagger:response putObjectOK swagger:response putObjectOK
*/ */
@ -83,8 +82,7 @@ func (o *PutObjectOK) WriteResponse(rw http.ResponseWriter, producer runtime.Pro
// PutObjectBadRequestCode is the HTTP code returned for type PutObjectBadRequest // PutObjectBadRequestCode is the HTTP code returned for type PutObjectBadRequest
const PutObjectBadRequestCode int = 400 const PutObjectBadRequestCode int = 400
/* /*PutObjectBadRequest Bad request
PutObjectBadRequest Bad request
swagger:response putObjectBadRequest swagger:response putObjectBadRequest
*/ */

View file

@ -31,10 +31,10 @@ func NewSearchObjects(ctx *middleware.Context, handler SearchObjectsHandler) *Se
return &SearchObjects{Context: ctx, Handler: handler} return &SearchObjects{Context: ctx, Handler: handler}
} }
/* /* SearchObjects swagger:route POST /objects/{containerId}/search searchObjects
SearchObjects swagger:route POST /objects/{containerId}/search searchObjects
Search objects by filters Search objects by filters
*/ */
type SearchObjects struct { type SearchObjects struct {
Context *middleware.Context Context *middleware.Context

View file

@ -90,7 +90,7 @@ type SearchObjectsParams struct {
In: body In: body
*/ */
SearchFilters *models.SearchFilters SearchFilters *models.SearchFilters
/*Use wallet connect signature scheme or native NeoFS signature. /*Use wallet connect signature scheme or native FrostFS signature.
In: query In: query
Default: false Default: false
*/ */

View file

@ -16,8 +16,7 @@ import (
// SearchObjectsOKCode is the HTTP code returned for type SearchObjectsOK // SearchObjectsOKCode is the HTTP code returned for type SearchObjectsOK
const SearchObjectsOKCode int = 200 const SearchObjectsOKCode int = 200
/* /*SearchObjectsOK List of objects
SearchObjectsOK List of objects
swagger:response searchObjectsOK swagger:response searchObjectsOK
*/ */
@ -83,8 +82,7 @@ func (o *SearchObjectsOK) WriteResponse(rw http.ResponseWriter, producer runtime
// SearchObjectsBadRequestCode is the HTTP code returned for type SearchObjectsBadRequest // SearchObjectsBadRequestCode is the HTTP code returned for type SearchObjectsBadRequest
const SearchObjectsBadRequestCode int = 400 const SearchObjectsBadRequestCode int = 400
/* /*SearchObjectsBadRequest Bad request
SearchObjectsBadRequest Bad request
swagger:response searchObjectsBadRequest swagger:response searchObjectsBadRequest
*/ */

View file

@ -1,7 +1,7 @@
swagger: "2.0" swagger: "2.0"
info: info:
title: REST API NeoFS title: REST API FrostFS
description: REST API for native integration with NeoFS. description: REST API for native integration with FrostFS.
version: v1 version: v1
host: localhost:8090 host: localhost:8090
@ -14,7 +14,7 @@ securityDefinitions:
type: apiKey type: apiKey
in: header in: header
name: Authorization name: Authorization
description: Bearer token body to provide with NeoFS request. Must have 'Bearer ' prefix. description: Bearer token body to provide with FrostFS request. Must have 'Bearer ' prefix.
security: security:
- BearerAuth: [ ] - BearerAuth: [ ]
@ -35,7 +35,7 @@ parameters:
signatureScheme: signatureScheme:
in: query in: query
name: walletConnect name: walletConnect
description: Use wallet connect signature scheme or native NeoFS signature. description: Use wallet connect signature scheme or native FrostFS signature.
type: boolean type: boolean
default: false default: false
fullBearerToken: fullBearerToken:
@ -154,8 +154,8 @@ paths:
/accounting/balance/{address}: /accounting/balance/{address}:
get: get:
operationId: getBalance operationId: getBalance
summary: Get balance in NeoFS summary: Get balance in FrostFS
description: Getting balance of provided wallet address in NeoFS. description: Getting balance of provided wallet address in FrostFS.
security: [ ] security: [ ]
parameters: parameters:
- in: path - in: path
@ -167,7 +167,7 @@ paths:
- application/json - application/json
responses: responses:
200: 200:
description: Balance of address in NeoFS description: Balance of address in FrostFS
schema: schema:
$ref: '#/definitions/Balance' $ref: '#/definitions/Balance'
headers: headers:
@ -194,7 +194,7 @@ paths:
type: string type: string
put: put:
operationId: putObject operationId: putObject
summary: Upload object to NeoFS summary: Upload object to FrostFS
parameters: parameters:
- $ref: '#/parameters/signatureParam' - $ref: '#/parameters/signatureParam'
- $ref: '#/parameters/signatureKeyParam' - $ref: '#/parameters/signatureKeyParam'
@ -341,7 +341,7 @@ paths:
$ref: '#/definitions/ErrorResponse' $ref: '#/definitions/ErrorResponse'
delete: delete:
operationId: deleteObject operationId: deleteObject
summary: Remove object from NeoFS summary: Remove object from FrostFS
parameters: parameters:
- $ref: '#/parameters/signatureParam' - $ref: '#/parameters/signatureParam'
- $ref: '#/parameters/signatureKeyParam' - $ref: '#/parameters/signatureKeyParam'
@ -376,7 +376,7 @@ paths:
type: string type: string
put: put:
operationId: putContainer operationId: putContainer
summary: Create new container in NeoFS summary: Create new container in FrostFS
parameters: parameters:
- $ref: '#/parameters/signatureParam' - $ref: '#/parameters/signatureParam'
- $ref: '#/parameters/signatureKeyParam' - $ref: '#/parameters/signatureKeyParam'
@ -594,7 +594,7 @@ definitions:
container: container:
verb: PUT verb: PUT
Record: Record:
description: A single NeoFS EACL rule. description: A single FrostFS EACL rule.
type: object type: object
properties: properties:
action: action:
@ -622,13 +622,13 @@ definitions:
- role: OTHERS - role: OTHERS
keys: [ ] keys: [ ]
Action: Action:
description: Rule execution result action in NeoFS EACL. Either allows or denies access if the rule's filters match. description: Rule execution result action in FrostFS EACL. Either allows or denies access if the rule's filters match.
type: string type: string
enum: enum:
- ALLOW - ALLOW
- DENY - DENY
Operation: Operation:
description: Request's operation type to match in NeoFS EACL if the rule is applicable to a particular request. description: Request's operation type to match in FrostFS EACL if the rule is applicable to a particular request.
type: string type: string
enum: enum:
- GET - GET
@ -639,7 +639,7 @@ definitions:
- RANGE - RANGE
- RANGEHASH - RANGEHASH
Filter: Filter:
description: Filter in NeoFS EACL to check particular properties of the request or the object. description: Filter in FrostFS EACL to check particular properties of the request or the object.
type: object type: object
properties: properties:
headerType: headerType:
@ -661,14 +661,14 @@ definitions:
key: FileName key: FileName
value: myfile value: myfile
HeaderType: HeaderType:
description: Enumeration of possible sources of Headers to apply filters in NeoFS EACL. description: Enumeration of possible sources of Headers to apply filters in FrostFS EACL.
type: string type: string
enum: enum:
- REQUEST - REQUEST
- OBJECT - OBJECT
- SERVICE - SERVICE
MatchType: MatchType:
description: Match type in NeoFS EACL filter. description: Match type in FrostFS EACL filter.
type: string type: string
enum: enum:
- STRING_EQUAL - STRING_EQUAL
@ -992,7 +992,7 @@ definitions:
- key: Name - key: Name
value: object value: object
Address: Address:
description: Address of the object in NeoFS. description: Address of the object in FrostFS.
type: object type: object
properties: properties:
containerId: containerId:
@ -1006,7 +1006,7 @@ definitions:
objectId: 8N3o7Dtr6T1xteCt6eRwhpmJ7JhME58Hyu1dvaswuTDd objectId: 8N3o7Dtr6T1xteCt6eRwhpmJ7JhME58Hyu1dvaswuTDd
containerId: 5HZTn5qkRnmgSz9gSrw22CEdPPk6nQhkwf2Mgzyvkikv containerId: 5HZTn5qkRnmgSz9gSrw22CEdPPk6nQhkwf2Mgzyvkikv
Eacl: Eacl:
description: EACL NeoFS table. description: EACL FrostFS table.
type: object type: object
properties: properties:
containerId: containerId: