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
117 commits 4 branches 0 tags 1.9 MiB
Find a file
Leonard Lyubich 2f5f6f8fde [#31] refs: Define ContainerID message 
Define ContainerID message in refs package. In the future, this structure can be
ported into messages in place of the container identifier field to maintain
format uniformity. Also, storing the identifier in a dedicated message will
allow, if necessary, to expand it with additional information without losing
backward compatibility within one version of the API.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 22:00:01 +03:00
.github initialize 2020-01-30 14:43:09 +03:00
accounting Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
acl [#21] Add container id into EACLTable message 2020-08-03 18:03:34 +03:00
bootstrap add bootstrap.Request.State and enum 2020-04-15 12:24:21 +03:00
container [#23] Update comments for autogenerated docs 2020-08-03 18:03:34 +03:00
decimal Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
docs initialize 2020-01-30 14:43:09 +03:00
object [#28] object: Move storage group information 2020-08-06 22:00:01 +03:00
proto-docs [#31] refs: Define ContainerID message 2020-08-06 22:00:01 +03:00
query Migrate to NeoFS API Go 2020-03-31 09:58:22 +03:00
refs [#31] refs: Define ContainerID message 2020-08-06 22:00:01 +03:00
service Merge pull request #18 from nspcc-dev/feature/extended-request-headers 2020-06-18 13:33:15 +03:00
session session: change Create rpc signature 2020-05-07 18:44:23 +03:00
state proto: add method to change current node state 2020-04-20 13:29:30 +03:00
storagegroup [#28] storagegroup: Add linebreaks for readability 2020-08-06 22:00:01 +03:00
.gitignore initialize 2020-01-30 14:43:09 +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 make: change deps output 2020-04-20 12:03:55 +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