TrueCloudLab/frostfs-api
34
1
Fork 18
Code Issues 14 Pull requests 3 Releases Activity Actions

[#31] refs: Use ContainerID message in all services

Browse source 
Change the type of all fields for the container identifier to refs.ContainerID.
This will allow to follow a single format and not duplicate its description.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2020-08-05 18:07:56 +03:00 • committed by Stanislav Bogatyrev
parent 2f5f6f8fde
commit fccd753a5d
7 changed files with 26 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

10
proto-docs/container.md
View file

@ -120,7 +120,7 @@ smart-contract storage.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ContainerID | [bytes](#bytes) | | ContainerID of container to delete from NeoFS. |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | ContainerID carries identifier of the container to delete from NeoFS. |
| Signature | [bytes](#bytes) | | Signature of container id according to RFC-6979. |
@ -140,7 +140,7 @@ via consensus in inner ring nodes
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ContainerID | [bytes](#bytes) | | ContainerID of the container that has Extended ACL. |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | ContainerID carries identifier of the container that has Extended ACL. |
<a name="container.GetExtendedACLResponse"></a>
@ -163,7 +163,7 @@ via consensus in inner ring nodes
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ContainerID | [bytes](#bytes) | | ContainerID of the container to get. |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | ContainerID carries identifier of the container to get. |
<a name="container.GetResponse"></a>
@ -196,7 +196,7 @@ via consensus in inner ring nodes
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ContainerIDs | [bytes](#bytes) | repeated | ContainerIDs of containers that belong to the owner. |
| ContainerIDs | [refs.ContainerID](#refs.ContainerID) | repeated | ContainerIDs carries list of identifiers of the containers that belong to the owner. |
<a name="container.PutRequest"></a>
@ -220,7 +220,7 @@ via consensus in inner ring nodes
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ContainerID | [bytes](#bytes) | | ContainerID of the new container. |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | ContainerID carries identifier of the new container. |
<a name="container.SetExtendedACLRequest"></a>

2
proto-docs/object.md
View file

@ -327,7 +327,7 @@ in distributed system.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ContainerID | [bytes](#bytes) | | ContainerID for searching the object |
| ContainerID | [refs.ContainerID](#refs.ContainerID) | | ContainerID carries search container identifier. |
| Query | [bytes](#bytes) | | Query in the binary serialized format |
| QueryVersion | [uint32](#uint32) | | QueryVersion is a version of search query format |
| Meta | [service.RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader contains information about request meta headers (should be embedded into message) |

2
proto-docs/refs.md
View file

@ -33,7 +33,7 @@ Address of object (container id + object id)
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ObjectID | [ObjectID](#refs.ObjectID) | | ObjectID carries object identifier. |
| CID | [bytes](#bytes) | | CID is container identifier |
| ContainerID | [ContainerID](#refs.ContainerID) | | ContainerID carries container identifier. |
<a name="refs.ContainerID"></a>