docs: update proto doc comments to satisfy go-doc comment

This commit is contained in:
Evgeniy Kulikov 2019-11-21 10:26:01 +03:00
parent 7c0fef06fd
commit 15b997bdb5
No known key found for this signature in database
GPG key ID: BF6AEE0A2A699BF2
8 changed files with 201 additions and 111 deletions

View file

@ -7,9 +7,9 @@ import "github.com/gogo/protobuf/gogoproto/gogo.proto";
option (gogoproto.stable_marshaler_all) = true;
message VerificationHeader {
// Session public key
// PublicKey is a session public key
bytes PublicKey = 1;
// Session public key signature. Signed by trusted side
// KeySignature is a session public key signature. Signed by trusted side
bytes KeySignature = 2;
}
@ -17,16 +17,16 @@ message VerificationHeader {
message Token {
// Header carries verification data of session key
VerificationHeader Header = 1 [(gogoproto.nullable) = false];
// Owner of manipulation object
// OwnerID is an owner of manipulation object
bytes OwnerID = 2 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
// Initial epoch of token lifetime
// FirstEpoch is an initial epoch of token lifetime
uint64 FirstEpoch = 3;
// Last epoch of token lifetime
// LastEpoch is a last epoch of token lifetime
uint64 LastEpoch = 4;
// ID of manipulation object
// ObjectID is an object identifier of manipulation object
repeated bytes ObjectID = 5 [(gogoproto.customtype) = "ObjectID", (gogoproto.nullable) = false];
// Token signature. Signed by owner of manipulation object
// Signature is a token signature, signed by owner of manipulation object
bytes Signature = 6;
// Token ID (UUID)
// ID is a token identifier. valid UUIDv4 represented in bytes
bytes ID = 7 [(gogoproto.customtype) = "TokenID", (gogoproto.nullable) = false];
}