Commit graph

54 commits

Author SHA1 Message Date
Leonard Lyubich
eaad094a2c [#26] object: Tidy up comments
Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
0525786d09 [#26] object: Use nested types in Header
This commit replaces all message definitions related to object header to
Header message.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
81a4adb202 [#26] object: Use nested types in ExtendedHeader
This commit replaces all message definitions related to extended header to
ExtendedHeader message.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
72edea28db [#26] object: Change field order in Header
This commit changes field order in ExtendedHeader message.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
a3a0de01b3 [#26] object: Replace Token to IntegrityHeader
This commit replaces Token field from ExtendedHeader to IntegrityHeader for
assembling all verification data in one structure.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
8e8d9f0982 [#26] object: Replace Epoch to ExtendedHeader
This commit replaces CreationEpoch field to ExtendedHeader message.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
a28decac39 [#26] object: Repeat object attributes in header
This commit replaces single Attribute field with the repeated list of
Attribute in ExtendedHeader message.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
fb2064803e [#26] object: Replace PayloadChecksum to Integrity
This commit replaces PayloadChecksum field from ExtendedHeader to
IntegrityHeader for assembling all verification data in one structure.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
b77811716e [#26] object: Replace creator key to Integrity
This commit moves the public key of the creator of the object to
IntegrityHeader to encapsulate the verification data in one message. Thus
field PublicKey of message Header has been moved to message IntegrityHeader
with the name CreatorKey. As a result, PublicKey message is deleted as no
longer used.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
0a5f3d5a01 [#26] object: Remove unused Redirect field
Redirect field was introduced for the future, however, at the moment it is
not used anywhere. This commit removes field Redirect from ExtendedHeader
message. It can be added back later without losing API backward
compatibility.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
4df4badf9c [#26] object: Remove Link message
After updating the structure of SplitHeader and StorageGroup messages, the
Link header field is no longer needed. This commit removes the field and
message Link as no longer used.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
300b1d4197 [#26] storagegroup: Add member list to message
To encapsulate the complete information about the storage group in
StorageGroup message, this commit adds the missing group member list field.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
7ce0945e6c [#26] object: Remove unused Version field
Field with object revision number was introduced for the future, however, at
the moment it is not used anywhere. This commit removes field Version from
SystemHeader message. It can be added back later without losing API
backward compatibility.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
9666fd4bc7 [#26] object: Remake ExtendedHeader to field set
In previous version of the format ExtendedHeader consisted of one field
Value, defined by oneof mechanism. Such a definition format give complete
freedom when composing an object header, however, it did not allow strictly
structuring the header format at the level of type syntax. Since the object
has a well-defined structure in the system, this commit replaces the
definition through oneof with a set of fields. As a consequence, storing a
set of extended headers of the new type in the general header became
redundant, so the repeated keyword was removed.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
cbd4cf63f9 [#26] object: Replace Transform header with Split
This commit replaces Transform message with SplitHeader in oneof definition
of Value field of Header message. The latter, unlike the first, carries
complete information about the generation of the object by splitting the
payload. As a result, the message is deleted as no longer used.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
485510ab66 [#26] object: Define object split info message
This commit defines SplitHeader message that encapsulates data about
spawning the object through a payload splitting. Message fields contain
information about the hierarchy in the split-chain as well as information
about the origin object.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
4bdd05ade8 [#26] refs: Use ObjectID message in Address
This commit makes ObjectID field of refs.Address message to use dedicated
message for object identifier ObjectID.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
96924b04dc [#26] refs: Define ObjectID message
This commit defines ObjectID message in refs package. In the future, this
structure can be ported into messages in place of the object 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>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
b46011db45 [#26] object: Combine ID and CID in Address
This commit merges object system header fields ID and CID into field Address
of type refs.Address. This will allow you to reuse an already existing type
of object reference without duplication and simplify taking the address
from the object body

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
6e5565f238 [#26] object: Replace CreationPoint with Epoch
In previous version of the format Object message included moment of creation
in two epoch times: NeoFS and Unix. Since unix  is not processed in the
system, this commit narrows the time point of object creation to the system
epoch number. The object.CreationPoint message has therefore been deleted
as no longer used

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
5beca3b0d1 [#26] object: Define message for object header
In previous version of the format Object message included two header fields:
SystemHeader and list of ExtendedHeader. Due to the fact that all headers
were not encapsulated in a single message, some messages were forced to use
Object to convey the full header of the object (e.g. object.HeadResponse).
To resolve this semantic inconsistency, this commit defines a Header
message, consisting of a system and an extended portion. As a result, the
Object now consists of two fields - Header and Payload.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
2c3717bdee [#26] object: Rename Header to ExtendedHeader
The naming Header obscures its semantic meaning precisely as a subclass of
the general object header. To clarify the layers of typing object headers,
this commit renames the message to ExtendedHeader. As a result, the Headers
field in the Object has been renamed to ExtendedHeaders.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
a76f634e47 [#26] object: Rename UserHeader to Attribute
The name of object.UserHeader message implies its use by the user. However,
the attributes of an object can also be set internally by the system. To
generalize the intended purpose of the message, this commit renames it to an
Attribute (like container.Attribute).

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 21:59:42 +03:00
Leonard Lyubich
7ea4d475a0 [#26] object: Replace object.Range message definition
This commit replaces Range message definition closer to where it is used. In
the future, only the types associated with the structure of the object will
be defined in types.proto file.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-05 10:29:25 +03:00
Alex Vanin
dfcbfdc7d8 [#23] Regenerate documentation
Signed-off-by: Alex Vanin <alexey@nspcc.ru>
2020-08-03 18:03:34 +03:00
Leonard Lyubich
089c6f1928 acl: Define EACLTable message for the table of extended ACL rules 2020-07-08 10:22:07 +03:00
Alex Vanin
4e5fa4f9e4
Merge pull request #18 from nspcc-dev/feature/extended-request-headers
service: support extended headers of the request
2020-06-18 13:33:15 +03:00
Alex Vanin
122c9fc548
Merge pull request #17 from nspcc-dev/feature/bearer-token-support
service: add Bearer token message to RequestVerificationHeader
2020-06-18 13:32:43 +03:00
Leonard Lyubich
108d7e0fb0 service: clarify the description of BearerTokenMsg.Info.ACLRules field 2020-06-18 11:56:26 +03:00
Leonard Lyubich
f059c49dec service: support extended headers of the request 2020-06-18 11:53:21 +03:00
Leonard Lyubich
1d3ffeb841 service: add Bearer token message to RequestVerificationHeader 2020-06-18 10:58:11 +03:00
Leonard Lyubich
17e07df8d9 container: add Get/Set extended ACL rpc 2020-06-18 10:42:37 +03:00
Leonard Lyubich
80e8ab014b service: add OwnerKey byte field to TokenInfo message 2020-05-15 15:29:15 +03:00
Leonard Lyubich
cbd5605dc9 session: change Create rpc signature
This commit:

  * makes Create rpc call to be unary message;

  * changes CreateRequest structure;

  * changes CreateResponse structure.
2020-05-07 18:44:23 +03:00
Leonard Lyubich
ea9e39b3e0 service: put token lifetime in a separate message 2020-05-07 18:42:29 +03:00
Evgeniy Kulikov
2913edbd42
docs: fix service docs 2020-04-28 16:15:24 +03:00
Leonard Lyubich
1de0d29a74 service: remove gogoproto customname from embedded Token.Info field
This commit:

  * removes gogoproto customname option from embedded Token.Info field;

  * renames Info field of Token message to TokenInfo.
2020-04-28 10:00:11 +03:00
Leonard Lyubich
738d521214 object: remove Token field from PutRequest.PutHeader and DeleteRequest
Session token is presented in RequestVerificationHeader, therefore its
presence in request bodies is redundant.
2020-04-27 13:17:16 +03:00
Leonard Lyubich
360d3ae2ce docs: regenerate 2020-04-27 13:14:31 +03:00
Leonard Lyubich
da3cb02936 object: remove redundant Raw field from GetRequest and HeadRequest 2020-04-27 11:00:03 +03:00
Leonard Lyubich
6b68940643 token: update structure
This commit:

  * moves Token message to service package;

  * updates token structure (new verb field, some renaming);

  * replaces VerificationHeader header with Token in object package;

  * removes no longer used VerificationHeader message.
2020-04-27 10:59:44 +03:00
Leonard Lyubich
b84fab4d24 service: change RequestVerificationHeader message
This commit:

  * removes RequestVerificationHeader.Signature message;

  * renames RequestVerificationHeader.Sign message to Signature.
2020-04-23 13:44:21 +03:00
Leonard Lyubich
a891eff012 service: add Raw field to RequestMetaHeader 2020-04-23 13:34:06 +03:00
Evgeniy Kulikov
c9edac72b4
docs: regenerate files 2020-04-20 13:29:30 +03:00
Leonard Lyubich
846a84cd0c regenerate docs 2020-04-15 18:27:46 +03:00
Evgeniy Kulikov
15de641fb1
regenerate docs 2020-04-15 12:24:40 +03:00
alexvanin
2803a0788d docs: Update container docs with BasicACL field 2020-04-01 21:06:54 +03:00
alexvanin
5b8fecc93d docs: Add docs for new ACL package
This commit adds auto-generated proto-docs page and
ACL section in readme.
2020-04-01 21:02:46 +03:00
Evgeniy Kulikov
54060e29be
update proto docs 2020-03-31 10:17:52 +03:00
Leonard Lyubich
9b2cb915ac update GetRangeRequest docs 2020-02-05 14:23:14 +03:00