Describe object field stringers in neofs-api #24

New issue

Closed

opened 2025-12-28 18:11:57 +00:00 by sami · 1 comment

sami commented

2025-12-28 18:11:57 +00:00

Owner

Originally created by @alexvanin on GitHub (Oct 27, 2020).

Originally assigned to: @realloc on GitHub.

According to https://github.com/nspcc-dev/neofs-api/pull/72#issuecomment-708328148 we've decided to describe string representation of object fields in neofs-spec. However there are a lot of information about well-known headers there, for example. And I don't see any issues with specifying string format in this repository. Also it should be implemented in neofs-api-go as well, so it makes sense.

We already agreed on format for object ID, container ID and address. But we have plenty more fields that we can filter on search request:

object ID (base58 encoded string)
container ID (base58 encoded string)
object address (two base58 encoded strings with / as a separator)
owner ID (NEO wallet address)
version
payload hash
homomorphic hash
object type

Edit 1:

split ID

Originally created by @alexvanin on GitHub (Oct 27, 2020). Originally assigned to: @realloc on GitHub. According to https://github.com/nspcc-dev/neofs-api/pull/72#issuecomment-708328148 we've decided to describe string representation of object fields in `neofs-spec`. However there are a lot of information about well-known headers there, for example. And I don't see any issues with specifying string format in this repository. Also it should be implemented in `neofs-api-go` as well, so it makes sense. We already agreed on format for object ID, container ID and address. But we have plenty more fields that we can filter on search request: - [x] object ID (base58 encoded string) - [x] container ID (base58 encoded string) - [x] object address (two base58 encoded strings with `/` as a separator) - [x] owner ID (NEO wallet address) - [ ] version - [ ] payload hash - [ ] homomorphic hash - [ ] object type Edit 1: - [ ] split ID

sami

2025-12-28 18:11:57 +00:00

closed this issue
added the
documentation

bug
labels

sami commented

2025-12-28 18:11:59 +00:00

Author

Owner

@alexvanin commented on GitHub (Oct 27, 2020):

Proposal for string representation of remaining fields:

version: semver compatible string vX.Y, where X - major, Y - minor number.
payload hash: hex encoded string without 0x prefix
homomorphic hash: hex encoded string without 0x prefix
object type: set of strings Tombstone, Regular, StorageGroup.

Edit 1:

split ID: UUIDv4 string

@alexvanin commented on GitHub (Oct 27, 2020): Proposal for string representation of remaining fields: * version: semver compatible string `vX.Y`, where `X` - major, `Y` - minor number. * payload hash: hex encoded string without `0x` prefix * homomorphic hash: hex encoded string without `0x` prefix * object type: set of strings `Tombstone`, `Regular`, `StorageGroup`. Edit 1: * split ID: UUIDv4 string