potyarkin/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Pull requests Activity Actions
WIP: FrostFS API documentation and proto files declaration
198 commits 3 branches 0 tags 1.9 MiB
Find a file
Alex Vanin 4aea595cc6 [#67] Use tuple of header and signature in object head response 
Object.Head method returns either full header or short header.
Since it can't return anything else, signature must be paired
with full header in explicit tuple message.

Signed-off-by: Alex Vanin <alexey@nspcc.ru>
2020-09-04 13:27:05 +03:00
.github initialize 2020-01-30 14:43:09 +03:00
accounting [#57] Merge service and session packages 2020-08-20 10:33:49 +03:00
acl acl: Fix naming mismatch 2020-09-02 15:03:03 +03:00
container [#57] Merge service and session packages 2020-08-20 10:33:49 +03:00
docs initialize 2020-01-30 14:43:09 +03:00
netmap [#59] netmap: Add LocalNodeInfo request 2020-09-03 12:47:23 +03:00
object [#67] Use tuple of header and signature in object head response 2020-09-04 13:27:05 +03:00
proto-docs [#66] object: Add object_id signature to Head response 2020-09-03 16:10:05 +03:00
refs [#56] Fix typos and regenerate docs 2020-08-18 18:41:44 +03:00
session [#57] Merge service and session packages 2020-08-20 10:33:49 +03:00
storagegroup [#56] Fix typos and regenerate docs 2020-08-18 18:41:44 +03:00
.gitignore [#45] Add buf linter call 2020-08-13 22:57:00 +03:00
buf.yaml [#45] Add buf linter call 2020-08-13 22:57:00 +03:00
CHANGELOG.md Update changelog for v1.2.0 2020-07-08 10:46:02 +03:00
LICENSE Create LICENSE 2020-04-09 19:27:39 +03:00
Makefile [#45] Fix linter errors 2020-08-13 22:57:00 +03:00
README.md update license in readme 2020-04-10 09:25:00 +03:00

README.md

NeoFS-API

NeoFS-API repository contains language-agnostic protocol buffers definitions of neofs-node structures and services.

Description

NeoFS-API repository is the basis for language-specific libraries, e.g.:

These libraries contain compiled protocol buffers code, defined in this repository. Use them to integrate applications with NeoFS.

This repository contains:

Protocol packages

Accounting

Accounting package defines services and structures for balance request and cheque operations.

See:

ACL

ACL package defines targets of access control rules.

Bootstrap

Bootstrap package defines bootstrap service that connects storage nodes to the network.

See:

Container

Container package defines service and structure of containers. NeoFS stores objects within the registered container according to a specified storage policy.

See:

Decimal

Decimal defines structure for encoding assets amount.

Object

Object is the storage unit in NeoFS. Object package defines structure of the object and service requests.

See:

Query

Query package defines structure for object search requests.

Refs

Refs package defines identity types: object id, container id, etc.

Service

Service package defines utility structures for all public API requests: TTL, request signature, etc.

Session

Session package defines service and structures to setup session between the node and the client. Session token is required in some object service requests. Node uses session private key to re-sign new objects and requests.

See:

State

State package defines service and structures for metrics gathering.

See:

StorageGroup

Storagegroup package defines structure that contains meta data for data audit. This meta data stored as a header in the NeoFS object.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details