forked from TrueCloudLab/frostfs-api
Re-generate docs for release
Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
parent
81d6c73147
commit
52992d7150
2 changed files with 32 additions and 0 deletions
|
@ -294,6 +294,7 @@ container creation.
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| eacl | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) | | Extended ACL requested, if available |
|
| eacl | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) | | Extended ACL requested, if available |
|
||||||
| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Signature of stable-marshalled Extended ACL according to RFC-6979 |
|
| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Signature of stable-marshalled Extended ACL according to RFC-6979 |
|
||||||
|
| session_token | [neo.fs.v2.session.SessionToken](#neo.fs.v2.session.SessionToken) | | Session token if Extended ACL was set within a session |
|
||||||
|
|
||||||
|
|
||||||
<a name="neo.fs.v2.container.GetRequest"></a>
|
<a name="neo.fs.v2.container.GetRequest"></a>
|
||||||
|
@ -343,6 +344,8 @@ was already verified on container creation.
|
||||||
| Field | Type | Label | Description |
|
| Field | Type | Label | Description |
|
||||||
| ----- | ---- | ----- | ----------- |
|
| ----- | ---- | ----- | ----------- |
|
||||||
| container | [Container](#neo.fs.v2.container.Container) | | Requested container structure |
|
| container | [Container](#neo.fs.v2.container.Container) | | Requested container structure |
|
||||||
|
| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Signature of a stable-marshalled container according to RFC-6979 |
|
||||||
|
| session_token | [neo.fs.v2.session.SessionToken](#neo.fs.v2.session.SessionToken) | | Session token if the container was created within a session |
|
||||||
|
|
||||||
|
|
||||||
<a name="neo.fs.v2.container.ListRequest"></a>
|
<a name="neo.fs.v2.container.ListRequest"></a>
|
||||||
|
|
|
@ -17,6 +17,7 @@
|
||||||
- [session/types.proto](#session/types.proto)
|
- [session/types.proto](#session/types.proto)
|
||||||
|
|
||||||
- Messages
|
- Messages
|
||||||
|
- [ContainerSessionContext](#neo.fs.v2.session.ContainerSessionContext)
|
||||||
- [ObjectSessionContext](#neo.fs.v2.session.ObjectSessionContext)
|
- [ObjectSessionContext](#neo.fs.v2.session.ObjectSessionContext)
|
||||||
- [RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader)
|
- [RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader)
|
||||||
- [RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader)
|
- [RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader)
|
||||||
|
@ -127,6 +128,19 @@ Session creation response body
|
||||||
<!-- end services -->
|
<!-- end services -->
|
||||||
|
|
||||||
|
|
||||||
|
<a name="neo.fs.v2.session.ContainerSessionContext"></a>
|
||||||
|
|
||||||
|
### Message ContainerSessionContext
|
||||||
|
Context information for Session Tokens related to ContainerService requests.
|
||||||
|
|
||||||
|
|
||||||
|
| Field | Type | Label | Description |
|
||||||
|
| ----- | ---- | ----- | ----------- |
|
||||||
|
| verb | [ContainerSessionContext.Verb](#neo.fs.v2.session.ContainerSessionContext.Verb) | | Type of request for which the token is issued |
|
||||||
|
| wildcard | [bool](#bool) | | Spreads the action to all owner containers. If set, container_id field is ignored. |
|
||||||
|
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Particular container to which the action applies. Ignored if wildcard flag is set. |
|
||||||
|
|
||||||
|
|
||||||
<a name="neo.fs.v2.session.ObjectSessionContext"></a>
|
<a name="neo.fs.v2.session.ObjectSessionContext"></a>
|
||||||
|
|
||||||
### Message ObjectSessionContext
|
### Message ObjectSessionContext
|
||||||
|
@ -225,6 +239,7 @@ Session Token body
|
||||||
| lifetime | [SessionToken.Body.TokenLifetime](#neo.fs.v2.session.SessionToken.Body.TokenLifetime) | | Lifetime of the session |
|
| lifetime | [SessionToken.Body.TokenLifetime](#neo.fs.v2.session.SessionToken.Body.TokenLifetime) | | Lifetime of the session |
|
||||||
| session_key | [bytes](#bytes) | | Public key used in session |
|
| session_key | [bytes](#bytes) | | Public key used in session |
|
||||||
| object | [ObjectSessionContext](#neo.fs.v2.session.ObjectSessionContext) | | ObjectService session context |
|
| object | [ObjectSessionContext](#neo.fs.v2.session.ObjectSessionContext) | | ObjectService session context |
|
||||||
|
| container | [ContainerSessionContext](#neo.fs.v2.session.ContainerSessionContext) | | ContainerService session context |
|
||||||
|
|
||||||
|
|
||||||
<a name="neo.fs.v2.session.SessionToken.Body.TokenLifetime"></a>
|
<a name="neo.fs.v2.session.SessionToken.Body.TokenLifetime"></a>
|
||||||
|
@ -272,6 +287,20 @@ affect system behaviour:
|
||||||
<!-- end messages -->
|
<!-- end messages -->
|
||||||
|
|
||||||
|
|
||||||
|
<a name="neo.fs.v2.session.ContainerSessionContext.Verb"></a>
|
||||||
|
|
||||||
|
### ContainerSessionContext.Verb
|
||||||
|
Container request verbs
|
||||||
|
|
||||||
|
| Name | Number | Description |
|
||||||
|
| ---- | ------ | ----------- |
|
||||||
|
| VERB_UNSPECIFIED | 0 | Unknown verb |
|
||||||
|
| PUT | 1 | Refers to container.Put RPC call |
|
||||||
|
| DELETE | 2 | Refers to container.Delete RPC call |
|
||||||
|
| SETEACL | 3 | Refers to container.SetExtendedACL RPC call |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="neo.fs.v2.session.ObjectSessionContext.Verb"></a>
|
<a name="neo.fs.v2.session.ObjectSessionContext.Verb"></a>
|
||||||
|
|
||||||
### ObjectSessionContext.Verb
|
### ObjectSessionContext.Verb
|
||||||
|
|
Loading…
Reference in a new issue