From c79350316760f4b10ec63ef3f5a4e9e64ebd0539 Mon Sep 17 00:00:00 2001
From: Stanislav Bogatyrev <stanislav@nspcc.ru>
Date: Tue, 13 Oct 2020 18:29:09 +0300
Subject: [PATCH] Add well-known attributes for objects
Adding the list of currently well-known object attributes. More to come later.
Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
---
object/types.proto | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/object/types.proto b/object/types.proto
index 5741dec..0c44c89 100644
--- a/object/types.proto
+++ b/object/types.proto
@@ -79,7 +79,17 @@ message Header {
// Need it to verify integrity and authenticity out of Request scope.
neo.fs.v2.session.SessionToken session_token = 9;
- // Attribute groups the user-defined Key-Value pairs attached to the object
+ // `Attribute` is a user-defined Key-Value metadata pair attached to the
+ // object.
+ //
+ // There are some "well-known" attributes starting with `__NEOFS__` prefix
+ // that affect system behaviour:
+ //
+ // * __NEOFS__UPLOAD_ID
+ // * __NEOFS__EXPIRATION_EPOCH
+ //
+ // For detailed description of each well-known attribute please see the
+ // corresponding section in NeoFS Technical specification.
message Attribute {
// string key to the object attribute
string key = 1;