forked from TrueCloudLab/frostfs-api
Compare commits
3 commits
Author | SHA1 | Date | |
---|---|---|---|
8540f0d18d | |||
1a6bb369ec | |||
4c51a9b9d6 |
14 changed files with 62 additions and 67 deletions
Before Width: | Height: | Size: 5.5 KiB After Width: | Height: | Size: 5.5 KiB |
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
CODEOWNERS
Normal file
1
CODEOWNERS
Normal file
|
@ -0,0 +1 @@
|
|||
.* @alexvanin @realloc @fyrchik @a.bogatyrev
|
|
@ -87,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.
|
||||
|
|
2
Makefile
2
Makefile
|
@ -10,7 +10,7 @@ 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
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
<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://frostfs.info">FrostFS</a> API language-agnostic protocol definitions
|
||||
|
|
|
@ -52,7 +52,7 @@ service ContainerService {
|
|||
// 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): \
|
||||
|
@ -61,6 +61,17 @@ service ContainerService {
|
|||
// - **CONTAINER_ACCESS_DENIED** (3074, SECTION_CONTAINER): \
|
||||
// container list access denied.
|
||||
rpc List(ListRequest) returns (ListResponse);
|
||||
|
||||
// Returns all owner's containers from `Container` smart contract storage
|
||||
// via stream.
|
||||
//
|
||||
// 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.
|
||||
rpc ListStream(ListStreamRequest) returns (stream ListStreamResponse);
|
||||
}
|
||||
|
||||
// New FrostFS Container creation request
|
||||
|
@ -245,3 +256,44 @@ message ListResponse {
|
|||
// transmission.
|
||||
neo.fs.v2.session.ResponseVerificationHeader verify_header = 3;
|
||||
}
|
||||
|
||||
// List containers stream
|
||||
message ListStreamRequest {
|
||||
// List containers stream request body.
|
||||
message Body {
|
||||
// Identifier of the container owner.
|
||||
neo.fs.v2.refs.OwnerID owner_id = 1;
|
||||
}
|
||||
// Body of list containers stream 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;
|
||||
}
|
||||
|
||||
// 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 list containers stream 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;
|
||||
}
|
||||
|
|
|
@ -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,5 +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
|
||||
|
|
Loading…
Reference in a new issue