From d7ca10d468a4cbbed0021a76cb5e4f7610f5bb14 Mon Sep 17 00:00:00 2001 From: Stanislav Bogatyrev Date: Fri, 25 Dec 2020 15:16:10 +0300 Subject: [PATCH] docs: Update auto-generated documentation Signed-off-by: Stanislav Bogatyrev --- proto-docs/acl.md | 6 ++++++ proto-docs/object.md | 2 ++ proto-docs/refs.md | 38 +++++++++++++++++++++++++++++++------- 3 files changed, 39 insertions(+), 7 deletions(-) diff --git a/proto-docs/acl.md b/proto-docs/acl.md index 6bf0176..dc2375a 100644 --- a/proto-docs/acl.md +++ b/proto-docs/acl.md @@ -118,6 +118,12 @@ prefix to the name. Here is the list of fields available via this prefix: * $Object:homomorphicHash \ homomorphic_hash +Please note, that if request or response does not have object's headers or +full object (Range, RangeHash, Search, Delete), it will not be possible to +filter by object header fields or user attributes. From the well-known list +only `$Object:objectID` and `$Object:containerID` will be available, as +it's possible to take that information from the requested address. + | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | diff --git a/proto-docs/object.md b/proto-docs/object.md index 1b0433f..fdf3001 100644 --- a/proto-docs/object.md +++ b/proto-docs/object.md @@ -749,6 +749,8 @@ Short header fields | owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | Object's owner | | object_type | [ObjectType](#neo.fs.v2.object.ObjectType) | | Type of the object payload content | | payload_length | [uint64](#uint64) | | Size of payload in bytes. `0xFFFFFFFFFFFFFFFF` means `payload_length` is unknown | +| payload_hash | [neo.fs.v2.refs.Checksum](#neo.fs.v2.refs.Checksum) | | Hash of payload bytes | +| homomorphic_hash | [neo.fs.v2.refs.Checksum](#neo.fs.v2.refs.Checksum) | | Homomorphic hash of the object payload | diff --git a/proto-docs/refs.md b/proto-docs/refs.md index 5280c23..d423de5 100644 --- a/proto-docs/refs.md +++ b/proto-docs/refs.md @@ -67,10 +67,18 @@ Depending on checksum algorithm type the string presentation may vary: NeoFS container identifier. Container structures are immutable and content-addressed. -`ContainerID` is a 32 byte long SHA256 hash of stable-marshalled container -message. +`ContainerID` is a 32 byte long +[SHA256](https://csrc.nist.gov/publications/detail/fips/180/4/final) hash of +stable-marshalled container message. -String presentation is base58 encoded string. +String presentation is +[base58](https://tools.ietf.org/html/draft-msporny-base58-02) encoded string. + +JSON value will be the data encoded as a string using standard base64 +encoding with paddings. Either +[standard](https://tools.ietf.org/html/rfc4648#section-4) or +[URL-safe](https://tools.ietf.org/html/rfc4648#section-5) base64 encoding +with/without paddings are accepted. | Field | Type | Label | Description | @@ -84,10 +92,19 @@ String presentation is base58 encoded string. NeoFS Object unique identifier. Objects are immutable and content-addressed. It means `ObjectID` will change if `header` or `payload` changes. -`ObjectID` is a 32 byte long SHA256 hash of object's `header` field, which, -in it's turn, contains hash of object's payload. +`ObjectID` is a 32 byte long +[SHA256](https://csrc.nist.gov/publications/detail/fips/180/4/final) hash of +object's `header` field, which, in it's turn, contains hash of object's +payload. -String presentation is base58 encoded string. +String presentation is +[base58](https://tools.ietf.org/html/draft-msporny-base58-02) encoded string. + +JSON value will be the data encoded as a string using standard base64 +encoding with paddings. Either +[standard](https://tools.ietf.org/html/rfc4648#section-4) or +[URL-safe](https://tools.ietf.org/html/rfc4648#section-5) base64 encoding +with/without paddings are accepted. | Field | Type | Label | Description | @@ -105,7 +122,14 @@ be directly used as `OwnerID`. `OwnerID` is a 25 bytes sequence starting with Neo version prefix byte followed by 20 bytes of ScrptHash and 4 bytes of checksum. -String presentation is Base58 Check Encoded string. +String presentation is [Base58 +Check](https://en.bitcoin.it/wiki/Base58Check_encoding) Encoded string. + +JSON value will be the data encoded as a string using standard base64 +encoding with paddings. Either +[standard](https://tools.ietf.org/html/rfc4648#section-4) or +[URL-safe](https://tools.ietf.org/html/rfc4648#section-5) base64 encoding +with/without paddings are accepted. | Field | Type | Label | Description |