[#31] refs: Define ContainerID message

Define ContainerID message in refs package. In the future, this structure can be
ported into messages in place of the container identifier field to maintain
format uniformity. Also, storing the identifier in a dedicated message will
allow, if necessary, to expand it with additional information without losing
backward compatibility within one version of the API.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2020-08-05 17:39:57 +03:00 committed by Stanislav Bogatyrev
parent 67ecea7507
commit 2f5f6f8fde
2 changed files with 19 additions and 1 deletions

View file

@ -7,6 +7,7 @@
- Messages - Messages
- [Address](#refs.Address) - [Address](#refs.Address)
- [ContainerID](#refs.ContainerID)
- [ObjectID](#refs.ObjectID) - [ObjectID](#refs.ObjectID)
@ -35,6 +36,17 @@ Address of object (container id + object id)
| CID | [bytes](#bytes) | | CID is container identifier | | CID | [bytes](#bytes) | | CID is container identifier |
<a name="refs.ContainerID"></a>
### Message ContainerID
ContainerID groups information about the NeoFS container identifier.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| Value | [bytes](#bytes) | | Value carries the container identifier in a binary format. |
<a name="refs.ObjectID"></a> <a name="refs.ObjectID"></a>
### Message ObjectID ### Message ObjectID

View file

@ -22,4 +22,10 @@ message Address {
message ObjectID { message ObjectID {
// Value carries the object identifier in a binary format. // Value carries the object identifier in a binary format.
bytes Value = 1; bytes Value = 1;
} }
// ContainerID groups information about the NeoFS container identifier.
message ContainerID {
// Value carries the container identifier in a binary format.
bytes Value = 1;
}