From 52992d715034411b83403a021f1c24a826ecff84 Mon Sep 17 00:00:00 2001 From: Leonard Lyubich Date: Thu, 3 Jun 2021 15:34:19 +0300 Subject: [PATCH] Re-generate docs for release Signed-off-by: Leonard Lyubich --- proto-docs/container.md | 3 +++ proto-docs/session.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/proto-docs/container.md b/proto-docs/container.md index 6c7d9dd..41d6521 100644 --- a/proto-docs/container.md +++ b/proto-docs/container.md @@ -294,6 +294,7 @@ container creation. | ----- | ---- | ----- | ----------- | | 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 | +| session_token | [neo.fs.v2.session.SessionToken](#neo.fs.v2.session.SessionToken) | | Session token if Extended ACL was set within a session | @@ -343,6 +344,8 @@ was already verified on container creation. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | 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 | diff --git a/proto-docs/session.md b/proto-docs/session.md index f2324f4..ee4798c 100644 --- a/proto-docs/session.md +++ b/proto-docs/session.md @@ -17,6 +17,7 @@ - [session/types.proto](#session/types.proto) - Messages + - [ContainerSessionContext](#neo.fs.v2.session.ContainerSessionContext) - [ObjectSessionContext](#neo.fs.v2.session.ObjectSessionContext) - [RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) - [RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) @@ -127,6 +128,19 @@ Session creation response body + + +### 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. | + + ### Message ObjectSessionContext @@ -225,6 +239,7 @@ Session Token body | lifetime | [SessionToken.Body.TokenLifetime](#neo.fs.v2.session.SessionToken.Body.TokenLifetime) | | Lifetime of the session | | session_key | [bytes](#bytes) | | Public key used in session | | object | [ObjectSessionContext](#neo.fs.v2.session.ObjectSessionContext) | | ObjectService session context | +| container | [ContainerSessionContext](#neo.fs.v2.session.ContainerSessionContext) | | ContainerService session context | @@ -272,6 +287,20 @@ affect system behaviour: + + +### 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 | + + + ### ObjectSessionContext.Verb