EliChin/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Issues Pull requests Projects Releases Packages Wiki Activity
FrostFS API documentation and proto files declaration
141 commits 3 branches 0 tags 702 KiB
Makefile 100%
Find a file
Leonard Lyubich f9c865eb53 [#34] container: Import PlacementRule from netmap 
Replaces import of PlacementRule message from netmap repository with a message
from the internal netmap package.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
2020-08-06 23:45:33 +03:00
.github initialize 2020-01-30 14:43:09 +03:00
accounting [#33] accounting: Tidy up the format 2020-08-06 23:08:27 +03:00
acl acl: Tidy up the format 2020-08-06 23:34:03 +03:00
container [#34] container: Import PlacementRule from netmap 2020-08-06 23:45:33 +03:00
docs initialize 2020-01-30 14:43:09 +03:00
netmap [#34] bootstrap: Move NodeInfo to netmap 2020-08-06 23:33:24 +03:00
object query: Move Query to object 2020-08-06 23:11:16 +03:00
proto-docs acl: Tidy up the format 2020-08-06 23:34:03 +03:00
refs [#31] refs: Define OwnerID message 2020-08-06 22:00:01 +03:00
service [#31] refs: Use OwnerID message in all services 2020-08-06 22:00:01 +03:00
session [#31] refs: Use OwnerID message in all services 2020-08-06 22:00:01 +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