forked from TrueCloudLab/frostfs-api
Compare commits
26 commits
feat/beart
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
| 8540f0d18d | |||
| 1a6bb369ec | |||
| 4c51a9b9d6 | |||
| 5bfbd249bc | |||
| b2f5205976 | |||
| 83f2fc5944 | |||
| 74bbc3a76b | |||
| 2a46a9ea0a | |||
| 5602b8fa2a | |||
| e8afd6e5f5 | |||
| 6b390035e7 | |||
| 6bc2038f03 | |||
| aaa922f600 | |||
| 6b0f3b01e0 | |||
| 54812ba857 | |||
| 8760caa093 | |||
| 542d0d9ec2 | |||
|
e5c976b557 | ||
|
|
2efdc8fedb | ||
| 8dd63c451c | |||
| 4a4a7612f6 | |||
|
|
0916cb5398 | ||
|
|
c7473ed98c | ||
|
|
4c2193443e | ||
|
|
393c95899f | ||
| e199ad2914 |
52 changed files with 739 additions and 1035 deletions
|
Before Width: | Height: | Size: 5.5 KiB After Width: | Height: | Size: 5.5 KiB |
19
.forgejo/workflows/dco.yaml
Normal file
19
.forgejo/workflows/dco.yaml
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
name: DCO action
|
||||
on: [pull_request]
|
||||
|
||||
jobs:
|
||||
dco:
|
||||
name: DCO
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Setup Go
|
||||
uses: actions/setup-go@v3
|
||||
with:
|
||||
go-version: '1.22'
|
||||
- name: Run commit format checker
|
||||
uses: https://git.frostfs.info/TrueCloudLab/dco-go@v3
|
||||
with:
|
||||
from: 'origin/${{ github.event.pull_request.base.ref }}'
|
||||
17
.forgejo/workflows/fmt.yaml
Normal file
17
.forgejo/workflows/fmt.yaml
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
name: Formatters
|
||||
on: [pull_request]
|
||||
|
||||
jobs:
|
||||
fmt:
|
||||
name: Run fmt
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: Install deps
|
||||
run: |
|
||||
apt update
|
||||
apt install -y clang-format
|
||||
- name: Run fmt
|
||||
run: |
|
||||
make fmt
|
||||
git diff --exit-code --quiet
|
||||
18
.forgejo/workflows/pre-commit.yaml
Normal file
18
.forgejo/workflows/pre-commit.yaml
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
name: Pre-commit hooks
|
||||
on: [pull_request]
|
||||
|
||||
jobs:
|
||||
pre-commit:
|
||||
name: Pre-commit
|
||||
env:
|
||||
# Skip pre-commit hooks which are executed by other actions.
|
||||
SKIP: make-fmt
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: Install deps
|
||||
run: |
|
||||
apt update
|
||||
apt install -y pre-commit
|
||||
- name: Run pre-commit
|
||||
run: pre-commit run --all-files --hook-stage manual --color=always
|
||||
1
.github/CODEOWNERS
vendored
1
.github/CODEOWNERS
vendored
|
|
@ -1 +0,0 @@
|
|||
* @alexvanin @realloc @fyrchik @anatoly-bogatyrev
|
||||
36
.github/workflows/buf.yml
vendored
36
.github/workflows/buf.yml
vendored
|
|
@ -1,36 +0,0 @@
|
|||
name: Buf lint
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: wizhi/setup-buf@v1
|
||||
with:
|
||||
version: 0.20.5
|
||||
- run: buf check lint
|
||||
|
||||
breaking:
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: Setup buf
|
||||
uses: wizhi/setup-buf@v1
|
||||
with:
|
||||
version: 0.20.5
|
||||
- name: Check out ref code
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
ref: ${{ github.base_ref }}
|
||||
path: baseref
|
||||
- run: cd baseref && buf image build -o image.bin
|
||||
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
path: prclone
|
||||
- run: cd prclone && buf check breaking --against-input ../baseref/image.bin
|
||||
21
.github/workflows/dco.yml
vendored
21
.github/workflows/dco.yml
vendored
|
|
@ -1,21 +0,0 @@
|
|||
name: DCO check
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
commits_check_job:
|
||||
runs-on: ubuntu-latest
|
||||
name: Commits Check
|
||||
steps:
|
||||
- name: Get PR Commits
|
||||
id: 'get-pr-commits'
|
||||
uses: tim-actions/get-pr-commits@master
|
||||
with:
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: DCO Check
|
||||
uses: tim-actions/dco@master
|
||||
with:
|
||||
commits: ${{ steps.get-pr-commits.outputs.commits }}
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -1,2 +1 @@
|
|||
.idea
|
||||
|
||||
|
|
|
|||
24
.pre-commit-config.yaml
Normal file
24
.pre-commit-config.yaml
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
repos:
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v4.6.0
|
||||
hooks:
|
||||
- id: check-added-large-files
|
||||
- id: check-case-conflict
|
||||
- id: check-executables-have-shebangs
|
||||
- id: check-shebang-scripts-are-executable
|
||||
- id: check-merge-conflict
|
||||
- id: check-json
|
||||
- id: check-xml
|
||||
- id: check-yaml
|
||||
- id: trailing-whitespace
|
||||
args: [--markdown-linebreak-ext=md]
|
||||
- id: end-of-file-fixer
|
||||
exclude: ".svg$"
|
||||
|
||||
- repo: local
|
||||
hooks:
|
||||
- id: make-fmt
|
||||
name: Run make fmt
|
||||
entry: make fmt
|
||||
language: system
|
||||
pass_filenames: false
|
||||
|
|
@ -61,7 +61,7 @@ Network magic, main status codes, object locks and notifications.
|
|||
- `LOCK` value of `object.Type` enum (#194)
|
||||
- `Lock` message with payload content of `LOCK` objects (#194)
|
||||
- `LOCKED` and `LOCK_NON_REGULAR_OBJECT` status codes to `Object` section (#194)
|
||||
- `scheme` field of type `SignatureScheme` to `Signature` message which determines
|
||||
- `scheme` field of type `SignatureScheme` to `Signature` message which determines
|
||||
signature scheme (#55)
|
||||
- `SignatureRFC6979` message (#203)
|
||||
|
||||
|
|
@ -166,8 +166,8 @@ values in the objects.
|
|||
|
||||
### Changed
|
||||
|
||||
- Clarified processing of empty search query in `object.Search` RPC.
|
||||
- Specified connection of tombstone expiration value with well-known
|
||||
- Clarified processing of empty search query in `object.Search` RPC.
|
||||
- Specified connection of tombstone expiration value with well-known
|
||||
`__NEOFS__EXPIRATION_EPOCH` object attribute.
|
||||
|
||||
## [2.3.0] - 2021-02-11 - Seonyudo (선유도, 仙遊島)
|
||||
|
|
|
|||
1
CODEOWNERS
Normal file
1
CODEOWNERS
Normal file
|
|
@ -0,0 +1 @@
|
|||
.* @alexvanin @realloc @fyrchik @a.bogatyrev
|
||||
|
|
@ -3,8 +3,8 @@
|
|||
First, thank you for contributing! We love and encourage pull requests from
|
||||
everyone. Please follow the guidelines:
|
||||
|
||||
- Check the open [issues](https://github.com/TrueCloudLab/frostfs-api/issues) and
|
||||
[pull requests](https://github.com/TrueCloudLab/frostfs-api/pulls) for existing
|
||||
- Check the open [issues](https://git.frostfs.info/TrueCloudLab/frostfs-api/issues) and
|
||||
[pull requests](https://git.frostfs.info/TrueCloudLab/frostfs-api/pulls) for existing
|
||||
discussions.
|
||||
|
||||
- Open an issue first, to discuss a new feature or enhancement.
|
||||
|
|
@ -25,19 +25,20 @@ Start by forking the `frostfs-api` repository, make changes in a branch and then
|
|||
send a pull request. We encourage pull requests to discuss code changes. Here
|
||||
are the steps in details:
|
||||
|
||||
### Set up your GitHub Repository
|
||||
Fork [NeoFS node upstream](https://github.com/TrueCloudLab/frostfs-api/fork) source
|
||||
### Set up your repository
|
||||
|
||||
Fork [FrostFS upstream](https://git.frostfs.info/TrueCloudLab/frostfs-api/fork) source
|
||||
repository to your own personal repository. Copy the URL of your fork (you will
|
||||
need it for the `git clone` command below).
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/TrueCloudLab/frostfs-api
|
||||
$ git clone https://git.frostfs.info/TrueCloudLab/frostfs-api
|
||||
```
|
||||
|
||||
### Set up git remote as ``upstream``
|
||||
```sh
|
||||
$ cd frostfs-api
|
||||
$ git remote add upstream https://github.com/TrueCloudLab/frostfs-api
|
||||
$ git remote add upstream https://git.frostfs.info/TrueCloudLab/frostfs-api
|
||||
$ git fetch upstream
|
||||
$ git merge upstream/master
|
||||
...
|
||||
|
|
@ -86,7 +87,7 @@ $ git push origin feature/123-something_awesome
|
|||
```
|
||||
|
||||
### Create a Pull Request
|
||||
Pull requests can be created via GitHub. Refer to [this
|
||||
Pull requests can be created via git.frostfs.info. Refer to [this
|
||||
document](https://help.github.com/articles/creating-a-pull-request/) for
|
||||
detailed steps on how to create a pull request. After a Pull Request gets peer
|
||||
reviewed and approved, it will be merged.
|
||||
|
|
|
|||
24
Makefile
Normal file → Executable file
24
Makefile
Normal file → Executable file
|
|
@ -1,27 +1,35 @@
|
|||
#!/usr/bin/make -f
|
||||
SHELL=bash
|
||||
|
||||
# BRanch to match for BReaking changes
|
||||
BRBR?=master
|
||||
include help.mk
|
||||
|
||||
.PHONY: lint
|
||||
lint:
|
||||
buf check lint
|
||||
buf check breaking --against-input '.git#branch=$(BRBR)'
|
||||
.PHONY: doc fmt pre-commit unpre-commit pre-commit-run
|
||||
|
||||
.PHONY: doc
|
||||
# Regenerate documentation for proto files:
|
||||
doc:
|
||||
@for f in `find . -type f -name '*.proto' -exec dirname {} \; | sort -u `; do \
|
||||
echo "⇒ Documentation for $$(basename $$f)"; \
|
||||
protoc \
|
||||
--doc_opt=.github/markdown.tmpl,$${f}.md \
|
||||
--doc_opt=.forgejo/markdown.tmpl,$${f}.md \
|
||||
--proto_path=.:/usr/local/include \
|
||||
--doc_out=proto-docs/ $${f}/*.proto; \
|
||||
done
|
||||
|
||||
# Run clang-format
|
||||
fmt:
|
||||
@for f in `ls **/*.proto`; do \
|
||||
echo "⇒ Formatting $$f"; \
|
||||
clang-format -i $$f; \
|
||||
done
|
||||
|
||||
# Activate pre-commit hooks
|
||||
pre-commit:
|
||||
pre-commit install --hook-type pre-commit
|
||||
|
||||
# Deactivate pre-commit hooks
|
||||
unpre-commit:
|
||||
pre-commit uninstall --hook-type pre-commit
|
||||
|
||||
# Run pre-commit hooks
|
||||
pre-commit-run:
|
||||
@pre-commit run --all-files --hook-stage manual
|
||||
|
|
|
|||
|
|
@ -1,19 +1,18 @@
|
|||
<p align="center">
|
||||
<img src="./.github/logo.svg" width="500px" alt="FrostFS">
|
||||
<img src="./.forgejo/logo.svg" width="500px" alt="FrostFS">
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://objectstorage.info">FrostFS</a> API language-agnostic protocol definitions
|
||||
<a href="https://frostfs.info">FrostFS</a> API language-agnostic protocol definitions
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
FrostFS-API repository is the basis for language-specific libraries, e.g.:
|
||||
|
||||
- [frostfs-api-go](https://github.com/TrueCloudLab/frostfs-api-go)
|
||||
- [frostfs-api-go](https://git.frostfs.info/TrueCloudLab/frostfs-api-go)
|
||||
|
||||
Those libraries contain compiled protocol buffers definitions, wrapped with
|
||||
language-specific code. Use them to integrate applications with FrostFS.
|
||||
|
|
|
|||
|
|
@ -9,13 +9,13 @@ import "accounting/types.proto";
|
|||
import "refs/types.proto";
|
||||
import "session/types.proto";
|
||||
|
||||
// Accounting service provides methods for interaction with NeoFS sidechain via
|
||||
// other NeoFS nodes to get information about the account balance. Deposit and
|
||||
// Withdraw operations can't be implemented here, as they require Mainnet NeoFS
|
||||
// smart contract invocation. Transfer operations between internal NeoFS
|
||||
// accounts are possible if both use the same token type.
|
||||
// Accounting service provides methods for interaction with FrostFS sidechain
|
||||
// via other FrostFS nodes to get information about the account balance. Deposit
|
||||
// and Withdraw operations can't be implemented here, as they require Mainnet
|
||||
// FrostFS smart contract invocation. Transfer operations between internal
|
||||
// FrostFS accounts are possible if both use the same token type.
|
||||
service AccountingService {
|
||||
// Returns the amount of funds in GAS token for the requested NeoFS account.
|
||||
// Returns the amount of funds in GAS token for the requested FrostFS account.
|
||||
//
|
||||
// Statuses:
|
||||
// - **OK** (0, SECTION_SUCCESS):
|
||||
|
|
@ -27,9 +27,9 @@ service AccountingService {
|
|||
// BalanceRequest message
|
||||
message BalanceRequest {
|
||||
// To indicate the account for which the balance is requested, its identifier
|
||||
// is used. It can be any existing account in NeoFS sidechain `Balance` smart
|
||||
// contract. If omitted, client implementation MUST set it to the request's
|
||||
// signer `OwnerID`.
|
||||
// is used. It can be any existing account in FrostFS sidechain `Balance`
|
||||
// smart contract. If omitted, client implementation MUST set it to the
|
||||
// request's signer `OwnerID`.
|
||||
message Body {
|
||||
// Valid user identifier in `OwnerID` format for which the balance is
|
||||
// requested. Required field.
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ package neo.fs.v2.accounting;
|
|||
option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/accounting/grpc;accounting";
|
||||
option csharp_namespace = "Neo.FileStorage.API.Accounting";
|
||||
|
||||
// Standard floating point data type can't be used in NeoFS due to inexactness
|
||||
// Standard floating point data type can't be used in FrostFS due to inexactness
|
||||
// of the result when doing lots of small number operations. To solve the lost
|
||||
// precision issue, special `Decimal` format is used for monetary computations.
|
||||
//
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/acl/grpc;ac
|
|||
option csharp_namespace = "Neo.FileStorage.API.Acl";
|
||||
|
||||
import "refs/types.proto";
|
||||
import "ape/types.proto";
|
||||
|
||||
// Target role of the access control rule in access control list.
|
||||
enum Role {
|
||||
|
|
@ -88,14 +89,14 @@ enum HeaderType {
|
|||
// Filter object headers
|
||||
OBJECT = 2;
|
||||
|
||||
// Filter service headers. These are not processed by NeoFS nodes and
|
||||
// Filter service headers. These are not processed by FrostFS nodes and
|
||||
// exist for service use only.
|
||||
SERVICE = 3;
|
||||
}
|
||||
|
||||
// Describes a single eACL rule.
|
||||
message EACLRecord {
|
||||
// NeoFS request Verb to match
|
||||
// FrostFS request Verb to match
|
||||
Operation operation = 1 [ json_name = "operation" ];
|
||||
|
||||
// Rule execution result. Either allows or denies access if filters match.
|
||||
|
|
@ -164,7 +165,7 @@ message EACLRecord {
|
|||
// Extended ACL rules table. A list of ACL rules defined additionally to Basic
|
||||
// ACL. Extended ACL rules can be attached to a container and can be updated
|
||||
// or may be defined in `BearerToken` structure. Please see the corresponding
|
||||
// NeoFS Technical Specification section for detailed description.
|
||||
// FrostFS Technical Specification section for detailed description.
|
||||
message EACLTable {
|
||||
// eACL format version. Effectively, the version of API library used to create
|
||||
// eACL Table.
|
||||
|
|
@ -194,6 +195,9 @@ message BearerToken {
|
|||
// container. If it contains `container_id` field, bearer token is only
|
||||
// valid for this specific container. Otherwise, any container of the same
|
||||
// owner is allowed.
|
||||
//
|
||||
// Deprecated: eACL tables are no longer relevant - `APEOverrides` should be
|
||||
// used instead.
|
||||
EACLTable eacl_table = 1 [ json_name = "eaclTable" ];
|
||||
|
||||
// `OwnerID` defines to whom the token was issued. It must match the request
|
||||
|
|
@ -218,6 +222,24 @@ message BearerToken {
|
|||
// AllowImpersonate flag to consider token signer as request owner.
|
||||
// If this field is true extended ACL table in token body isn't processed.
|
||||
bool allow_impersonate = 4 [ json_name = "allowImpersonate" ];
|
||||
|
||||
// APEOverride is the list of APE chains defined for a target.
|
||||
// These chains are meant to serve as overrides to the already defined (or
|
||||
// even undefined) APE chains for the target (see contract `Policy`).
|
||||
//
|
||||
// The server-side processing of the bearer token with set APE overrides
|
||||
// must verify if a client is permitted to override chains for the target,
|
||||
// preventing unauthorized access through the APE mechanism.
|
||||
message APEOverride {
|
||||
// Target for which chains are applied.
|
||||
frostfs.v2.ape.ChainTarget target = 1 [ json_name = "target" ];
|
||||
|
||||
// The list of APE chains.
|
||||
repeated frostfs.v2.ape.Chain chains = 2 [ json_name = "chains" ];
|
||||
}
|
||||
|
||||
// APE override for the target.
|
||||
APEOverride ape_override = 5 [ json_name = "apeOverride" ];
|
||||
}
|
||||
// Bearer Token body
|
||||
Body body = 1 [ json_name = "body" ];
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
syntax = "proto3";
|
||||
|
||||
package frostfs.v2.apemanager;
|
||||
package frostfs.v2.ape;
|
||||
|
||||
option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/apemanager/grpc;apemanager";
|
||||
option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/ape/grpc;ape";
|
||||
|
||||
// TargetType is a type target to which a rule chain is defined.
|
||||
enum TargetType {
|
||||
|
|
@ -2,7 +2,7 @@ syntax = "proto3";
|
|||
|
||||
package frostfs.v2.apemanager;
|
||||
|
||||
import "apemanager/types.proto";
|
||||
import "ape/types.proto";
|
||||
import "session/types.proto";
|
||||
|
||||
option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/apemanager/grpc;apemanager";
|
||||
|
|
@ -52,10 +52,10 @@ service APEManagerService {
|
|||
message AddChainRequest {
|
||||
message Body {
|
||||
// A target for which a rule chain is added.
|
||||
ChainTarget target = 1;
|
||||
frostfs.v2.ape.ChainTarget target = 1;
|
||||
|
||||
// The chain to set for the target.
|
||||
Chain chain = 2;
|
||||
frostfs.v2.ape.Chain chain = 2;
|
||||
}
|
||||
|
||||
// The request's body.
|
||||
|
|
@ -95,7 +95,7 @@ message AddChainResponse {
|
|||
message RemoveChainRequest {
|
||||
message Body {
|
||||
// Target for which a rule chain is removed.
|
||||
ChainTarget target = 1;
|
||||
frostfs.v2.ape.ChainTarget target = 1;
|
||||
|
||||
// Chain ID assigned for the rule chain.
|
||||
bytes chain_id = 2;
|
||||
|
|
@ -135,7 +135,7 @@ message RemoveChainResponse {
|
|||
message ListChainsRequest {
|
||||
message Body {
|
||||
// Target for which rule chains are listed.
|
||||
ChainTarget target = 1;
|
||||
frostfs.v2.ape.ChainTarget target = 1;
|
||||
}
|
||||
|
||||
// The request's body.
|
||||
|
|
@ -154,7 +154,7 @@ message ListChainsRequest {
|
|||
message ListChainsResponse {
|
||||
message Body {
|
||||
// The list of chains defined for the reqeusted target.
|
||||
repeated Chain chains = 1;
|
||||
repeated frostfs.v2.ape.Chain chains = 1;
|
||||
}
|
||||
|
||||
// The response's body.
|
||||
|
|
@ -168,4 +168,4 @@ message ListChainsResponse {
|
|||
// authenticate the nodes of the message route and check the correctness of
|
||||
// transmission.
|
||||
neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
10
buf.yaml
10
buf.yaml
|
|
@ -1,10 +0,0 @@
|
|||
lint:
|
||||
use:
|
||||
- DEFAULT
|
||||
- COMMENTS
|
||||
- ENUM_FIRST_VALUE_ZERO
|
||||
except:
|
||||
- PACKAGE_DIRECTORY_MATCH
|
||||
- PACKAGE_VERSION_SUFFIX
|
||||
- ENUM_VALUE_PREFIX
|
||||
- ENUM_ZERO_VALUE_SUFFIX
|
||||
|
|
@ -5,14 +5,13 @@ package neo.fs.v2.container;
|
|||
option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/container/grpc;container";
|
||||
option csharp_namespace = "Neo.FileStorage.API.Container";
|
||||
|
||||
import "acl/types.proto";
|
||||
import "container/types.proto";
|
||||
import "refs/types.proto";
|
||||
import "session/types.proto";
|
||||
|
||||
// `ContainerService` provides API to interact with `Container` smart contract
|
||||
// in NeoFS sidechain via other NeoFS nodes. All of those actions can be done
|
||||
// equivalently by directly issuing transactions and RPC calls to sidechain
|
||||
// in FrostFS sidechain via other FrostFS nodes. All of those actions can be
|
||||
// done equivalently by directly issuing transactions and RPC calls to sidechain
|
||||
// nodes.
|
||||
service ContainerService {
|
||||
// `Put` invokes `Container` smart contract's `Put` method and returns
|
||||
|
|
@ -25,7 +24,7 @@ service ContainerService {
|
|||
// request to save the container has been sent to the sidechain;
|
||||
// - Common failures (SECTION_FAILURE_COMMON);
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// container create access denied.
|
||||
// container create access denied.
|
||||
rpc Put(PutRequest) returns (PutResponse);
|
||||
|
||||
// `Delete` invokes `Container` smart contract's `Delete` method and returns
|
||||
|
|
@ -38,7 +37,7 @@ service ContainerService {
|
|||
// request to remove the container has been sent to the sidechain;
|
||||
// - Common failures (SECTION_FAILURE_COMMON);
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// container delete access denied.
|
||||
// container delete access denied.
|
||||
rpc Delete(DeleteRequest) returns (DeleteResponse);
|
||||
|
||||
// Returns container structure from `Container` smart contract storage.
|
||||
|
|
@ -50,57 +49,32 @@ service ContainerService {
|
|||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
// requested container not found;
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// access to container is denied.
|
||||
// access to container is denied.
|
||||
rpc Get(GetRequest) returns (GetResponse);
|
||||
|
||||
// Returns all owner's containers from 'Container` smart contract' storage.
|
||||
// Returns all owner's containers from `Container` smart contract storage.
|
||||
//
|
||||
// Statuses:
|
||||
// - **OK** (0, SECTION_SUCCESS): \
|
||||
// container list has been successfully read;
|
||||
// - Common failures (SECTION_FAILURE_COMMON);
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// container list access denied.
|
||||
// container list access denied.
|
||||
rpc List(ListRequest) returns (ListResponse);
|
||||
|
||||
// Invokes 'SetEACL' method of 'Container` smart contract and returns response
|
||||
// immediately. After one more block in sidechain, changes in an Extended ACL
|
||||
// are added into smart contract storage.
|
||||
// Returns all owner's containers from `Container` smart contract storage
|
||||
// via stream.
|
||||
//
|
||||
// Statuses:
|
||||
// - **OK** (0, SECTION_SUCCESS): \
|
||||
// request to save container eACL has been sent to the sidechain;
|
||||
// container list has been successfully read;
|
||||
// - Common failures (SECTION_FAILURE_COMMON);
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// set container eACL access denied.
|
||||
rpc SetExtendedACL(SetExtendedACLRequest) returns (SetExtendedACLResponse);
|
||||
|
||||
// Returns Extended ACL table and signature from `Container` smart contract
|
||||
// storage.
|
||||
//
|
||||
// Statuses:
|
||||
// - **OK** (0, SECTION_SUCCESS): \
|
||||
// container eACL has been successfully read;
|
||||
// - Common failures (SECTION_FAILURE_COMMON);
|
||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
// container not found;
|
||||
// - **EACL_NOT_FOUND** (3073, SECTION_CONTAINER): \
|
||||
// eACL table not found;
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// access to container eACL is denied.
|
||||
rpc GetExtendedACL(GetExtendedACLRequest) returns (GetExtendedACLResponse);
|
||||
|
||||
// Announces the space values used by the container for P2P synchronization.
|
||||
//
|
||||
// Statuses:
|
||||
// - **OK** (0, SECTION_SUCCESS): \
|
||||
// estimation of used space has been successfully announced;
|
||||
// - Common failures (SECTION_FAILURE_COMMON).
|
||||
rpc AnnounceUsedSpace(AnnounceUsedSpaceRequest)
|
||||
returns (AnnounceUsedSpaceResponse);
|
||||
// container list access denied.
|
||||
rpc ListStream(ListStreamRequest) returns (stream ListStreamResponse);
|
||||
}
|
||||
|
||||
// New NeoFS Container creation request
|
||||
// New FrostFS Container creation request
|
||||
message PutRequest {
|
||||
// Container creation request has container structure's signature as a
|
||||
// separate field. It's not stored in sidechain, just verified on container
|
||||
|
|
@ -108,7 +82,7 @@ message PutRequest {
|
|||
// the stable-marshalled container strucutre, hence there is no need for
|
||||
// additional signature checks.
|
||||
message Body {
|
||||
// Container structure to register in NeoFS
|
||||
// Container structure to register in FrostFS
|
||||
container.Container container = 1;
|
||||
|
||||
// Signature of a stable-marshalled container according to RFC-6979.
|
||||
|
|
@ -127,7 +101,7 @@ message PutRequest {
|
|||
neo.fs.v2.session.RequestVerificationHeader verify_header = 3;
|
||||
}
|
||||
|
||||
// New NeoFS Container creation response
|
||||
// New FrostFS Container creation response
|
||||
message PutResponse {
|
||||
// Container put response body contains information about the newly registered
|
||||
// container as seen by `Container` smart contract. `ContainerID` can be
|
||||
|
|
@ -156,7 +130,7 @@ message DeleteRequest {
|
|||
// the container owner's intent. The signature will be verified by `Container`
|
||||
// smart contract, so signing algorithm must be supported by NeoVM.
|
||||
message Body {
|
||||
// Identifier of the container to delete from NeoFS
|
||||
// Identifier of the container to delete from FrostFS
|
||||
neo.fs.v2.refs.ContainerID container_id = 1;
|
||||
|
||||
// `ContainerID` signed with the container owner's key according to
|
||||
|
|
@ -283,18 +257,14 @@ message ListResponse {
|
|||
neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
|
||||
}
|
||||
|
||||
// Set Extended ACL
|
||||
message SetExtendedACLRequest {
|
||||
// Set Extended ACL request body does not have separate `ContainerID`
|
||||
// reference. It will be taken from `EACLTable.container_id` field.
|
||||
// List containers stream
|
||||
message ListStreamRequest {
|
||||
// List containers stream request body.
|
||||
message Body {
|
||||
// Extended ACL table to set for the container
|
||||
neo.fs.v2.acl.EACLTable eacl = 1;
|
||||
|
||||
// Signature of stable-marshalled Extended ACL table according to RFC-6979.
|
||||
neo.fs.v2.refs.SignatureRFC6979 signature = 2;
|
||||
// Identifier of the container owner.
|
||||
neo.fs.v2.refs.OwnerID owner_id = 1;
|
||||
}
|
||||
// Body of set extended acl request message.
|
||||
// Body of list containers stream request message.
|
||||
Body body = 1;
|
||||
|
||||
// Carries request meta information. Header data is used only to regulate
|
||||
|
|
@ -307,117 +277,15 @@ message SetExtendedACLRequest {
|
|||
neo.fs.v2.session.RequestVerificationHeader verify_header = 3;
|
||||
}
|
||||
|
||||
// Set Extended ACL
|
||||
message SetExtendedACLResponse {
|
||||
// `SetExtendedACLResponse` has an empty body because the operation is
|
||||
// asynchronous and the update should be reflected in `Container` smart
|
||||
// contract's storage after next block is issued in sidechain.
|
||||
message Body {}
|
||||
// List containers stream
|
||||
message ListStreamResponse {
|
||||
// List containers stream response body.
|
||||
message Body {
|
||||
// List of `ContainerID`s belonging to the requested `OwnerID`
|
||||
repeated refs.ContainerID container_ids = 1;
|
||||
}
|
||||
|
||||
// Body of set extended acl response message.
|
||||
Body body = 1;
|
||||
|
||||
// Carries response meta information. Header data is used only to regulate
|
||||
// message transport and does not affect request execution.
|
||||
neo.fs.v2.session.ResponseMetaHeader meta_header = 2;
|
||||
|
||||
// Carries response verification information. This header is used to
|
||||
// authenticate the nodes of the message route and check the correctness of
|
||||
// transmission.
|
||||
neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
|
||||
}
|
||||
|
||||
// Get Extended ACL
|
||||
message GetExtendedACLRequest {
|
||||
// Get Extended ACL request body
|
||||
message Body {
|
||||
// Identifier of the container having Extended ACL
|
||||
neo.fs.v2.refs.ContainerID container_id = 1;
|
||||
}
|
||||
|
||||
// Body of get extended acl request message.
|
||||
Body body = 1;
|
||||
|
||||
// Carries request meta information. Header data is used only to regulate
|
||||
// message transport and does not affect request execution.
|
||||
neo.fs.v2.session.RequestMetaHeader meta_header = 2;
|
||||
|
||||
// Carries request verification information. This header is used to
|
||||
// authenticate the nodes of the message route and check the correctness of
|
||||
// transmission.
|
||||
neo.fs.v2.session.RequestVerificationHeader verify_header = 3;
|
||||
}
|
||||
|
||||
// Get Extended ACL
|
||||
message GetExtendedACLResponse {
|
||||
// Get Extended ACL Response body can be empty if the requested container does
|
||||
// not have Extended ACL Table attached or Extended ACL has not been allowed
|
||||
// at the time of container creation.
|
||||
message Body {
|
||||
// Extended ACL requested, if available
|
||||
neo.fs.v2.acl.EACLTable eacl = 1;
|
||||
|
||||
// Signature of stable-marshalled Extended ACL according to RFC-6979.
|
||||
neo.fs.v2.refs.SignatureRFC6979 signature = 2;
|
||||
|
||||
// Session token if Extended ACL was set within a session
|
||||
neo.fs.v2.session.SessionToken session_token = 3;
|
||||
}
|
||||
// Body of get extended acl response message.
|
||||
Body body = 1;
|
||||
|
||||
// Carries response meta information. Header data is used only to regulate
|
||||
// message transport and does not affect request execution.
|
||||
neo.fs.v2.session.ResponseMetaHeader meta_header = 2;
|
||||
|
||||
// Carries response verification information. This header is used to
|
||||
// authenticate the nodes of the message route and check the correctness of
|
||||
// transmission.
|
||||
neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
|
||||
}
|
||||
|
||||
// Announce container used space
|
||||
message AnnounceUsedSpaceRequest {
|
||||
// Container used space announcement body.
|
||||
message Body {
|
||||
// Announcement contains used space information for a single container.
|
||||
message Announcement {
|
||||
// Epoch number for which the container size estimation was produced.
|
||||
uint64 epoch = 1;
|
||||
|
||||
// Identifier of the container.
|
||||
neo.fs.v2.refs.ContainerID container_id = 2;
|
||||
|
||||
// Used space is a sum of object payload sizes of a specified
|
||||
// container, stored in the node. It must not include inhumed objects.
|
||||
uint64 used_space = 3;
|
||||
}
|
||||
|
||||
// List of announcements. If nodes share several containers,
|
||||
// announcements are transferred in a batch.
|
||||
repeated Announcement announcements = 1;
|
||||
}
|
||||
|
||||
// Body of announce used space request message.
|
||||
Body body = 1;
|
||||
|
||||
// Carries request meta information. Header data is used only to regulate
|
||||
// message transport and does not affect request execution.
|
||||
neo.fs.v2.session.RequestMetaHeader meta_header = 2;
|
||||
|
||||
// Carries request verification information. This header is used to
|
||||
// authenticate the nodes of the message route and check the correctness of
|
||||
// transmission.
|
||||
neo.fs.v2.session.RequestVerificationHeader verify_header = 3;
|
||||
}
|
||||
|
||||
// Announce container used space
|
||||
message AnnounceUsedSpaceResponse {
|
||||
// `AnnounceUsedSpaceResponse` has an empty body because announcements are
|
||||
// one way communication.
|
||||
message Body {}
|
||||
|
||||
// Body of announce used space response message.
|
||||
// Body of list containers stream response message.
|
||||
Body body = 1;
|
||||
|
||||
// Carries response meta information. Header data is used only to regulate
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ message Container {
|
|||
// (`__NEOFS__DISABLE_HOMOMORPHIC_HASHING` is deprecated) \
|
||||
// Disables homomorphic hashing for the container if the value equals "true"
|
||||
// string. Any other values are interpreted as missing attribute. Container
|
||||
// could be accepted in a NeoFS network only if the global network hashing
|
||||
// could be accepted in a FrostFS network only if the global network hashing
|
||||
// configuration value corresponds with that attribute's value. After
|
||||
// container inclusion, network setting is ignored.
|
||||
//
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Release instructions
|
||||
|
||||
This documents outlines the neofs-api release process and can be used as a TODO
|
||||
This documents outlines the frostfs-api release process and can be used as a TODO
|
||||
list for a new release.
|
||||
|
||||
## Pre-release checks
|
||||
|
|
@ -20,7 +20,7 @@ Add an entry to the CHANGELOG.md following the style established there.
|
|||
Add a codename for releases with the new major version, version and release date in
|
||||
the heading. Write a paragraph describing the most significant changes done in
|
||||
this release. Then add sections with what has been added, changed and removed,
|
||||
describing each change briefly with a reference to GitHub issues, where
|
||||
describing each change briefly with a reference to issues, where
|
||||
available.
|
||||
|
||||
## Release commit
|
||||
|
|
@ -38,7 +38,7 @@ Release v2.9.0 - Anmyeondo (안면도, 安眠島)
|
|||
Use `vX.Y.Z` tag following the semantic versioning standard. For pre-release
|
||||
versions use `vX.Y.Z-rc.N` scheme.
|
||||
|
||||
## Push changes and release tag to Github
|
||||
## Push changes and release tag to repository
|
||||
|
||||
This step should bypass the default PR mechanism to get a correct result (so
|
||||
that releasing requires admin privileges for the project), both the `master`
|
||||
|
|
@ -48,9 +48,9 @@ branch update and tag must be pushed simultaneously like this:
|
|||
$ git push origin master v2.7.0
|
||||
```
|
||||
|
||||
## Make a proper Github release
|
||||
## Make a proper release
|
||||
|
||||
Edit an automatically-created release on Github.
|
||||
Edit an automatically-created release on git.frostfs.info
|
||||
|
||||
Release title has to follow `<version> <Romanized codename> (<Hangeul, Hanja
|
||||
codename> )` scheme for major releases and just `<version>` for regular point
|
||||
|
|
@ -58,6 +58,5 @@ releases.
|
|||
|
||||
## Post-release actions
|
||||
|
||||
* Close corresponding X.Y.Z Github milestone
|
||||
* Close corresponding X.Y.Z milestone
|
||||
* Make announcements in Matrix and Discord channels
|
||||
* Update [NeoFS Technical Specification](https://github.com/nspcc-dev/neofs-spec)
|
||||
|
|
|
|||
11
help.mk
Normal file
11
help.mk
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
.PHONY: help
|
||||
|
||||
# Show this help prompt
|
||||
help:
|
||||
@echo ' Usage:'
|
||||
@echo ''
|
||||
@echo ' make <target>'
|
||||
@echo ''
|
||||
@echo ' Targets:'
|
||||
@echo ''
|
||||
@awk '/^#/{ comment = substr($$0,3) } /^[a-zA-Z][a-zA-Z0-9_-]+:/{ print " ", $$1, comment; comment = "" }' $(MAKEFILE_LIST) | column -t -s ':' | grep -v 'IGNORE' | sort | uniq
|
||||
|
|
@ -12,7 +12,7 @@ import "session/types.proto";
|
|||
// `NetmapService` provides methods to work with `Network Map` and the
|
||||
// information required to build it. The resulting `Network Map` is stored in
|
||||
// sidechain `Netmap` smart contract, while related information can be obtained
|
||||
// from other NeoFS nodes.
|
||||
// from other FrostFS nodes.
|
||||
service NetmapService {
|
||||
// Get NodeInfo structure from the particular node directly.
|
||||
// Node information can be taken from `Netmap` smart contract. In some cases,
|
||||
|
|
@ -27,7 +27,7 @@ service NetmapService {
|
|||
// - Common failures (SECTION_FAILURE_COMMON).
|
||||
rpc LocalNodeInfo(LocalNodeInfoRequest) returns (LocalNodeInfoResponse);
|
||||
|
||||
// Read recent information about the NeoFS network.
|
||||
// Read recent information about the FrostFS network.
|
||||
//
|
||||
// Statuses:
|
||||
// - **OK** (0, SECTION_SUCCESS):
|
||||
|
|
@ -35,7 +35,7 @@ service NetmapService {
|
|||
// - Common failures (SECTION_FAILURE_COMMON).
|
||||
rpc NetworkInfo(NetworkInfoRequest) returns (NetworkInfoResponse);
|
||||
|
||||
// Returns network map snapshot of the current NeoFS epoch.
|
||||
// Returns network map snapshot of the current FrostFS epoch.
|
||||
//
|
||||
// Statuses:
|
||||
// - **OK** (0, SECTION_SUCCESS):
|
||||
|
|
@ -65,7 +65,7 @@ message LocalNodeInfoRequest {
|
|||
message LocalNodeInfoResponse {
|
||||
// Local Node Info, including API Version in use.
|
||||
message Body {
|
||||
// Latest NeoFS API version in use
|
||||
// Latest FrostFS API version in use
|
||||
neo.fs.v2.refs.Version version = 1;
|
||||
|
||||
// NodeInfo structure with recent information from node itself
|
||||
|
|
|
|||
|
|
@ -36,6 +36,9 @@ enum Operation {
|
|||
|
||||
// Logical negation
|
||||
NOT = 9;
|
||||
|
||||
// Matches pattern
|
||||
LIKE = 10;
|
||||
}
|
||||
|
||||
// Selector modifier shows how the node set will be formed. By default selector
|
||||
|
|
@ -119,7 +122,7 @@ message PlacementPolicy {
|
|||
// bucket
|
||||
repeated Replica replicas = 1 [ json_name = "replicas" ];
|
||||
|
||||
// Container backup factor controls how deep NeoFS will search for nodes
|
||||
// Container backup factor controls how deep FrostFS will search for nodes
|
||||
// alternatives to include into container's nodes subset
|
||||
uint32 container_backup_factor = 2 [ json_name = "containerBackupFactor" ];
|
||||
|
||||
|
|
@ -133,25 +136,25 @@ message PlacementPolicy {
|
|||
bool unique = 5 [ json_name = "unique" ];
|
||||
}
|
||||
|
||||
// NeoFS node description
|
||||
// FrostFS node description
|
||||
message NodeInfo {
|
||||
// Public key of the NeoFS node in a binary format
|
||||
// Public key of the FrostFS node in a binary format
|
||||
bytes public_key = 1 [ json_name = "publicKey" ];
|
||||
|
||||
// Ways to connect to a node
|
||||
repeated string addresses = 2 [ json_name = "addresses" ];
|
||||
|
||||
// Administrator-defined Attributes of the NeoFS Storage Node.
|
||||
// Administrator-defined Attributes of the FrostFS Storage Node.
|
||||
//
|
||||
// `Attribute` is a Key-Value metadata pair. Key name must be a valid UTF-8
|
||||
// string. Value can't be empty.
|
||||
//
|
||||
// Attributes can be constructed into a chain of attributes: any attribute can
|
||||
// have a parent attribute and a child attribute (except the first and the
|
||||
// last one). A string representation of the chain of attributes in NeoFS
|
||||
// last one). A string representation of the chain of attributes in FrostFS
|
||||
// Storage Node configuration uses ":" and "/" symbols, e.g.:
|
||||
//
|
||||
// `NEOFS_NODE_ATTRIBUTE_1=key1:val1/key2:val2`
|
||||
// `FrostFS_NODE_ATTRIBUTE_1=key1:val1/key2:val2`
|
||||
//
|
||||
// Therefore the string attribute representation in the Node configuration
|
||||
// must use "\:", "\/" and "\\" escaped symbols if any of them appears in an
|
||||
|
|
@ -198,8 +201,8 @@ message NodeInfo {
|
|||
// [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). Calculated
|
||||
// automatically from `UN-LOCODE` attribute.
|
||||
// * Continent \
|
||||
// Node's continent name according to the [Seven-Continent model]
|
||||
// (https://en.wikipedia.org/wiki/Continent#Number). Calculated
|
||||
// Node's continent name according to the [Seven-Continent
|
||||
// model](https://en.wikipedia.org/wiki/Continent#Number). Calculated
|
||||
// automatically from `UN-LOCODE` attribute.
|
||||
// * ExternalAddr
|
||||
// Node's preferred way for communications with external clients.
|
||||
|
|
@ -207,7 +210,7 @@ message NodeInfo {
|
|||
// Must contain a comma-separated list of multi-addresses.
|
||||
//
|
||||
// For detailed description of each well-known attribute please see the
|
||||
// corresponding section in NeoFS Technical Specification.
|
||||
// corresponding section in FrostFS Technical Specification.
|
||||
message Attribute {
|
||||
// Key of the node attribute
|
||||
string key = 1 [ json_name = "key" ];
|
||||
|
|
@ -219,13 +222,13 @@ message NodeInfo {
|
|||
// `Country`.
|
||||
repeated string parents = 3 [ json_name = "parents" ];
|
||||
}
|
||||
// Carries list of the NeoFS node attributes in a key-value form. Key name
|
||||
// Carries list of the FrostFS node attributes in a key-value form. Key name
|
||||
// must be a node-unique valid UTF-8 string. Value can't be empty. NodeInfo
|
||||
// structures with duplicated attribute names or attributes with empty values
|
||||
// will be considered invalid.
|
||||
repeated Attribute attributes = 3 [ json_name = "attributes" ];
|
||||
|
||||
// Represents the enumeration of various states of the NeoFS node.
|
||||
// Represents the enumeration of various states of the FrostFS node.
|
||||
enum State {
|
||||
// Unknown state
|
||||
UNSPECIFIED = 0;
|
||||
|
|
@ -240,7 +243,7 @@ message NodeInfo {
|
|||
MAINTENANCE = 3;
|
||||
}
|
||||
|
||||
// Carries state of the NeoFS node
|
||||
// Carries state of the FrostFS node
|
||||
State state = 4 [ json_name = "state" ];
|
||||
}
|
||||
|
||||
|
|
@ -253,7 +256,7 @@ message Netmap {
|
|||
repeated NodeInfo nodes = 2 [ json_name = "nodes" ];
|
||||
}
|
||||
|
||||
// NeoFS network configuration
|
||||
// FrostFS network configuration
|
||||
message NetworkConfig {
|
||||
// Single configuration parameter. Key MUST be network-unique.
|
||||
//
|
||||
|
|
@ -272,7 +275,7 @@ message NetworkConfig {
|
|||
// Fee paid for container creation by the container owner.
|
||||
// Value: little-endian integer. Default: 0.
|
||||
// - **EpochDuration** \
|
||||
// NeoFS epoch duration measured in Sidechain blocks.
|
||||
// FrostFS epoch duration measured in Sidechain blocks.
|
||||
// Value: little-endian integer. Default: 0.
|
||||
// - **HomomorphicHashingDisabled** \
|
||||
// Flag of disabling the homomorphic hashing of objects' payload.
|
||||
|
|
@ -284,8 +287,39 @@ message NetworkConfig {
|
|||
// Flag allowing setting the MAINTENANCE state to storage nodes.
|
||||
// Value: true if any byte != 0. Default: false.
|
||||
// - **MaxObjectSize** \
|
||||
// Maximum size of physically stored NeoFS object measured in bytes.
|
||||
// Maximum size of physically stored FrostFS object measured in bytes.
|
||||
// Value: little-endian integer. Default: 0.
|
||||
//
|
||||
// This value refers to the maximum size of a **physically** stored object
|
||||
// in FrostFS. However, from a user's perspective, the **logical** size of a
|
||||
// stored object can be significantly larger. The relationship between the
|
||||
// physical and logical object sizes is governed by the following formula
|
||||
//
|
||||
// ```math
|
||||
// \mathrm{Stored\ Object\ Size} \le
|
||||
// \frac{
|
||||
// \left(\mathrm{Max\ Object\ Size}\right)^2
|
||||
// }{
|
||||
// \mathrm{Object\ ID\ Size}
|
||||
// }
|
||||
// ```
|
||||
//
|
||||
// This arises from the fact that a tombstone, also being an object, stores
|
||||
// the IDs of inhumed objects and cannot be divided into smaller objects,
|
||||
// thus having an upper limit for its size.
|
||||
//
|
||||
// For example, if:
|
||||
// * Max Object Size Size = 64 MiB;
|
||||
// * Object ID Size = 32 B;
|
||||
//
|
||||
// then:
|
||||
// ```math
|
||||
// \mathrm{Stored\ Object\ Size} \le
|
||||
// \frac{\left(64\ \mathrm{MiB}\right)^2}{32\ \mathrm{B}} =
|
||||
// \frac{2^{52}}{2^5}\ \mathrm{B} =
|
||||
// 2^{47}\ \mathrm{B} =
|
||||
// 128\ \mathrm{TiB}
|
||||
// ```
|
||||
// - **WithdrawFee** \
|
||||
// Fee paid for withdrawal of funds paid by the account owner.
|
||||
// Value: little-endian integer. Default: 0.
|
||||
|
|
@ -306,18 +340,18 @@ message NetworkConfig {
|
|||
repeated Parameter parameters = 1 [ json_name = "parameters" ];
|
||||
}
|
||||
|
||||
// Information about NeoFS network
|
||||
// Information about FrostFS network
|
||||
message NetworkInfo {
|
||||
// Number of the current epoch in the NeoFS network
|
||||
// Number of the current epoch in the FrostFS network
|
||||
uint64 current_epoch = 1 [ json_name = "currentEpoch" ];
|
||||
|
||||
// Magic number of the sidechain of the NeoFS network
|
||||
// Magic number of the sidechain of the FrostFS network
|
||||
uint64 magic_number = 2 [ json_name = "magicNumber" ];
|
||||
|
||||
// MillisecondsPerBlock network parameter of the sidechain of the NeoFS
|
||||
// MillisecondsPerBlock network parameter of the sidechain of the FrostFS
|
||||
// network
|
||||
int64 ms_per_block = 3 [ json_name = "msPerBlock" ];
|
||||
|
||||
// NeoFS network configuration
|
||||
// FrostFS network configuration
|
||||
NetworkConfig network_config = 4 [ json_name = "networkConfig" ];
|
||||
}
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ service ObjectService {
|
|||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
// object container not found;
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// access to container is denied;
|
||||
// access to container is denied;
|
||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
// provided session token has expired.
|
||||
rpc Get(GetRequest) returns (stream GetResponse);
|
||||
|
|
@ -115,7 +115,7 @@ service ObjectService {
|
|||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
// object container not found;
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// access to container is denied;
|
||||
// access to container is denied;
|
||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
// provided session token has expired.
|
||||
rpc Delete(DeleteRequest) returns (DeleteResponse);
|
||||
|
|
@ -145,13 +145,13 @@ service ObjectService {
|
|||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
// object container not found;
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// access to container is denied;
|
||||
// access to container is denied;
|
||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
// provided session token has expired.
|
||||
rpc Head(HeadRequest) returns (HeadResponse);
|
||||
|
||||
// Search objects in container. Search query allows to match by Object
|
||||
// Header's filed values. Please see the corresponding NeoFS Technical
|
||||
// Header's filed values. Please see the corresponding FrostFS Technical
|
||||
// Specification section for more details.
|
||||
//
|
||||
// Extended headers can change `Search` behaviour:
|
||||
|
|
@ -171,7 +171,7 @@ service ObjectService {
|
|||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
// search container not found;
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// access to container is denied;
|
||||
// access to container is denied;
|
||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
// provided session token has expired.
|
||||
rpc Search(SearchRequest) returns (stream SearchResponse);
|
||||
|
|
@ -208,7 +208,7 @@ service ObjectService {
|
|||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
// object container not found;
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// access to container is denied;
|
||||
// access to container is denied;
|
||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
// provided session token has expired.
|
||||
rpc GetRange(GetRangeRequest) returns (stream GetRangeResponse);
|
||||
|
|
@ -243,7 +243,7 @@ service ObjectService {
|
|||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
// object container not found;
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// access to container is denied;
|
||||
// access to container is denied;
|
||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
// provided session token has expired.
|
||||
rpc GetRangeHash(GetRangeHashRequest) returns (GetRangeHashResponse);
|
||||
|
|
@ -275,7 +275,7 @@ service ObjectService {
|
|||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
// object storage container not found;
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// access to container is denied;
|
||||
// access to container is denied;
|
||||
// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
|
||||
// (for trusted object preparation) session private key does not exist or
|
||||
// has
|
||||
|
|
@ -283,6 +283,55 @@ service ObjectService {
|
|||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
// provided session token has expired.
|
||||
rpc PutSingle(PutSingleRequest) returns (PutSingleResponse);
|
||||
|
||||
// Patch the object. Request uses gRPC stream. First message must set
|
||||
// the address of the object that is going to get patched. If the object's
|
||||
// attributes are patched, then these attrubutes must be set only within the
|
||||
// first stream message.
|
||||
//
|
||||
// If the patch request is performed by NOT the object's owner but if the
|
||||
// actor has the permission to perform the patch, then `OwnerID` of the object
|
||||
// is changed. In this case the object's owner loses the object's ownership
|
||||
// after the patch request is successfully done.
|
||||
//
|
||||
// As objects are content-addressable the patching causes new object ID
|
||||
// generation for the patched object. This object id is set witihn
|
||||
// `PatchResponse`. But the object id may remain unchanged in such cases:
|
||||
// 1. The chunk of the applying patch contains the same value as the object's
|
||||
// payload within the same range;
|
||||
// 2. The patch that reverts the changes applied by preceding patch;
|
||||
// 3. The application of the same patches for the object a few times.
|
||||
//
|
||||
// Extended headers can change `Patch` behaviour:
|
||||
// * [ __SYSTEM__NETMAP_EPOCH \
|
||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||
// Will use the requsted version of Network Map for object placement
|
||||
// calculation.
|
||||
//
|
||||
// Please refer to detailed `XHeader` description.
|
||||
//
|
||||
// Statuses:
|
||||
// - **OK** (0, SECTION_SUCCESS): \
|
||||
// object has been successfully patched and saved in the container;
|
||||
// - Common failures (SECTION_FAILURE_COMMON);
|
||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||
// write access to the container is denied;
|
||||
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
||||
// object not found in container;
|
||||
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
||||
// the requested object has been marked as deleted.
|
||||
// - **OUT_OF_RANGE** (2053, SECTION_OBJECT): \
|
||||
// the requested range is out of bounds;
|
||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
// object storage container not found;
|
||||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// access to container is denied;
|
||||
// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
|
||||
// (for trusted object preparation) session private key does not exist or
|
||||
// has been deleted;
|
||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
// provided session token has expired.
|
||||
rpc Patch(stream PatchRequest) returns (PatchResponse);
|
||||
}
|
||||
|
||||
// GET object request
|
||||
|
|
@ -584,8 +633,8 @@ message SearchRequest {
|
|||
// * $Object:split.splitID \
|
||||
// 16 byte UUIDv4 used to identify the split object hierarchy parts
|
||||
// * $Object:ec.parent \
|
||||
// If the object is stored according to EC policy, then ec_parent attribute
|
||||
// is set to return an id list of all related EC chunks.
|
||||
// If the object is stored according to EC policy, then ec_parent
|
||||
// attribute is set to return an id list of all related EC chunks.
|
||||
//
|
||||
// There are some well-known filter aliases to match objects by certain
|
||||
// properties:
|
||||
|
|
@ -816,4 +865,75 @@ message PutSingleResponse {
|
|||
// authenticate the nodes of the message route and check the correctness of
|
||||
// transmission.
|
||||
neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
|
||||
}
|
||||
}
|
||||
|
||||
// Object PATCH request
|
||||
message PatchRequest {
|
||||
// PATCH request body
|
||||
message Body {
|
||||
// The address of the object that is requested to get patched.
|
||||
neo.fs.v2.refs.Address address = 1;
|
||||
|
||||
// New attributes for the object. See `replace_attributes` flag usage to
|
||||
// define how new attributes should be set.
|
||||
repeated neo.fs.v2.object.Header.Attribute new_attributes = 2;
|
||||
|
||||
// If this flag is set, then the object's attributes will be entirely
|
||||
// replaced by `new_attributes` list. The empty `new_attributes` list with
|
||||
// `replace_attributes = true` just resets attributes list for the object.
|
||||
//
|
||||
// Default `false` value for this flag means the attributes will be just
|
||||
// merged. If the incoming `new_attributes` list contains already existing
|
||||
// key, then it just replaces it while merging the lists.
|
||||
bool replace_attributes = 3;
|
||||
|
||||
// The patch for the object's payload.
|
||||
message Patch {
|
||||
// The range of the source object for which the payload is replaced by the
|
||||
// patch's chunk. If the range's `length = 0`, then the patch's chunk is
|
||||
// just appended to the original payload starting from the `offest`
|
||||
// without any replace.
|
||||
Range source_range = 1;
|
||||
|
||||
// The chunk that is being appended to or that replaces the original
|
||||
// payload on the given range.
|
||||
bytes chunk = 2;
|
||||
}
|
||||
|
||||
// The patch that is applied for the object.
|
||||
Patch patch = 4;
|
||||
}
|
||||
|
||||
// Body for patch request message.
|
||||
Body body = 1;
|
||||
|
||||
// Carries request meta information. Header data is used only to regulate
|
||||
// message transport and does not affect request execution.
|
||||
neo.fs.v2.session.RequestMetaHeader meta_header = 2;
|
||||
|
||||
// Carries request verification information. This header is used to
|
||||
// authenticate the nodes of the message route and check the correctness of
|
||||
// transmission.
|
||||
neo.fs.v2.session.RequestVerificationHeader verify_header = 3;
|
||||
}
|
||||
|
||||
// Object PATCH response
|
||||
message PatchResponse {
|
||||
// PATCH response body
|
||||
message Body {
|
||||
// The object ID of the saved patched object.
|
||||
neo.fs.v2.refs.ObjectID object_id = 1;
|
||||
}
|
||||
|
||||
// Body for patch response message.
|
||||
Body body = 1;
|
||||
|
||||
// Carries response meta information. Header data is used only to regulate
|
||||
// message transport and does not affect request execution.
|
||||
neo.fs.v2.session.ResponseMetaHeader meta_header = 2;
|
||||
|
||||
// Carries response verification information. This header is used to
|
||||
// authenticate the nodes of the message route and check the correctness of
|
||||
// transmission.
|
||||
neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -155,7 +155,7 @@ message Header {
|
|||
// MIME Content Type of object's payload
|
||||
//
|
||||
// For detailed description of each well-known attribute please see the
|
||||
// corresponding section in NeoFS Technical Specification.
|
||||
// corresponding section in FrostFS Technical Specification.
|
||||
message Attribute {
|
||||
// string key to the object attribute
|
||||
string key = 1 [ json_name = "key" ];
|
||||
|
|
@ -209,13 +209,17 @@ message Header {
|
|||
// Chunk of a parent header.
|
||||
bytes header = 5 [ json_name = "header" ];
|
||||
// As the origin object is EC-splitted its identifier is known to all
|
||||
// chunks as parent. But parent itself can be a part of Split (does not relate to EC-split).
|
||||
// In this case parent_split_id should be set.
|
||||
// chunks as parent. But parent itself can be a part of Split (does not
|
||||
// relate to EC-split). In this case parent_split_id should be set.
|
||||
bytes parent_split_id = 6 [ json_name = "parentSplitID" ];
|
||||
// EC-parent's parent ID. parent_split_parent_id is set if EC-parent, itself, is a part of Split and
|
||||
// if an object ID of its parent is presented. The field allows to determine how EC-chunk is placed
|
||||
// in Split hierarchy.
|
||||
neo.fs.v2.refs.ObjectID parent_split_parent_id = 7 [ json_name = "parentSplitParentID" ];
|
||||
// EC-parent's parent ID. parent_split_parent_id is set if EC-parent,
|
||||
// itself, is a part of Split and if an object ID of its parent is
|
||||
// presented. The field allows to determine how EC-chunk is placed in Split
|
||||
// hierarchy.
|
||||
neo.fs.v2.refs.ObjectID parent_split_parent_id = 7
|
||||
[ json_name = "parentSplitParentID" ];
|
||||
// EC parent's attributes.
|
||||
repeated Attribute parent_attributes = 8 [ json_name = "parentAttributes" ];
|
||||
}
|
||||
// Erasure code chunk information.
|
||||
EC ec = 12 [ json_name = "ec" ];
|
||||
|
|
@ -271,4 +275,4 @@ message ECInfo {
|
|||
}
|
||||
// Chunk stored on the node.
|
||||
repeated Chunk chunks = 1;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,19 +6,19 @@
|
|||
- [accounting/service.proto](#accounting/service.proto)
|
||||
- Services
|
||||
- [AccountingService](#neo.fs.v2.accounting.AccountingService)
|
||||
|
||||
|
||||
- Messages
|
||||
- [BalanceRequest](#neo.fs.v2.accounting.BalanceRequest)
|
||||
- [BalanceRequest.Body](#neo.fs.v2.accounting.BalanceRequest.Body)
|
||||
- [BalanceResponse](#neo.fs.v2.accounting.BalanceResponse)
|
||||
- [BalanceResponse.Body](#neo.fs.v2.accounting.BalanceResponse.Body)
|
||||
|
||||
|
||||
|
||||
- [accounting/types.proto](#accounting/types.proto)
|
||||
|
||||
- Messages
|
||||
- [Decimal](#neo.fs.v2.accounting.Decimal)
|
||||
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -35,11 +35,11 @@
|
|||
<a name="neo.fs.v2.accounting.AccountingService"></a>
|
||||
|
||||
### Service "neo.fs.v2.accounting.AccountingService"
|
||||
Accounting service provides methods for interaction with NeoFS sidechain via
|
||||
other NeoFS nodes to get information about the account balance. Deposit and
|
||||
Withdraw operations can't be implemented here, as they require Mainnet NeoFS
|
||||
smart contract invocation. Transfer operations between internal NeoFS
|
||||
accounts are possible if both use the same token type.
|
||||
Accounting service provides methods for interaction with FrostFS sidechain
|
||||
via other FrostFS nodes to get information about the account balance. Deposit
|
||||
and Withdraw operations can't be implemented here, as they require Mainnet
|
||||
FrostFS smart contract invocation. Transfer operations between internal
|
||||
FrostFS accounts are possible if both use the same token type.
|
||||
|
||||
```
|
||||
rpc Balance(BalanceRequest) returns (BalanceResponse);
|
||||
|
|
@ -48,7 +48,7 @@ rpc Balance(BalanceRequest) returns (BalanceResponse);
|
|||
|
||||
#### Method Balance
|
||||
|
||||
Returns the amount of funds in GAS token for the requested NeoFS account.
|
||||
Returns the amount of funds in GAS token for the requested FrostFS account.
|
||||
|
||||
Statuses:
|
||||
- **OK** (0, SECTION_SUCCESS):
|
||||
|
|
@ -78,9 +78,9 @@ BalanceRequest message
|
|||
|
||||
### Message BalanceRequest.Body
|
||||
To indicate the account for which the balance is requested, its identifier
|
||||
is used. It can be any existing account in NeoFS sidechain `Balance` smart
|
||||
contract. If omitted, client implementation MUST set it to the request's
|
||||
signer `OwnerID`.
|
||||
is used. It can be any existing account in FrostFS sidechain `Balance`
|
||||
smart contract. If omitted, client implementation MUST set it to the
|
||||
request's signer `OwnerID`.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
|
|
@ -131,7 +131,7 @@ rounding.
|
|||
<a name="neo.fs.v2.accounting.Decimal"></a>
|
||||
|
||||
### Message Decimal
|
||||
Standard floating point data type can't be used in NeoFS due to inexactness
|
||||
Standard floating point data type can't be used in FrostFS due to inexactness
|
||||
of the result when doing lots of small number operations. To solve the lost
|
||||
precision issue, special `Decimal` format is used for monetary computations.
|
||||
|
||||
|
|
@ -170,4 +170,3 @@ description.
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -8,12 +8,13 @@
|
|||
- Messages
|
||||
- [BearerToken](#neo.fs.v2.acl.BearerToken)
|
||||
- [BearerToken.Body](#neo.fs.v2.acl.BearerToken.Body)
|
||||
- [BearerToken.Body.APEOverride](#neo.fs.v2.acl.BearerToken.Body.APEOverride)
|
||||
- [BearerToken.Body.TokenLifetime](#neo.fs.v2.acl.BearerToken.Body.TokenLifetime)
|
||||
- [EACLRecord](#neo.fs.v2.acl.EACLRecord)
|
||||
- [EACLRecord.Filter](#neo.fs.v2.acl.EACLRecord.Filter)
|
||||
- [EACLRecord.Target](#neo.fs.v2.acl.EACLRecord.Target)
|
||||
- [EACLTable](#neo.fs.v2.acl.EACLTable)
|
||||
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -57,10 +58,31 @@ container owner with additional information preventing token abuse.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| eacl_table | [EACLTable](#neo.fs.v2.acl.EACLTable) | | Table of Extended ACL rules to use instead of the ones attached to the container. If it contains `container_id` field, bearer token is only valid for this specific container. Otherwise, any container of the same owner is allowed. |
|
||||
| eacl_table | [EACLTable](#neo.fs.v2.acl.EACLTable) | | Table of Extended ACL rules to use instead of the ones attached to the container. If it contains `container_id` field, bearer token is only valid for this specific container. Otherwise, any container of the same owner is allowed.
|
||||
|
||||
Deprecated: eACL tables are no longer relevant - `APEOverrides` should be used instead. |
|
||||
| owner_id | [neo.fs.v2.refs.OwnerID](#neo.fs.v2.refs.OwnerID) | | `OwnerID` defines to whom the token was issued. It must match the request originator's `OwnerID`. If empty, any token bearer will be accepted. |
|
||||
| lifetime | [BearerToken.Body.TokenLifetime](#neo.fs.v2.acl.BearerToken.Body.TokenLifetime) | | Token expiration and valid time period parameters |
|
||||
| allow_impersonate | [bool](#bool) | | AllowImpersonate flag to consider token signer as request owner. If this field is true extended ACL table in token body isn't processed. |
|
||||
| ape_override | [BearerToken.Body.APEOverride](#neo.fs.v2.acl.BearerToken.Body.APEOverride) | | APE override for the target. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.acl.BearerToken.Body.APEOverride"></a>
|
||||
|
||||
### Message BearerToken.Body.APEOverride
|
||||
APEOverride is the list of APE chains defined for a target.
|
||||
These chains are meant to serve as overrides to the already defined (or
|
||||
even undefined) APE chains for the target (see contract `Policy`).
|
||||
|
||||
The server-side processing of the bearer token with set APE overrides
|
||||
must verify if a client is permitted to override chains for the target,
|
||||
preventing unauthorized access through the APE mechanism.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| target | [frostfs.v2.ape.ChainTarget](#frostfs.v2.ape.ChainTarget) | | Target for which chains are applied. |
|
||||
| chains | [frostfs.v2.ape.Chain](#frostfs.v2.ape.Chain) | repeated | The list of APE chains. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.acl.BearerToken.Body.TokenLifetime"></a>
|
||||
|
|
@ -85,7 +107,7 @@ Describes a single eACL rule.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| operation | [Operation](#neo.fs.v2.acl.Operation) | | NeoFS request Verb to match |
|
||||
| operation | [Operation](#neo.fs.v2.acl.Operation) | | FrostFS request Verb to match |
|
||||
| action | [Action](#neo.fs.v2.acl.Action) | | Rule execution result. Either allows or denies access if filters match. |
|
||||
| filters | [EACLRecord.Filter](#neo.fs.v2.acl.EACLRecord.Filter) | repeated | List of filters to match and see if rule is applicable |
|
||||
| targets | [EACLRecord.Target](#neo.fs.v2.acl.EACLRecord.Target) | repeated | List of target subjects to apply ACL rule to |
|
||||
|
|
@ -153,7 +175,7 @@ keys to match.
|
|||
Extended ACL rules table. A list of ACL rules defined additionally to Basic
|
||||
ACL. Extended ACL rules can be attached to a container and can be updated
|
||||
or may be defined in `BearerToken` structure. Please see the corresponding
|
||||
NeoFS Technical Specification section for detailed description.
|
||||
FrostFS Technical Specification section for detailed description.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
|
|
@ -189,7 +211,7 @@ Enumeration of possible sources of Headers to apply filters.
|
|||
| HEADER_UNSPECIFIED | 0 | Unspecified header, default value. |
|
||||
| REQUEST | 1 | Filter request headers |
|
||||
| OBJECT | 2 | Filter object headers |
|
||||
| SERVICE | 3 | Filter service headers. These are not processed by NeoFS nodes and exist for service use only. |
|
||||
| SERVICE | 3 | Filter service headers. These are not processed by FrostFS nodes and exist for service use only. |
|
||||
|
||||
|
||||
|
||||
|
|
@ -261,4 +283,3 @@ Target role of the access control rule in access control list.
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -3,64 +3,63 @@
|
|||
|
||||
## Table of Contents
|
||||
|
||||
- [bootstrap/types.proto](#bootstrap/types.proto)
|
||||
- [ape/types.proto](#ape/types.proto)
|
||||
|
||||
- Messages
|
||||
- [NodeInfo](#bootstrap.NodeInfo)
|
||||
- [NodeInfo.Attribute](#bootstrap.NodeInfo.Attribute)
|
||||
|
||||
- [Chain](#frostfs.v2.ape.Chain)
|
||||
- [ChainTarget](#frostfs.v2.ape.ChainTarget)
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
||||
|
||||
<a name="bootstrap/types.proto"></a>
|
||||
<a name="ape/types.proto"></a>
|
||||
<p align="right"><a href="#top">Top</a></p>
|
||||
|
||||
## bootstrap/types.proto
|
||||
## ape/types.proto
|
||||
|
||||
|
||||
<!-- end services -->
|
||||
|
||||
|
||||
<a name="bootstrap.NodeInfo"></a>
|
||||
<a name="frostfs.v2.ape.Chain"></a>
|
||||
|
||||
### Message NodeInfo
|
||||
Groups the information about the NeoFS node.
|
||||
### Message Chain
|
||||
Chain is a chain of rules defined for a specific target.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Address | [string](#string) | | Carries network address of the NeoFS node. |
|
||||
| PublicKey | [bytes](#bytes) | | Carries public key of the NeoFS node in a binary format. |
|
||||
| Attributes | [NodeInfo.Attribute](#bootstrap.NodeInfo.Attribute) | repeated | Carries list of the NeoFS node attributes in a string key-value format. |
|
||||
| state | [NodeInfo.State](#bootstrap.NodeInfo.State) | | Carries state of the NeoFS node. |
|
||||
| raw | [bytes](#bytes) | | Raw representation of a serizalized rule chain. |
|
||||
|
||||
|
||||
<a name="bootstrap.NodeInfo.Attribute"></a>
|
||||
<a name="frostfs.v2.ape.ChainTarget"></a>
|
||||
|
||||
### Message NodeInfo.Attribute
|
||||
Groups attributes of the NeoFS node.
|
||||
### Message ChainTarget
|
||||
ChainTarget is an object to which a rule chain is defined.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Key | [string](#string) | | Carries string key to the node attribute. |
|
||||
| Value | [string](#string) | | Carries string value of the node attribute. |
|
||||
| type | [TargetType](#frostfs.v2.ape.TargetType) | | |
|
||||
| name | [string](#string) | | |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
|
||||
<a name="bootstrap.NodeInfo.State"></a>
|
||||
<a name="frostfs.v2.ape.TargetType"></a>
|
||||
|
||||
### NodeInfo.State
|
||||
Represents the enumeration of various states of the NeoFS node.
|
||||
### TargetType
|
||||
TargetType is a type target to which a rule chain is defined.
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| Unknown | 0 | Undefined state. |
|
||||
| Online | 1 | Active state on the network. |
|
||||
| Offline | 2 | Network unavailable state. |
|
||||
| UNDEFINED | 0 | |
|
||||
| NAMESPACE | 1 | |
|
||||
| CONTAINER | 2 | |
|
||||
| USER | 3 | |
|
||||
| GROUP | 4 | |
|
||||
|
||||
|
||||
<!-- end enums -->
|
||||
|
|
@ -86,4 +85,3 @@ Represents the enumeration of various states of the NeoFS node.
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
- [apemanager/service.proto](#apemanager/service.proto)
|
||||
- Services
|
||||
- [APEManagerService](#frostfs.v2.apemanager.APEManagerService)
|
||||
|
||||
|
||||
- Messages
|
||||
- [AddChainRequest](#frostfs.v2.apemanager.AddChainRequest)
|
||||
- [AddChainRequest.Body](#frostfs.v2.apemanager.AddChainRequest.Body)
|
||||
|
|
@ -20,14 +20,7 @@
|
|||
- [RemoveChainRequest.Body](#frostfs.v2.apemanager.RemoveChainRequest.Body)
|
||||
- [RemoveChainResponse](#frostfs.v2.apemanager.RemoveChainResponse)
|
||||
- [RemoveChainResponse.Body](#frostfs.v2.apemanager.RemoveChainResponse.Body)
|
||||
|
||||
|
||||
- [apemanager/types.proto](#apemanager/types.proto)
|
||||
|
||||
- Messages
|
||||
- [Chain](#frostfs.v2.apemanager.Chain)
|
||||
- [ChainTarget](#frostfs.v2.apemanager.ChainTarget)
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -128,8 +121,8 @@ Statuses:
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| target | [ChainTarget](#frostfs.v2.apemanager.ChainTarget) | | A target for which a rule chain is added. |
|
||||
| chain | [Chain](#frostfs.v2.apemanager.Chain) | | The chain to set for the target. |
|
||||
| target | [frostfs.v2.ape.ChainTarget](#frostfs.v2.ape.ChainTarget) | | A target for which a rule chain is added. |
|
||||
| chain | [frostfs.v2.ape.Chain](#frostfs.v2.ape.Chain) | | The chain to set for the target. |
|
||||
|
||||
|
||||
<a name="frostfs.v2.apemanager.AddChainResponse"></a>
|
||||
|
|
@ -177,7 +170,7 @@ Statuses:
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| target | [ChainTarget](#frostfs.v2.apemanager.ChainTarget) | | Target for which rule chains are listed. |
|
||||
| target | [frostfs.v2.ape.ChainTarget](#frostfs.v2.ape.ChainTarget) | | Target for which rule chains are listed. |
|
||||
|
||||
|
||||
<a name="frostfs.v2.apemanager.ListChainsResponse"></a>
|
||||
|
|
@ -201,7 +194,7 @@ Statuses:
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| chains | [Chain](#frostfs.v2.apemanager.Chain) | repeated | The list of chains defined for the reqeusted target. |
|
||||
| chains | [frostfs.v2.ape.Chain](#frostfs.v2.ape.Chain) | repeated | The list of chains defined for the reqeusted target. |
|
||||
|
||||
|
||||
<a name="frostfs.v2.apemanager.RemoveChainRequest"></a>
|
||||
|
|
@ -225,7 +218,7 @@ Statuses:
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| target | [ChainTarget](#frostfs.v2.apemanager.ChainTarget) | | Target for which a rule chain is removed. |
|
||||
| target | [frostfs.v2.ape.ChainTarget](#frostfs.v2.ape.ChainTarget) | | Target for which a rule chain is removed. |
|
||||
| chain_id | [bytes](#bytes) | | Chain ID assigned for the rule chain. |
|
||||
|
||||
|
||||
|
|
@ -255,58 +248,6 @@ operation could not be performed is an error returning to a client.
|
|||
|
||||
|
||||
|
||||
<a name="apemanager/types.proto"></a>
|
||||
<p align="right"><a href="#top">Top</a></p>
|
||||
|
||||
## apemanager/types.proto
|
||||
|
||||
|
||||
<!-- end services -->
|
||||
|
||||
|
||||
<a name="frostfs.v2.apemanager.Chain"></a>
|
||||
|
||||
### Message Chain
|
||||
Chain is a chain of rules defined for a specific target.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| raw | [bytes](#bytes) | | Raw representation of a serizalized rule chain. |
|
||||
|
||||
|
||||
<a name="frostfs.v2.apemanager.ChainTarget"></a>
|
||||
|
||||
### Message ChainTarget
|
||||
ChainTarget is an object to which a rule chain is defined.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| type | [TargetType](#frostfs.v2.apemanager.TargetType) | | |
|
||||
| name | [string](#string) | | |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
|
||||
<a name="frostfs.v2.apemanager.TargetType"></a>
|
||||
|
||||
### TargetType
|
||||
TargetType is a type target to which a rule chain is defined.
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| UNDEFINED | 0 | |
|
||||
| NAMESPACE | 1 | |
|
||||
| CONTAINER | 2 | |
|
||||
| USER | 3 | |
|
||||
| GROUP | 4 | |
|
||||
|
||||
|
||||
<!-- end enums -->
|
||||
|
||||
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ Type | Java Type | Python Type |
|
||||
|
|
@ -326,4 +267,3 @@ TargetType is a type target to which a rule chain is defined.
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -1,74 +0,0 @@
|
|||
# Protocol Documentation
|
||||
<a name="top"></a>
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [audit/types.proto](#audit/types.proto)
|
||||
|
||||
- Messages
|
||||
- [DataAuditResult](#neo.fs.v2.audit.DataAuditResult)
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
||||
|
||||
<a name="audit/types.proto"></a>
|
||||
<p align="right"><a href="#top">Top</a></p>
|
||||
|
||||
## audit/types.proto
|
||||
|
||||
|
||||
<!-- end services -->
|
||||
|
||||
|
||||
<a name="neo.fs.v2.audit.DataAuditResult"></a>
|
||||
|
||||
### Message DataAuditResult
|
||||
DataAuditResult keeps record of conducted Data Audits. The detailed report is
|
||||
generated separately.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Data Audit Result format version. Effectively, the version of API library used to report DataAuditResult structure. |
|
||||
| audit_epoch | [fixed64](#fixed64) | | Epoch number when the Data Audit was conducted |
|
||||
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Container under audit |
|
||||
| public_key | [bytes](#bytes) | | Public key of the auditing InnerRing node in a binary format |
|
||||
| complete | [bool](#bool) | | Shows if Data Audit process was complete in time or if it was cancelled |
|
||||
| requests | [uint32](#uint32) | | Number of request done at PoR stage |
|
||||
| retries | [uint32](#uint32) | | Number of retries done at PoR stage |
|
||||
| pass_sg | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | List of Storage Groups that passed audit PoR stage |
|
||||
| fail_sg | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | List of Storage Groups that failed audit PoR stage |
|
||||
| hit | [uint32](#uint32) | | Number of sampled objects under the audit placed in an optimal way according to the containers placement policy when checking PoP |
|
||||
| miss | [uint32](#uint32) | | Number of sampled objects under the audit placed in suboptimal way according to the containers placement policy, but still at a satisfactory level when checking PoP |
|
||||
| fail | [uint32](#uint32) | | Number of sampled objects under the audit stored inconsistently with the placement policy or not found at all when checking PoP |
|
||||
| pass_nodes | [bytes](#bytes) | repeated | List of storage node public keys that passed at least one PDP |
|
||||
| fail_nodes | [bytes](#bytes) | repeated | List of storage node public keys that failed at least one PDP |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
<!-- end enums -->
|
||||
|
||||
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ Type | Java Type | Python Type |
|
||||
| ----------- | ----- | -------- | --------- | ----------- |
|
||||
| <a name="double" /> double | | double | double | float |
|
||||
| <a name="float" /> float | | float | float | float |
|
||||
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int |
|
||||
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long |
|
||||
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long |
|
||||
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long |
|
||||
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
|
||||
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
|
||||
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
|
||||
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
|
||||
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int |
|
||||
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long |
|
||||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
@ -6,21 +6,12 @@
|
|||
- [container/service.proto](#container/service.proto)
|
||||
- Services
|
||||
- [ContainerService](#neo.fs.v2.container.ContainerService)
|
||||
|
||||
|
||||
- Messages
|
||||
- [AnnounceUsedSpaceRequest](#neo.fs.v2.container.AnnounceUsedSpaceRequest)
|
||||
- [AnnounceUsedSpaceRequest.Body](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body)
|
||||
- [AnnounceUsedSpaceRequest.Body.Announcement](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body.Announcement)
|
||||
- [AnnounceUsedSpaceResponse](#neo.fs.v2.container.AnnounceUsedSpaceResponse)
|
||||
- [AnnounceUsedSpaceResponse.Body](#neo.fs.v2.container.AnnounceUsedSpaceResponse.Body)
|
||||
- [DeleteRequest](#neo.fs.v2.container.DeleteRequest)
|
||||
- [DeleteRequest.Body](#neo.fs.v2.container.DeleteRequest.Body)
|
||||
- [DeleteResponse](#neo.fs.v2.container.DeleteResponse)
|
||||
- [DeleteResponse.Body](#neo.fs.v2.container.DeleteResponse.Body)
|
||||
- [GetExtendedACLRequest](#neo.fs.v2.container.GetExtendedACLRequest)
|
||||
- [GetExtendedACLRequest.Body](#neo.fs.v2.container.GetExtendedACLRequest.Body)
|
||||
- [GetExtendedACLResponse](#neo.fs.v2.container.GetExtendedACLResponse)
|
||||
- [GetExtendedACLResponse.Body](#neo.fs.v2.container.GetExtendedACLResponse.Body)
|
||||
- [GetRequest](#neo.fs.v2.container.GetRequest)
|
||||
- [GetRequest.Body](#neo.fs.v2.container.GetRequest.Body)
|
||||
- [GetResponse](#neo.fs.v2.container.GetResponse)
|
||||
|
|
@ -33,18 +24,14 @@
|
|||
- [PutRequest.Body](#neo.fs.v2.container.PutRequest.Body)
|
||||
- [PutResponse](#neo.fs.v2.container.PutResponse)
|
||||
- [PutResponse.Body](#neo.fs.v2.container.PutResponse.Body)
|
||||
- [SetExtendedACLRequest](#neo.fs.v2.container.SetExtendedACLRequest)
|
||||
- [SetExtendedACLRequest.Body](#neo.fs.v2.container.SetExtendedACLRequest.Body)
|
||||
- [SetExtendedACLResponse](#neo.fs.v2.container.SetExtendedACLResponse)
|
||||
- [SetExtendedACLResponse.Body](#neo.fs.v2.container.SetExtendedACLResponse.Body)
|
||||
|
||||
|
||||
|
||||
- [container/types.proto](#container/types.proto)
|
||||
|
||||
- Messages
|
||||
- [Container](#neo.fs.v2.container.Container)
|
||||
- [Container.Attribute](#neo.fs.v2.container.Container.Attribute)
|
||||
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -62,8 +49,8 @@
|
|||
|
||||
### Service "neo.fs.v2.container.ContainerService"
|
||||
`ContainerService` provides API to interact with `Container` smart contract
|
||||
in NeoFS sidechain via other NeoFS nodes. All of those actions can be done
|
||||
equivalently by directly issuing transactions and RPC calls to sidechain
|
||||
in FrostFS sidechain via other FrostFS nodes. All of those actions can be
|
||||
done equivalently by directly issuing transactions and RPC calls to sidechain
|
||||
nodes.
|
||||
|
||||
```
|
||||
|
|
@ -71,9 +58,6 @@ rpc Put(PutRequest) returns (PutResponse);
|
|||
rpc Delete(DeleteRequest) returns (DeleteResponse);
|
||||
rpc Get(GetRequest) returns (GetResponse);
|
||||
rpc List(ListRequest) returns (ListResponse);
|
||||
rpc SetExtendedACL(SetExtendedACLRequest) returns (SetExtendedACLResponse);
|
||||
rpc GetExtendedACL(GetExtendedACLRequest) returns (GetExtendedACLResponse);
|
||||
rpc AnnounceUsedSpace(AnnounceUsedSpaceRequest) returns (AnnounceUsedSpaceResponse);
|
||||
|
||||
```
|
||||
|
||||
|
|
@ -141,114 +125,9 @@ Statuses:
|
|||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
| List | [ListRequest](#neo.fs.v2.container.ListRequest) | [ListResponse](#neo.fs.v2.container.ListResponse) |
|
||||
#### Method SetExtendedACL
|
||||
|
||||
Invokes 'SetEACL' method of 'Container` smart contract and returns response
|
||||
immediately. After one more block in sidechain, changes in an Extended ACL
|
||||
are added into smart contract storage.
|
||||
|
||||
Statuses:
|
||||
- **OK** (0, SECTION_SUCCESS): \
|
||||
request to save container eACL has been sent to the sidechain;
|
||||
- Common failures (SECTION_FAILURE_COMMON);
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
set container eACL access denied.
|
||||
|
||||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
| SetExtendedACL | [SetExtendedACLRequest](#neo.fs.v2.container.SetExtendedACLRequest) | [SetExtendedACLResponse](#neo.fs.v2.container.SetExtendedACLResponse) |
|
||||
#### Method GetExtendedACL
|
||||
|
||||
Returns Extended ACL table and signature from `Container` smart contract
|
||||
storage.
|
||||
|
||||
Statuses:
|
||||
- **OK** (0, SECTION_SUCCESS): \
|
||||
container eACL has been successfully read;
|
||||
- Common failures (SECTION_FAILURE_COMMON);
|
||||
- **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
container not found;
|
||||
- **EACL_NOT_FOUND** (3073, SECTION_CONTAINER): \
|
||||
eACL table not found;
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
access to container eACL is denied.
|
||||
|
||||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
| GetExtendedACL | [GetExtendedACLRequest](#neo.fs.v2.container.GetExtendedACLRequest) | [GetExtendedACLResponse](#neo.fs.v2.container.GetExtendedACLResponse) |
|
||||
#### Method AnnounceUsedSpace
|
||||
|
||||
Announces the space values used by the container for P2P synchronization.
|
||||
|
||||
Statuses:
|
||||
- **OK** (0, SECTION_SUCCESS): \
|
||||
estimation of used space has been successfully announced;
|
||||
- Common failures (SECTION_FAILURE_COMMON).
|
||||
|
||||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
| AnnounceUsedSpace | [AnnounceUsedSpaceRequest](#neo.fs.v2.container.AnnounceUsedSpaceRequest) | [AnnounceUsedSpaceResponse](#neo.fs.v2.container.AnnounceUsedSpaceResponse) |
|
||||
<!-- end services -->
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.AnnounceUsedSpaceRequest"></a>
|
||||
|
||||
### Message AnnounceUsedSpaceRequest
|
||||
Announce container used space
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [AnnounceUsedSpaceRequest.Body](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body) | | Body of announce used space request message. |
|
||||
| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.AnnounceUsedSpaceRequest.Body"></a>
|
||||
|
||||
### Message AnnounceUsedSpaceRequest.Body
|
||||
Container used space announcement body.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| announcements | [AnnounceUsedSpaceRequest.Body.Announcement](#neo.fs.v2.container.AnnounceUsedSpaceRequest.Body.Announcement) | repeated | List of announcements. If nodes share several containers, announcements are transferred in a batch. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.AnnounceUsedSpaceRequest.Body.Announcement"></a>
|
||||
|
||||
### Message AnnounceUsedSpaceRequest.Body.Announcement
|
||||
Announcement contains used space information for a single container.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| epoch | [uint64](#uint64) | | Epoch number for which the container size estimation was produced. |
|
||||
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Identifier of the container. |
|
||||
| used_space | [uint64](#uint64) | | Used space is a sum of object payload sizes of a specified container, stored in the node. It must not include inhumed objects. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.AnnounceUsedSpaceResponse"></a>
|
||||
|
||||
### Message AnnounceUsedSpaceResponse
|
||||
Announce container used space
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [AnnounceUsedSpaceResponse.Body](#neo.fs.v2.container.AnnounceUsedSpaceResponse.Body) | | Body of announce used space response message. |
|
||||
| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.AnnounceUsedSpaceResponse.Body"></a>
|
||||
|
||||
### Message AnnounceUsedSpaceResponse.Body
|
||||
`AnnounceUsedSpaceResponse` has an empty body because announcements are
|
||||
one way communication.
|
||||
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.DeleteRequest"></a>
|
||||
|
||||
### Message DeleteRequest
|
||||
|
|
@ -272,7 +151,7 @@ smart contract, so signing algorithm must be supported by NeoVM.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Identifier of the container to delete from NeoFS |
|
||||
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Identifier of the container to delete from FrostFS |
|
||||
| signature | [neo.fs.v2.refs.SignatureRFC6979](#neo.fs.v2.refs.SignatureRFC6979) | | `ContainerID` signed with the container owner's key according to RFC-6979. |
|
||||
|
||||
|
||||
|
|
@ -298,58 +177,6 @@ and done via consensus in Inner Ring nodes.
|
|||
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.GetExtendedACLRequest"></a>
|
||||
|
||||
### Message GetExtendedACLRequest
|
||||
Get Extended ACL
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [GetExtendedACLRequest.Body](#neo.fs.v2.container.GetExtendedACLRequest.Body) | | Body of get extended acl request message. |
|
||||
| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.GetExtendedACLRequest.Body"></a>
|
||||
|
||||
### Message GetExtendedACLRequest.Body
|
||||
Get Extended ACL request body
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Identifier of the container having Extended ACL |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.GetExtendedACLResponse"></a>
|
||||
|
||||
### Message GetExtendedACLResponse
|
||||
Get Extended ACL
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [GetExtendedACLResponse.Body](#neo.fs.v2.container.GetExtendedACLResponse.Body) | | Body of get extended acl response message. |
|
||||
| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.GetExtendedACLResponse.Body"></a>
|
||||
|
||||
### Message GetExtendedACLResponse.Body
|
||||
Get Extended ACL Response body can be empty if the requested container does
|
||||
not have Extended ACL Table attached or Extended ACL has not been allowed
|
||||
at the time of container creation.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| eacl | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) | | Extended ACL requested, if available |
|
||||
| signature | [neo.fs.v2.refs.SignatureRFC6979](#neo.fs.v2.refs.SignatureRFC6979) | | Signature of stable-marshalled Extended ACL according to RFC-6979. |
|
||||
| session_token | [neo.fs.v2.session.SessionToken](#neo.fs.v2.session.SessionToken) | | Session token if Extended ACL was set within a session |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.GetRequest"></a>
|
||||
|
||||
### Message GetRequest
|
||||
|
|
@ -452,7 +279,7 @@ List containers response body.
|
|||
<a name="neo.fs.v2.container.PutRequest"></a>
|
||||
|
||||
### Message PutRequest
|
||||
New NeoFS Container creation request
|
||||
New FrostFS Container creation request
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
|
|
@ -474,14 +301,14 @@ additional signature checks.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| container | [Container](#neo.fs.v2.container.Container) | | Container structure to register in NeoFS |
|
||||
| container | [Container](#neo.fs.v2.container.Container) | | Container structure to register in FrostFS |
|
||||
| signature | [neo.fs.v2.refs.SignatureRFC6979](#neo.fs.v2.refs.SignatureRFC6979) | | Signature of a stable-marshalled container according to RFC-6979. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.PutResponse"></a>
|
||||
|
||||
### Message PutResponse
|
||||
New NeoFS Container creation response
|
||||
New FrostFS Container creation response
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
|
|
@ -504,54 +331,6 @@ returned here to make sure everything has been done as expected.
|
|||
| ----- | ---- | ----- | ----------- |
|
||||
| container_id | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Unique identifier of the newly created container |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.SetExtendedACLRequest"></a>
|
||||
|
||||
### Message SetExtendedACLRequest
|
||||
Set Extended ACL
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [SetExtendedACLRequest.Body](#neo.fs.v2.container.SetExtendedACLRequest.Body) | | Body of set extended acl request message. |
|
||||
| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.SetExtendedACLRequest.Body"></a>
|
||||
|
||||
### Message SetExtendedACLRequest.Body
|
||||
Set Extended ACL request body does not have separate `ContainerID`
|
||||
reference. It will be taken from `EACLTable.container_id` field.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| eacl | [neo.fs.v2.acl.EACLTable](#neo.fs.v2.acl.EACLTable) | | Extended ACL table to set for the container |
|
||||
| signature | [neo.fs.v2.refs.SignatureRFC6979](#neo.fs.v2.refs.SignatureRFC6979) | | Signature of stable-marshalled Extended ACL table according to RFC-6979. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.SetExtendedACLResponse"></a>
|
||||
|
||||
### Message SetExtendedACLResponse
|
||||
Set Extended ACL
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [SetExtendedACLResponse.Body](#neo.fs.v2.container.SetExtendedACLResponse.Body) | | Body of set extended acl response message. |
|
||||
| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.container.SetExtendedACLResponse.Body"></a>
|
||||
|
||||
### Message SetExtendedACLResponse.Body
|
||||
`SetExtendedACLResponse` has an empty body because the operation is
|
||||
asynchronous and the update should be reflected in `Container` smart
|
||||
contract's storage after next block is issued in sidechain.
|
||||
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
<!-- end enums -->
|
||||
|
|
@ -612,7 +391,7 @@ There are some "well-known" attributes affecting system behaviour:
|
|||
(`__NEOFS__DISABLE_HOMOMORPHIC_HASHING` is deprecated) \
|
||||
Disables homomorphic hashing for the container if the value equals "true"
|
||||
string. Any other values are interpreted as missing attribute. Container
|
||||
could be accepted in a NeoFS network only if the global network hashing
|
||||
could be accepted in a FrostFS network only if the global network hashing
|
||||
configuration value corresponds with that attribute's value. After
|
||||
container inclusion, network setting is ignored.
|
||||
|
||||
|
|
@ -654,4 +433,3 @@ And some well-known attributes used by applications only:
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
- Messages
|
||||
- [Lock](#neo.fs.v2.lock.Lock)
|
||||
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -61,4 +61,3 @@ a lock object via ObjectService.Delete RPC call.
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
- [netmap/service.proto](#netmap/service.proto)
|
||||
- Services
|
||||
- [NetmapService](#neo.fs.v2.netmap.NetmapService)
|
||||
|
||||
|
||||
- Messages
|
||||
- [LocalNodeInfoRequest](#neo.fs.v2.netmap.LocalNodeInfoRequest)
|
||||
- [LocalNodeInfoRequest.Body](#neo.fs.v2.netmap.LocalNodeInfoRequest.Body)
|
||||
|
|
@ -20,7 +20,7 @@
|
|||
- [NetworkInfoRequest.Body](#neo.fs.v2.netmap.NetworkInfoRequest.Body)
|
||||
- [NetworkInfoResponse](#neo.fs.v2.netmap.NetworkInfoResponse)
|
||||
- [NetworkInfoResponse.Body](#neo.fs.v2.netmap.NetworkInfoResponse.Body)
|
||||
|
||||
|
||||
|
||||
- [netmap/types.proto](#netmap/types.proto)
|
||||
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
- [PlacementPolicy](#neo.fs.v2.netmap.PlacementPolicy)
|
||||
- [Replica](#neo.fs.v2.netmap.Replica)
|
||||
- [Selector](#neo.fs.v2.netmap.Selector)
|
||||
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -55,7 +55,7 @@
|
|||
`NetmapService` provides methods to work with `Network Map` and the
|
||||
information required to build it. The resulting `Network Map` is stored in
|
||||
sidechain `Netmap` smart contract, while related information can be obtained
|
||||
from other NeoFS nodes.
|
||||
from other FrostFS nodes.
|
||||
|
||||
```
|
||||
rpc LocalNodeInfo(LocalNodeInfoRequest) returns (LocalNodeInfoResponse);
|
||||
|
|
@ -83,7 +83,7 @@ information about the server has been successfully read;
|
|||
| LocalNodeInfo | [LocalNodeInfoRequest](#neo.fs.v2.netmap.LocalNodeInfoRequest) | [LocalNodeInfoResponse](#neo.fs.v2.netmap.LocalNodeInfoResponse) |
|
||||
#### Method NetworkInfo
|
||||
|
||||
Read recent information about the NeoFS network.
|
||||
Read recent information about the FrostFS network.
|
||||
|
||||
Statuses:
|
||||
- **OK** (0, SECTION_SUCCESS):
|
||||
|
|
@ -95,7 +95,7 @@ information about the current network state has been successfully read;
|
|||
| NetworkInfo | [NetworkInfoRequest](#neo.fs.v2.netmap.NetworkInfoRequest) | [NetworkInfoResponse](#neo.fs.v2.netmap.NetworkInfoResponse) |
|
||||
#### Method NetmapSnapshot
|
||||
|
||||
Returns network map snapshot of the current NeoFS epoch.
|
||||
Returns network map snapshot of the current FrostFS epoch.
|
||||
|
||||
Statuses:
|
||||
- **OK** (0, SECTION_SUCCESS):
|
||||
|
|
@ -149,7 +149,7 @@ Local Node Info, including API Version in use.
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Latest NeoFS API version in use |
|
||||
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Latest FrostFS API version in use |
|
||||
| node_info | [NodeInfo](#neo.fs.v2.netmap.NodeInfo) | | NodeInfo structure with recent information from node itself |
|
||||
|
||||
|
||||
|
|
@ -287,7 +287,7 @@ Network map structure
|
|||
<a name="neo.fs.v2.netmap.NetworkConfig"></a>
|
||||
|
||||
### Message NetworkConfig
|
||||
NeoFS network configuration
|
||||
FrostFS network configuration
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
|
|
@ -315,7 +315,7 @@ System parameters:
|
|||
Fee paid for container creation by the container owner.
|
||||
Value: little-endian integer. Default: 0.
|
||||
- **EpochDuration** \
|
||||
NeoFS epoch duration measured in Sidechain blocks.
|
||||
FrostFS epoch duration measured in Sidechain blocks.
|
||||
Value: little-endian integer. Default: 0.
|
||||
- **HomomorphicHashingDisabled** \
|
||||
Flag of disabling the homomorphic hashing of objects' payload.
|
||||
|
|
@ -327,8 +327,39 @@ System parameters:
|
|||
Flag allowing setting the MAINTENANCE state to storage nodes.
|
||||
Value: true if any byte != 0. Default: false.
|
||||
- **MaxObjectSize** \
|
||||
Maximum size of physically stored NeoFS object measured in bytes.
|
||||
Maximum size of physically stored FrostFS object measured in bytes.
|
||||
Value: little-endian integer. Default: 0.
|
||||
|
||||
This value refers to the maximum size of a **physically** stored object
|
||||
in FrostFS. However, from a user's perspective, the **logical** size of a
|
||||
stored object can be significantly larger. The relationship between the
|
||||
physical and logical object sizes is governed by the following formula
|
||||
|
||||
```math
|
||||
\mathrm{Stored\ Object\ Size} \le
|
||||
\frac{
|
||||
\left(\mathrm{Max\ Object\ Size}\right)^2
|
||||
}{
|
||||
\mathrm{Object\ ID\ Size}
|
||||
}
|
||||
```
|
||||
|
||||
This arises from the fact that a tombstone, also being an object, stores
|
||||
the IDs of inhumed objects and cannot be divided into smaller objects,
|
||||
thus having an upper limit for its size.
|
||||
|
||||
For example, if:
|
||||
* Max Object Size Size = 64 MiB;
|
||||
* Object ID Size = 32 B;
|
||||
|
||||
then:
|
||||
```math
|
||||
\mathrm{Stored\ Object\ Size} \le
|
||||
\frac{\left(64\ \mathrm{MiB}\right)^2}{32\ \mathrm{B}} =
|
||||
\frac{2^{52}}{2^5}\ \mathrm{B} =
|
||||
2^{47}\ \mathrm{B} =
|
||||
128\ \mathrm{TiB}
|
||||
```
|
||||
- **WithdrawFee** \
|
||||
Fee paid for withdrawal of funds paid by the account owner.
|
||||
Value: little-endian integer. Default: 0.
|
||||
|
|
@ -349,45 +380,45 @@ System parameters:
|
|||
<a name="neo.fs.v2.netmap.NetworkInfo"></a>
|
||||
|
||||
### Message NetworkInfo
|
||||
Information about NeoFS network
|
||||
Information about FrostFS network
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| current_epoch | [uint64](#uint64) | | Number of the current epoch in the NeoFS network |
|
||||
| magic_number | [uint64](#uint64) | | Magic number of the sidechain of the NeoFS network |
|
||||
| ms_per_block | [int64](#int64) | | MillisecondsPerBlock network parameter of the sidechain of the NeoFS network |
|
||||
| network_config | [NetworkConfig](#neo.fs.v2.netmap.NetworkConfig) | | NeoFS network configuration |
|
||||
| current_epoch | [uint64](#uint64) | | Number of the current epoch in the FrostFS network |
|
||||
| magic_number | [uint64](#uint64) | | Magic number of the sidechain of the FrostFS network |
|
||||
| ms_per_block | [int64](#int64) | | MillisecondsPerBlock network parameter of the sidechain of the FrostFS network |
|
||||
| network_config | [NetworkConfig](#neo.fs.v2.netmap.NetworkConfig) | | FrostFS network configuration |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.netmap.NodeInfo"></a>
|
||||
|
||||
### Message NodeInfo
|
||||
NeoFS node description
|
||||
FrostFS node description
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| public_key | [bytes](#bytes) | | Public key of the NeoFS node in a binary format |
|
||||
| public_key | [bytes](#bytes) | | Public key of the FrostFS node in a binary format |
|
||||
| addresses | [string](#string) | repeated | Ways to connect to a node |
|
||||
| attributes | [NodeInfo.Attribute](#neo.fs.v2.netmap.NodeInfo.Attribute) | repeated | Carries list of the NeoFS node attributes in a key-value form. Key name must be a node-unique valid UTF-8 string. Value can't be empty. NodeInfo structures with duplicated attribute names or attributes with empty values will be considered invalid. |
|
||||
| state | [NodeInfo.State](#neo.fs.v2.netmap.NodeInfo.State) | | Carries state of the NeoFS node |
|
||||
| attributes | [NodeInfo.Attribute](#neo.fs.v2.netmap.NodeInfo.Attribute) | repeated | Carries list of the FrostFS node attributes in a key-value form. Key name must be a node-unique valid UTF-8 string. Value can't be empty. NodeInfo structures with duplicated attribute names or attributes with empty values will be considered invalid. |
|
||||
| state | [NodeInfo.State](#neo.fs.v2.netmap.NodeInfo.State) | | Carries state of the FrostFS node |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.netmap.NodeInfo.Attribute"></a>
|
||||
|
||||
### Message NodeInfo.Attribute
|
||||
Administrator-defined Attributes of the NeoFS Storage Node.
|
||||
Administrator-defined Attributes of the FrostFS Storage Node.
|
||||
|
||||
`Attribute` is a Key-Value metadata pair. Key name must be a valid UTF-8
|
||||
string. Value can't be empty.
|
||||
|
||||
Attributes can be constructed into a chain of attributes: any attribute can
|
||||
have a parent attribute and a child attribute (except the first and the
|
||||
last one). A string representation of the chain of attributes in NeoFS
|
||||
last one). A string representation of the chain of attributes in FrostFS
|
||||
Storage Node configuration uses ":" and "/" symbols, e.g.:
|
||||
|
||||
`NEOFS_NODE_ATTRIBUTE_1=key1:val1/key2:val2`
|
||||
`FrostFS_NODE_ATTRIBUTE_1=key1:val1/key2:val2`
|
||||
|
||||
Therefore the string attribute representation in the Node configuration
|
||||
must use "\:", "\/" and "\\" escaped symbols if any of them appears in an
|
||||
|
|
@ -434,8 +465,8 @@ explicitly set:
|
|||
[ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). Calculated
|
||||
automatically from `UN-LOCODE` attribute.
|
||||
* Continent \
|
||||
Node's continent name according to the [Seven-Continent model]
|
||||
(https://en.wikipedia.org/wiki/Continent#Number). Calculated
|
||||
Node's continent name according to the [Seven-Continent
|
||||
model](https://en.wikipedia.org/wiki/Continent#Number). Calculated
|
||||
automatically from `UN-LOCODE` attribute.
|
||||
* ExternalAddr
|
||||
Node's preferred way for communications with external clients.
|
||||
|
|
@ -443,7 +474,7 @@ explicitly set:
|
|||
Must contain a comma-separated list of multi-addresses.
|
||||
|
||||
For detailed description of each well-known attribute please see the
|
||||
corresponding section in NeoFS Technical Specification.
|
||||
corresponding section in FrostFS Technical Specification.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
|
|
@ -464,7 +495,7 @@ storage policy definition languages.
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| replicas | [Replica](#neo.fs.v2.netmap.Replica) | repeated | Rules to set number of object replicas and place each one into a named bucket |
|
||||
| container_backup_factor | [uint32](#uint32) | | Container backup factor controls how deep NeoFS will search for nodes alternatives to include into container's nodes subset |
|
||||
| container_backup_factor | [uint32](#uint32) | | Container backup factor controls how deep FrostFS will search for nodes alternatives to include into container's nodes subset |
|
||||
| selectors | [Selector](#neo.fs.v2.netmap.Selector) | repeated | Set of Selectors to form the container's nodes subset |
|
||||
| filters | [Filter](#neo.fs.v2.netmap.Filter) | repeated | List of named filters to reference in selectors |
|
||||
| unique | [bool](#bool) | | Unique flag defines non-overlapping application for replicas |
|
||||
|
|
@ -522,7 +553,7 @@ hash distance.
|
|||
<a name="neo.fs.v2.netmap.NodeInfo.State"></a>
|
||||
|
||||
### NodeInfo.State
|
||||
Represents the enumeration of various states of the NeoFS node.
|
||||
Represents the enumeration of various states of the FrostFS node.
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
|
|
@ -550,6 +581,7 @@ Operations on filters
|
|||
| OR | 7 | Logical OR |
|
||||
| AND | 8 | Logical AND |
|
||||
| NOT | 9 | Logical negation |
|
||||
| LIKE | 10 | Matches pattern |
|
||||
|
||||
|
||||
<!-- end enums -->
|
||||
|
|
@ -575,4 +607,3 @@ Operations on filters
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
- [object/service.proto](#object/service.proto)
|
||||
- Services
|
||||
- [ObjectService](#neo.fs.v2.object.ObjectService)
|
||||
|
||||
|
||||
- Messages
|
||||
- [DeleteRequest](#neo.fs.v2.object.DeleteRequest)
|
||||
- [DeleteRequest.Body](#neo.fs.v2.object.DeleteRequest.Body)
|
||||
|
|
@ -30,6 +30,11 @@
|
|||
- [HeadResponse](#neo.fs.v2.object.HeadResponse)
|
||||
- [HeadResponse.Body](#neo.fs.v2.object.HeadResponse.Body)
|
||||
- [HeaderWithSignature](#neo.fs.v2.object.HeaderWithSignature)
|
||||
- [PatchRequest](#neo.fs.v2.object.PatchRequest)
|
||||
- [PatchRequest.Body](#neo.fs.v2.object.PatchRequest.Body)
|
||||
- [PatchRequest.Body.Patch](#neo.fs.v2.object.PatchRequest.Body.Patch)
|
||||
- [PatchResponse](#neo.fs.v2.object.PatchResponse)
|
||||
- [PatchResponse.Body](#neo.fs.v2.object.PatchResponse.Body)
|
||||
- [PutRequest](#neo.fs.v2.object.PutRequest)
|
||||
- [PutRequest.Body](#neo.fs.v2.object.PutRequest.Body)
|
||||
- [PutRequest.Body.Init](#neo.fs.v2.object.PutRequest.Body.Init)
|
||||
|
|
@ -45,7 +50,7 @@
|
|||
- [SearchRequest.Body.Filter](#neo.fs.v2.object.SearchRequest.Body.Filter)
|
||||
- [SearchResponse](#neo.fs.v2.object.SearchResponse)
|
||||
- [SearchResponse.Body](#neo.fs.v2.object.SearchResponse.Body)
|
||||
|
||||
|
||||
|
||||
- [object/types.proto](#object/types.proto)
|
||||
|
||||
|
|
@ -59,7 +64,7 @@
|
|||
- [Object](#neo.fs.v2.object.Object)
|
||||
- [ShortHeader](#neo.fs.v2.object.ShortHeader)
|
||||
- [SplitInfo](#neo.fs.v2.object.SplitInfo)
|
||||
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -88,6 +93,7 @@ rpc Search(SearchRequest) returns (stream SearchResponse);
|
|||
rpc GetRange(GetRangeRequest) returns (stream GetRangeResponse);
|
||||
rpc GetRangeHash(GetRangeHashRequest) returns (GetRangeHashResponse);
|
||||
rpc PutSingle(PutSingleRequest) returns (PutSingleResponse);
|
||||
rpc Patch(stream PatchRequest) returns (PatchResponse);
|
||||
|
||||
```
|
||||
|
||||
|
|
@ -127,7 +133,7 @@ Statuses:
|
|||
- **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
object container not found;
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
access to container is denied;
|
||||
access to container is denied;
|
||||
- **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
provided session token has expired.
|
||||
|
||||
|
|
@ -204,7 +210,7 @@ Statuses:
|
|||
- **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
object container not found;
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
access to container is denied;
|
||||
access to container is denied;
|
||||
- **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
provided session token has expired.
|
||||
|
||||
|
|
@ -238,7 +244,7 @@ Statuses:
|
|||
- **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
object container not found;
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
access to container is denied;
|
||||
access to container is denied;
|
||||
- **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
provided session token has expired.
|
||||
|
||||
|
|
@ -248,7 +254,7 @@ Statuses:
|
|||
#### Method Search
|
||||
|
||||
Search objects in container. Search query allows to match by Object
|
||||
Header's filed values. Please see the corresponding NeoFS Technical
|
||||
Header's filed values. Please see the corresponding FrostFS Technical
|
||||
Specification section for more details.
|
||||
|
||||
Extended headers can change `Search` behaviour:
|
||||
|
|
@ -268,7 +274,7 @@ Statuses:
|
|||
- **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
search container not found;
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
access to container is denied;
|
||||
access to container is denied;
|
||||
- **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
provided session token has expired.
|
||||
|
||||
|
|
@ -309,7 +315,7 @@ Statuses:
|
|||
- **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
object container not found;
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
access to container is denied;
|
||||
access to container is denied;
|
||||
- **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
provided session token has expired.
|
||||
|
||||
|
|
@ -348,7 +354,7 @@ Statuses:
|
|||
- **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
object container not found;
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
access to container is denied;
|
||||
access to container is denied;
|
||||
- **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
provided session token has expired.
|
||||
|
||||
|
|
@ -384,7 +390,7 @@ Statuses:
|
|||
- **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
object storage container not found;
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
access to container is denied;
|
||||
access to container is denied;
|
||||
- **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
|
||||
(for trusted object preparation) session private key does not exist or
|
||||
has
|
||||
|
|
@ -395,6 +401,59 @@ been deleted;
|
|||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
| PutSingle | [PutSingleRequest](#neo.fs.v2.object.PutSingleRequest) | [PutSingleResponse](#neo.fs.v2.object.PutSingleResponse) |
|
||||
#### Method Patch
|
||||
|
||||
Patch the object. Request uses gRPC stream. First message must set
|
||||
the address of the object that is going to get patched. If the object's
|
||||
attributes are patched, then these attrubutes must be set only within the
|
||||
first stream message.
|
||||
|
||||
If the patch request is performed by NOT the object's owner but if the
|
||||
actor has the permission to perform the patch, then `OwnerID` of the object
|
||||
is changed. In this case the object's owner loses the object's ownership
|
||||
after the patch request is successfully done.
|
||||
|
||||
As objects are content-addressable the patching causes new object ID
|
||||
generation for the patched object. This object id is set witihn
|
||||
`PatchResponse`. But the object id may remain unchanged in such cases:
|
||||
1. The chunk of the applying patch contains the same value as the object's
|
||||
payload within the same range;
|
||||
2. The patch that reverts the changes applied by preceding patch;
|
||||
3. The application of the same patches for the object a few times.
|
||||
|
||||
Extended headers can change `Patch` behaviour:
|
||||
* [ __SYSTEM__NETMAP_EPOCH \
|
||||
(`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||
Will use the requsted version of Network Map for object placement
|
||||
calculation.
|
||||
|
||||
Please refer to detailed `XHeader` description.
|
||||
|
||||
Statuses:
|
||||
- **OK** (0, SECTION_SUCCESS): \
|
||||
object has been successfully patched and saved in the container;
|
||||
- Common failures (SECTION_FAILURE_COMMON);
|
||||
- **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||
write access to the container is denied;
|
||||
- **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
||||
object not found in container;
|
||||
- **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
||||
the requested object has been marked as deleted.
|
||||
- **OUT_OF_RANGE** (2053, SECTION_OBJECT): \
|
||||
the requested range is out of bounds;
|
||||
- **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||
object storage container not found;
|
||||
- **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
access to container is denied;
|
||||
- **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
|
||||
(for trusted object preparation) session private key does not exist or
|
||||
has been deleted;
|
||||
- **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||
provided session token has expired.
|
||||
|
||||
| Name | Input | Output |
|
||||
| ---- | ----- | ------ |
|
||||
| Patch | [PatchRequest](#neo.fs.v2.object.PatchRequest) | [PatchResponse](#neo.fs.v2.object.PatchResponse) |
|
||||
<!-- end services -->
|
||||
|
||||
|
||||
|
|
@ -691,6 +750,71 @@ following steps:
|
|||
| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Signed `ObjectID` to verify full header's authenticity |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.PatchRequest"></a>
|
||||
|
||||
### Message PatchRequest
|
||||
Object PATCH request
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [PatchRequest.Body](#neo.fs.v2.object.PatchRequest.Body) | | Body for patch request message. |
|
||||
| meta_header | [neo.fs.v2.session.RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | Carries request meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [neo.fs.v2.session.RequestVerificationHeader](#neo.fs.v2.session.RequestVerificationHeader) | | Carries request verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.PatchRequest.Body"></a>
|
||||
|
||||
### Message PatchRequest.Body
|
||||
PATCH request body
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| address | [neo.fs.v2.refs.Address](#neo.fs.v2.refs.Address) | | The address of the object that is requested to get patched. |
|
||||
| new_attributes | [Header.Attribute](#neo.fs.v2.object.Header.Attribute) | repeated | New attributes for the object. See `replace_attributes` flag usage to define how new attributes should be set. |
|
||||
| replace_attributes | [bool](#bool) | | If this flag is set, then the object's attributes will be entirely replaced by `new_attributes` list. The empty `new_attributes` list with `replace_attributes = true` just resets attributes list for the object.
|
||||
|
||||
Default `false` value for this flag means the attributes will be just merged. If the incoming `new_attributes` list contains already existing key, then it just replaces it while merging the lists. |
|
||||
| patch | [PatchRequest.Body.Patch](#neo.fs.v2.object.PatchRequest.Body.Patch) | | The patch that is applied for the object. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.PatchRequest.Body.Patch"></a>
|
||||
|
||||
### Message PatchRequest.Body.Patch
|
||||
The patch for the object's payload.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| source_range | [Range](#neo.fs.v2.object.Range) | | The range of the source object for which the payload is replaced by the patch's chunk. If the range's `length = 0`, then the patch's chunk is just appended to the original payload starting from the `offest` without any replace. |
|
||||
| chunk | [bytes](#bytes) | | The chunk that is being appended to or that replaces the original payload on the given range. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.PatchResponse"></a>
|
||||
|
||||
### Message PatchResponse
|
||||
Object PATCH response
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [PatchResponse.Body](#neo.fs.v2.object.PatchResponse.Body) | | Body for patch response message. |
|
||||
| meta_header | [neo.fs.v2.session.ResponseMetaHeader](#neo.fs.v2.session.ResponseMetaHeader) | | Carries response meta information. Header data is used only to regulate message transport and does not affect request execution. |
|
||||
| verify_header | [neo.fs.v2.session.ResponseVerificationHeader](#neo.fs.v2.session.ResponseVerificationHeader) | | Carries response verification information. This header is used to authenticate the nodes of the message route and check the correctness of transmission. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.PatchResponse.Body"></a>
|
||||
|
||||
### Message PatchResponse.Body
|
||||
PATCH response body
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| object_id | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | The object ID of the saved patched object. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.PutRequest"></a>
|
||||
|
||||
### Message PutRequest
|
||||
|
|
@ -876,8 +1000,8 @@ prefix to the name. Here is the list of fields available via this prefix:
|
|||
* $Object:split.splitID \
|
||||
16 byte UUIDv4 used to identify the split object hierarchy parts
|
||||
* $Object:ec.parent \
|
||||
If the object is stored according to EC policy, then ec_parent attribute
|
||||
is set to return an id list of all related EC chunks.
|
||||
If the object is stored according to EC policy, then ec_parent
|
||||
attribute is set to return an id list of all related EC chunks.
|
||||
|
||||
There are some well-known filter aliases to match objects by certain
|
||||
properties:
|
||||
|
|
@ -1040,7 +1164,7 @@ And some well-known attributes used by applications only:
|
|||
MIME Content Type of object's payload
|
||||
|
||||
For detailed description of each well-known attribute please see the
|
||||
corresponding section in NeoFS Technical Specification.
|
||||
corresponding section in FrostFS Technical Specification.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
|
|
@ -1065,7 +1189,8 @@ All objects belonging to a single EC group have the same `parent` field.
|
|||
| header_length | [uint32](#uint32) | | Total length of a parent header. Used to trim padding zeroes. |
|
||||
| header | [bytes](#bytes) | | Chunk of a parent header. |
|
||||
| parent_split_id | [bytes](#bytes) | | As the origin object is EC-splitted its identifier is known to all chunks as parent. But parent itself can be a part of Split (does not relate to EC-split). In this case parent_split_id should be set. |
|
||||
| parent_split_parent_id | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | EC-parent's parent ID. parent_split_parent_id is set if EC-parent, itself, is a part of Split and if an object ID of its parent is presented.The field allows to determine how EC-chunk is placed in Split hierarchy. |
|
||||
| parent_split_parent_id | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | | EC-parent's parent ID. parent_split_parent_id is set if EC-parent, itself, is a part of Split and if an object ID of its parent is presented. The field allows to determine how EC-chunk is placed in Split hierarchy. |
|
||||
| parent_attributes | [Header.Attribute](#neo.fs.v2.object.Header.Attribute) | repeated | EC parent's attributes. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.object.Header.Split"></a>
|
||||
|
|
@ -1198,4 +1323,3 @@ String presentation of object type is the same as definition:
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
- [Signature](#neo.fs.v2.refs.Signature)
|
||||
- [SignatureRFC6979](#neo.fs.v2.refs.SignatureRFC6979)
|
||||
- [Version](#neo.fs.v2.refs.Version)
|
||||
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
<a name="neo.fs.v2.refs.Address"></a>
|
||||
|
||||
### Message Address
|
||||
Objects in NeoFS are addressed by their ContainerID and ObjectID.
|
||||
Objects in FrostFS are addressed by their ContainerID and ObjectID.
|
||||
|
||||
String presentation of `Address` is a concatenation of string encoded
|
||||
`ContainerID` and `ObjectID` delimited by '/' character.
|
||||
|
|
@ -65,7 +65,7 @@ Depending on checksum algorithm type, the string presentation may vary:
|
|||
<a name="neo.fs.v2.refs.ContainerID"></a>
|
||||
|
||||
### Message ContainerID
|
||||
NeoFS container identifier. Container structures are immutable and
|
||||
FrostFS container identifier. Container structures are immutable and
|
||||
content-addressed.
|
||||
|
||||
`ContainerID` is a 32 byte long
|
||||
|
|
@ -90,8 +90,9 @@ with/without paddings are accepted.
|
|||
<a name="neo.fs.v2.refs.ObjectID"></a>
|
||||
|
||||
### Message ObjectID
|
||||
NeoFS Object unique identifier. Objects are immutable and content-addressed.
|
||||
It means `ObjectID` will change if the `header` or the `payload` changes.
|
||||
FrostFS Object unique identifier. Objects are immutable and
|
||||
content-addressed. It means `ObjectID` will change if the `header` or the
|
||||
`payload` changes.
|
||||
|
||||
`ObjectID` is a 32 byte long
|
||||
[SHA256](https://csrc.nist.gov/publications/detail/fips/180/4/final) hash of
|
||||
|
|
@ -141,7 +142,7 @@ with/without paddings are accepted.
|
|||
<a name="neo.fs.v2.refs.Signature"></a>
|
||||
|
||||
### Message Signature
|
||||
Signature of something in NeoFS.
|
||||
Signature of something in FrostFS.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
|
|
@ -230,4 +231,3 @@ pair.
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -1,125 +0,0 @@
|
|||
# Protocol Documentation
|
||||
<a name="top"></a>
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [service/types.proto](#service/types.proto)
|
||||
|
||||
- Messages
|
||||
- [RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader)
|
||||
- [RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader)
|
||||
- [ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader)
|
||||
- [ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader)
|
||||
- [XHeader](#neo.fs.v2.service.XHeader)
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
||||
|
||||
<a name="service/types.proto"></a>
|
||||
<p align="right"><a href="#top">Top</a></p>
|
||||
|
||||
## service/types.proto
|
||||
|
||||
|
||||
<!-- end services -->
|
||||
|
||||
|
||||
<a name="neo.fs.v2.service.RequestMetaHeader"></a>
|
||||
|
||||
### Message RequestMetaHeader
|
||||
Information about the request
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Client API version. |
|
||||
| epoch | [uint64](#uint64) | | Client local epoch number. Set to 0 if unknown. |
|
||||
| ttl | [uint32](#uint32) | | Maximum number of nodes in the request route. |
|
||||
| x_headers | [XHeader](#neo.fs.v2.service.XHeader) | repeated | Request X-Headers. |
|
||||
| session_token | [neo.fs.v2.session.SessionToken](#neo.fs.v2.session.SessionToken) | | Token is a token of the session within which the request is sent |
|
||||
| bearer_token | [neo.fs.v2.acl.BearerToken](#neo.fs.v2.acl.BearerToken) | | Bearer is a Bearer token of the request |
|
||||
| origin | [RequestMetaHeader](#neo.fs.v2.service.RequestMetaHeader) | | RequestMetaHeader of the origin request. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.service.RequestVerificationHeader"></a>
|
||||
|
||||
### Message RequestVerificationHeader
|
||||
Verification info for request signed by all intermediate nodes
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body_signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Request Body signature. Should be generated once by request initiator. |
|
||||
| meta_signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Request Meta signature is added and signed by any intermediate node |
|
||||
| origin_signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Sign previous hops |
|
||||
| origin | [RequestVerificationHeader](#neo.fs.v2.service.RequestVerificationHeader) | | Chain of previous hops signatures |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.service.ResponseMetaHeader"></a>
|
||||
|
||||
### Message ResponseMetaHeader
|
||||
Information about the response
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| version | [neo.fs.v2.refs.Version](#neo.fs.v2.refs.Version) | | Server API version. |
|
||||
| epoch | [uint64](#uint64) | | Server local epoch number. |
|
||||
| ttl | [uint32](#uint32) | | Maximum number of nodes in the response route. |
|
||||
| x_headers | [XHeader](#neo.fs.v2.service.XHeader) | repeated | Response X-Headers. |
|
||||
| origin | [ResponseMetaHeader](#neo.fs.v2.service.ResponseMetaHeader) | | Carries response meta header of the origin response. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.service.ResponseVerificationHeader"></a>
|
||||
|
||||
### Message ResponseVerificationHeader
|
||||
Verification info for response signed by all intermediate nodes
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body_signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Response Body signature. Should be generated once by answering node. |
|
||||
| meta_signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Response Meta signature is added and signed by any intermediate node |
|
||||
| origin_signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Sign previous hops |
|
||||
| origin | [ResponseVerificationHeader](#neo.fs.v2.service.ResponseVerificationHeader) | | Chain of previous hops signatures |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.service.XHeader"></a>
|
||||
|
||||
### Message XHeader
|
||||
Extended headers for Request/Response
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| key | [string](#string) | | Key of the X-Header. |
|
||||
| value | [string](#string) | | Value of the X-Header. |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
<!-- end enums -->
|
||||
|
||||
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ Type | Java Type | Python Type |
|
||||
| ----------- | ----- | -------- | --------- | ----------- |
|
||||
| <a name="double" /> double | | double | double | float |
|
||||
| <a name="float" /> float | | float | float | float |
|
||||
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int |
|
||||
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long |
|
||||
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long |
|
||||
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long |
|
||||
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
|
||||
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
|
||||
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
|
||||
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
|
||||
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int |
|
||||
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long |
|
||||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
@ -6,13 +6,13 @@
|
|||
- [session/service.proto](#session/service.proto)
|
||||
- Services
|
||||
- [SessionService](#neo.fs.v2.session.SessionService)
|
||||
|
||||
|
||||
- Messages
|
||||
- [CreateRequest](#neo.fs.v2.session.CreateRequest)
|
||||
- [CreateRequest.Body](#neo.fs.v2.session.CreateRequest.Body)
|
||||
- [CreateResponse](#neo.fs.v2.session.CreateResponse)
|
||||
- [CreateResponse.Body](#neo.fs.v2.session.CreateResponse.Body)
|
||||
|
||||
|
||||
|
||||
- [session/types.proto](#session/types.proto)
|
||||
|
||||
|
|
@ -28,7 +28,7 @@
|
|||
- [SessionToken.Body](#neo.fs.v2.session.SessionToken.Body)
|
||||
- [SessionToken.Body.TokenLifetime](#neo.fs.v2.session.SessionToken.Body.TokenLifetime)
|
||||
- [XHeader](#neo.fs.v2.session.XHeader)
|
||||
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -48,7 +48,7 @@
|
|||
`SessionService` allows to establish a temporary trust relationship between
|
||||
two peer nodes and generate a `SessionToken` as the proof of trust to be
|
||||
attached in requests for further verification. Please see corresponding
|
||||
section of NeoFS Technical Specification for details.
|
||||
section of FrostFS Technical Specification for details.
|
||||
|
||||
```
|
||||
rpc Create(CreateRequest) returns (CreateResponse);
|
||||
|
|
@ -168,7 +168,7 @@ Carries objects involved in the object session.
|
|||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| container | [neo.fs.v2.refs.ContainerID](#neo.fs.v2.refs.ContainerID) | | Indicates which container the session is spread to. Field MUST be set and correct. |
|
||||
| objects | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | Indicates which objects the session is spread to. Objects are expected to be stored in the NeoFS container referenced by `container` field. Each element MUST have correct format. |
|
||||
| objects | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | Indicates which objects the session is spread to. Objects are expected to be stored in the FrostFS container referenced by `container` field. Each element MUST have correct format. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.session.RequestMetaHeader"></a>
|
||||
|
|
@ -187,7 +187,7 @@ request meta headers are folded in matryoshka style.
|
|||
| session_token | [SessionToken](#neo.fs.v2.session.SessionToken) | | Session token within which the request is sent |
|
||||
| bearer_token | [neo.fs.v2.acl.BearerToken](#neo.fs.v2.acl.BearerToken) | | `BearerToken` with eACL overrides for the request |
|
||||
| origin | [RequestMetaHeader](#neo.fs.v2.session.RequestMetaHeader) | | `RequestMetaHeader` of the origin request |
|
||||
| magic_number | [uint64](#uint64) | | NeoFS network magic. Must match the value for the network that the server belongs to. |
|
||||
| magic_number | [uint64](#uint64) | | FrostFS network magic. Must match the value for the network that the server belongs to. |
|
||||
|
||||
|
||||
<a name="neo.fs.v2.session.RequestVerificationHeader"></a>
|
||||
|
|
@ -237,12 +237,12 @@ Verification info for the response signed by all intermediate nodes
|
|||
<a name="neo.fs.v2.session.SessionToken"></a>
|
||||
|
||||
### Message SessionToken
|
||||
NeoFS Session Token.
|
||||
FrostFS Session Token.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| body | [SessionToken.Body](#neo.fs.v2.session.SessionToken.Body) | | Session Token contains the proof of trust between peers to be attached in requests for further verification. Please see corresponding section of NeoFS Technical Specification for details. |
|
||||
| body | [SessionToken.Body](#neo.fs.v2.session.SessionToken.Body) | | Session Token contains the proof of trust between peers to be attached in requests for further verification. Please see corresponding section of FrostFS Technical Specification for details. |
|
||||
| signature | [neo.fs.v2.refs.Signature](#neo.fs.v2.refs.Signature) | | Signature of `SessionToken` information |
|
||||
|
||||
|
||||
|
|
@ -338,6 +338,7 @@ Object request verbs
|
|||
| DELETE | 5 | Refers to object.Delete RPC call |
|
||||
| RANGE | 6 | Refers to object.GetRange RPC call |
|
||||
| RANGEHASH | 7 | Refers to object.GetRangeHash RPC call |
|
||||
| PATCH | 8 | Refers to object.Patch RPC call |
|
||||
|
||||
|
||||
<!-- end enums -->
|
||||
|
|
@ -363,4 +364,3 @@ Object request verbs
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
- Messages
|
||||
- [Status](#neo.fs.v2.status.Status)
|
||||
- [Status.Detail](#neo.fs.v2.status.Status.Detail)
|
||||
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -26,12 +26,12 @@
|
|||
<a name="neo.fs.v2.status.Status"></a>
|
||||
|
||||
### Message Status
|
||||
Declares the general format of the status returns of the NeoFS RPC protocol.
|
||||
Status is present in all response messages. Each RPC of NeoFS protocol
|
||||
describes the possible outcomes and details of the operation.
|
||||
Declares the general format of the status returns of the FrostFS RPC
|
||||
protocol. Status is present in all response messages. Each RPC of FrostFS
|
||||
protocol describes the possible outcomes and details of the operation.
|
||||
|
||||
Each status is assigned a one-to-one numeric code. Any unique result of an
|
||||
operation in NeoFS is unambiguously associated with the code value.
|
||||
operation in FrostFS is unambiguously associated with the code value.
|
||||
|
||||
Numerical set of codes is split into 1024-element sections. An enumeration
|
||||
is defined for each section. Values can be referred to in the following ways:
|
||||
|
|
@ -98,9 +98,10 @@ Section of failed statuses independent of the operation.
|
|||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| INTERNAL | 0 | [**1024**] Internal server error, default failure. Not detailed. If the server cannot match failed outcome to the code, it should use this code. |
|
||||
| WRONG_MAGIC_NUMBER | 1 | [**1025**] Wrong magic of the NeoFS network. Details: - [**0**] Magic number of the served NeoFS network (big-endian 64-bit unsigned integer). |
|
||||
| WRONG_MAGIC_NUMBER | 1 | [**1025**] Wrong magic of the FrostFS network. Details: - [**0**] Magic number of the served FrostFS network (big-endian 64-bit unsigned integer). |
|
||||
| SIGNATURE_VERIFICATION_FAIL | 2 | [**1026**] Signature verification failure. |
|
||||
| NODE_UNDER_MAINTENANCE | 3 | [**1027**] Node is under maintenance. |
|
||||
| INVALID_ARGUMENT | 4 | [**1028**] Invalid argument error. If the server fails on validation of a request parameter as the client sent it incorrectly, then this code should be used. |
|
||||
|
||||
|
||||
|
||||
|
|
@ -164,7 +165,7 @@ Section of statuses for session-related operations.
|
|||
<a name="neo.fs.v2.status.Success"></a>
|
||||
|
||||
### Success
|
||||
Section of NeoFS successful return codes.
|
||||
Section of FrostFS successful return codes.
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
|
|
@ -194,4 +195,3 @@ Section of NeoFS successful return codes.
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -1,71 +0,0 @@
|
|||
# Protocol Documentation
|
||||
<a name="top"></a>
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [storagegroup/types.proto](#storagegroup/types.proto)
|
||||
|
||||
- Messages
|
||||
- [StorageGroup](#neo.fs.v2.storagegroup.StorageGroup)
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
||||
|
||||
<a name="storagegroup/types.proto"></a>
|
||||
<p align="right"><a href="#top">Top</a></p>
|
||||
|
||||
## storagegroup/types.proto
|
||||
|
||||
|
||||
<!-- end services -->
|
||||
|
||||
|
||||
<a name="neo.fs.v2.storagegroup.StorageGroup"></a>
|
||||
|
||||
### Message StorageGroup
|
||||
StorageGroup keeps verification information for Data Audit sessions. Objects
|
||||
that require paid storage guarantees are gathered in `StorageGroups` with
|
||||
additional information used for the proof of storage. `StorageGroup` only
|
||||
contains objects from the same container.
|
||||
|
||||
Being an object payload, StorageGroup may have expiration Epoch set with
|
||||
`__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated) well-known attribute. When expired, StorageGroup
|
||||
will be ignored by InnerRing nodes during Data Audit cycles and will be
|
||||
deleted by Storage Nodes.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| validation_data_size | [uint64](#uint64) | | Total size of the payloads of objects in the storage group |
|
||||
| validation_hash | [neo.fs.v2.refs.Checksum](#neo.fs.v2.refs.Checksum) | | Homomorphic hash from the concatenation of the payloads of the storage group members. The order of concatenation is the same as the order of the members in the `members` field. |
|
||||
| expiration_epoch | [uint64](#uint64) | | DEPRECATED. Last NeoFS epoch number of the storage group lifetime |
|
||||
| members | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | Strictly ordered list of storage group member objects. Members MUST be unique |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
<!-- end enums -->
|
||||
|
||||
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ Type | Java Type | Python Type |
|
||||
| ----------- | ----- | -------- | --------- | ----------- |
|
||||
| <a name="double" /> double | | double | double | float |
|
||||
| <a name="float" /> float | | float | float | float |
|
||||
| <a name="int32" /> int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int |
|
||||
| <a name="int64" /> int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long |
|
||||
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long |
|
||||
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long |
|
||||
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
|
||||
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
|
||||
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
|
||||
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
|
||||
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int |
|
||||
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long |
|
||||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
- Messages
|
||||
- [Tombstone](#neo.fs.v2.tombstone.Tombstone)
|
||||
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
|
@ -26,12 +26,12 @@
|
|||
|
||||
### Message Tombstone
|
||||
Tombstone keeps record of deleted objects for a few epochs until they are
|
||||
purged from the NeoFS network.
|
||||
purged from the FrostFS network.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| expiration_epoch | [uint64](#uint64) | | Last NeoFS epoch number of the tombstone lifetime. It's set by the tombstone creator depending on the current NeoFS network settings. A tombstone object must have the same expiration epoch value in `__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated) attribute. Otherwise, the tombstone will be rejected by a storage node. |
|
||||
| expiration_epoch | [uint64](#uint64) | | Last FrostFS epoch number of the tombstone lifetime. It's set by the tombstone creator depending on the current FrostFS network settings. A tombstone object must have the same expiration epoch value in `__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated) attribute. Otherwise, the tombstone will be rejected by a storage node. |
|
||||
| split_id | [bytes](#bytes) | | 16 byte UUID used to identify the split object hierarchy parts. Must be unique inside a container. All objects participating in the split must have the same `split_id` value. |
|
||||
| members | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | List of objects to be deleted. |
|
||||
|
||||
|
|
@ -60,4 +60,3 @@ purged from the NeoFS network.
|
|||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ package neo.fs.v2.refs;
|
|||
option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/refs/grpc;refs";
|
||||
option csharp_namespace = "Neo.FileStorage.API.Refs";
|
||||
|
||||
// Objects in NeoFS are addressed by their ContainerID and ObjectID.
|
||||
// Objects in FrostFS are addressed by their ContainerID and ObjectID.
|
||||
//
|
||||
// String presentation of `Address` is a concatenation of string encoded
|
||||
// `ContainerID` and `ObjectID` delimited by '/' character.
|
||||
|
|
@ -16,8 +16,9 @@ message Address {
|
|||
ObjectID object_id = 2 [ json_name = "objectID" ];
|
||||
}
|
||||
|
||||
// NeoFS Object unique identifier. Objects are immutable and content-addressed.
|
||||
// It means `ObjectID` will change if the `header` or the `payload` changes.
|
||||
// FrostFS Object unique identifier. Objects are immutable and
|
||||
// content-addressed. It means `ObjectID` will change if the `header` or the
|
||||
// `payload` changes.
|
||||
//
|
||||
// `ObjectID` is a 32 byte long
|
||||
// [SHA256](https://csrc.nist.gov/publications/detail/fips/180/4/final) hash of
|
||||
|
|
@ -37,7 +38,7 @@ message ObjectID {
|
|||
bytes value = 1 [ json_name = "value" ];
|
||||
}
|
||||
|
||||
// NeoFS container identifier. Container structures are immutable and
|
||||
// FrostFS container identifier. Container structures are immutable and
|
||||
// content-addressed.
|
||||
//
|
||||
// `ContainerID` is a 32 byte long
|
||||
|
|
@ -90,7 +91,7 @@ message Version {
|
|||
uint32 minor = 2 [ json_name = "minor" ];
|
||||
}
|
||||
|
||||
// Signature of something in NeoFS.
|
||||
// Signature of something in FrostFS.
|
||||
message Signature {
|
||||
// Public key used for signing
|
||||
bytes key = 1 [ json_name = "key" ];
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ import "session/types.proto";
|
|||
// `SessionService` allows to establish a temporary trust relationship between
|
||||
// two peer nodes and generate a `SessionToken` as the proof of trust to be
|
||||
// attached in requests for further verification. Please see corresponding
|
||||
// section of NeoFS Technical Specification for details.
|
||||
// section of FrostFS Technical Specification for details.
|
||||
service SessionService {
|
||||
// Open a new session between two peers.
|
||||
//
|
||||
|
|
|
|||
|
|
@ -36,6 +36,9 @@ message ObjectSessionContext {
|
|||
|
||||
// Refers to object.GetRangeHash RPC call
|
||||
RANGEHASH = 7;
|
||||
|
||||
// Refers to object.Patch RPC call
|
||||
PATCH = 8;
|
||||
}
|
||||
// Type of request for which the token is issued
|
||||
Verb verb = 1 [ json_name = "verb" ];
|
||||
|
|
@ -47,7 +50,7 @@ message ObjectSessionContext {
|
|||
refs.ContainerID container = 1 [ json_name = "container" ];
|
||||
|
||||
// Indicates which objects the session is spread to. Objects are expected
|
||||
// to be stored in the NeoFS container referenced by `container` field.
|
||||
// to be stored in the FrostFS container referenced by `container` field.
|
||||
// Each element MUST have correct format.
|
||||
repeated refs.ObjectID objects = 2 [ json_name = "objects" ];
|
||||
}
|
||||
|
|
@ -85,7 +88,7 @@ message ContainerSessionContext {
|
|||
refs.ContainerID container_id = 3 [ json_name = "containerID" ];
|
||||
}
|
||||
|
||||
// NeoFS Session Token.
|
||||
// FrostFS Session Token.
|
||||
message SessionToken {
|
||||
// Session Token body
|
||||
message Body {
|
||||
|
|
@ -123,7 +126,7 @@ message SessionToken {
|
|||
}
|
||||
// Session Token contains the proof of trust between peers to be attached in
|
||||
// requests for further verification. Please see corresponding section of
|
||||
// NeoFS Technical Specification for details.
|
||||
// FrostFS Technical Specification for details.
|
||||
Body body = 1 [ json_name = "body" ];
|
||||
|
||||
// Signature of `SessionToken` information
|
||||
|
|
@ -183,7 +186,7 @@ message RequestMetaHeader {
|
|||
// `RequestMetaHeader` of the origin request
|
||||
RequestMetaHeader origin = 7 [ json_name = "origin" ];
|
||||
|
||||
// NeoFS network magic. Must match the value for the network
|
||||
// FrostFS network magic. Must match the value for the network
|
||||
// that the server belongs to.
|
||||
uint64 magic_number = 8 [ json_name = "magicNumber" ];
|
||||
}
|
||||
|
|
|
|||
|
|
@ -5,12 +5,12 @@ package neo.fs.v2.status;
|
|||
option go_package = "git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/status/grpc;status";
|
||||
option csharp_namespace = "Neo.FileStorage.API.Status";
|
||||
|
||||
// Declares the general format of the status returns of the NeoFS RPC protocol.
|
||||
// Status is present in all response messages. Each RPC of NeoFS protocol
|
||||
// describes the possible outcomes and details of the operation.
|
||||
// Declares the general format of the status returns of the FrostFS RPC
|
||||
// protocol. Status is present in all response messages. Each RPC of FrostFS
|
||||
// protocol describes the possible outcomes and details of the operation.
|
||||
//
|
||||
// Each status is assigned a one-to-one numeric code. Any unique result of an
|
||||
// operation in NeoFS is unambiguously associated with the code value.
|
||||
// operation in FrostFS is unambiguously associated with the code value.
|
||||
//
|
||||
// Numerical set of codes is split into 1024-element sections. An enumeration
|
||||
// is defined for each section. Values can be referred to in the following ways:
|
||||
|
|
@ -78,7 +78,7 @@ enum Section {
|
|||
SECTION_APE_MANAGER = 5;
|
||||
}
|
||||
|
||||
// Section of NeoFS successful return codes.
|
||||
// Section of FrostFS successful return codes.
|
||||
enum Success {
|
||||
// [**0**] Default success. Not detailed.
|
||||
// If the server cannot match successful outcome to the code, it should
|
||||
|
|
@ -93,9 +93,9 @@ enum CommonFail {
|
|||
// use this code.
|
||||
INTERNAL = 0;
|
||||
|
||||
// [**1025**] Wrong magic of the NeoFS network.
|
||||
// [**1025**] Wrong magic of the FrostFS network.
|
||||
// Details:
|
||||
// - [**0**] Magic number of the served NeoFS network (big-endian 64-bit
|
||||
// - [**0**] Magic number of the served FrostFS network (big-endian 64-bit
|
||||
// unsigned integer).
|
||||
WRONG_MAGIC_NUMBER = 1;
|
||||
|
||||
|
|
@ -104,6 +104,11 @@ enum CommonFail {
|
|||
|
||||
// [**1027**] Node is under maintenance.
|
||||
NODE_UNDER_MAINTENANCE = 3;
|
||||
|
||||
// [**1028**] Invalid argument error. If the server fails on validation of a
|
||||
// request parameter as the client sent it incorrectly, then this code should
|
||||
// be used.
|
||||
INVALID_ARGUMENT = 4;
|
||||
}
|
||||
|
||||
// Section of statuses for object-related operations.
|
||||
|
|
@ -154,4 +159,4 @@ enum Session {
|
|||
enum APEManager {
|
||||
// [**5120**] The operation is denied by APE manager.
|
||||
APE_MANAGER_ACCESS_DENIED = 0;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -8,10 +8,10 @@ option csharp_namespace = "Neo.FileStorage.API.Tombstone";
|
|||
import "refs/types.proto";
|
||||
|
||||
// Tombstone keeps record of deleted objects for a few epochs until they are
|
||||
// purged from the NeoFS network.
|
||||
// purged from the FrostFS network.
|
||||
message Tombstone {
|
||||
// Last NeoFS epoch number of the tombstone lifetime. It's set by the
|
||||
// tombstone creator depending on the current NeoFS network settings. A
|
||||
// Last FrostFS epoch number of the tombstone lifetime. It's set by the
|
||||
// tombstone creator depending on the current FrostFS network settings. A
|
||||
// tombstone object must have the same expiration epoch value in
|
||||
// `__SYSTEM__EXPIRATION_EPOCH` (`__NEOFS__EXPIRATION_EPOCH` is deprecated)
|
||||
// attribute. Otherwise, the tombstone will be rejected by a storage node.
|
||||
|
|
|
|||
Loading…
Reference in a new issue