2.7 KiB
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:
- 12 protocol buffers packages,
- auto-generated docs for protocol buffers,
- manually written docs for developers (to be done).
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