potyarkin/frostfs-api: WIP: FrostFS API documentation and proto files declaration

WIP: FrostFS API documentation and proto files declaration

Find a file

Vitaliy Potyarkin bb0a9325ce Some checks failed Buf check / buf (pull_request) Failing after 7s Details Formatters / Run fmt (pull_request) Successful in 34s Details DCO action / DCO (pull_request) Failing after 37s Details Pre-commit hooks / Pre-commit (pull_request) Failing after 39s Details Meaningless commit to test PR workflows Signed-off-by: Vitaliy Potyarkin <v.potyarkin@yadro.com>		2024-11-06 13:29:25 +03:00
.forgejo/workflows	[#] Lint and check protobuf schemas for breaking changes	2024-11-06 13:28:53 +03:00
.github	[#] Lint and check protobuf schemas for breaking changes	2024-11-06 13:28:53 +03:00
accounting	[#50 ] *: Replace NeoFS with FrostFS in doc comments	2024-09-05 16:27:09 +03:00
acl	[#50 ] *: Replace NeoFS with FrostFS in doc comments	2024-09-05 16:27:09 +03:00
ape	[#54 ] apemanager: Move APE specific types to separate package	2024-05-30 08:09:00 +00:00
apemanager	[#58 ] *: Run pre-commit	2024-09-02 15:03:58 +03:00
container	[#67 ] container: Remove unused import	2024-10-01 14:15:39 +03:00
doc	[#65 ] Remove reference to NeoFS spec	2024-09-11 15:59:11 +03:00
lock	[#39 ] Makefile: Add fmt target	2024-02-28 18:54:53 +03:00
netmap	[#50 ] *: Replace NeoFS with FrostFS in doc comments	2024-09-05 16:27:09 +03:00
object	[#50 ] *: Replace NeoFS with FrostFS in doc comments	2024-09-05 16:27:09 +03:00
proto-docs	[#50 ] *: Regenerate docs	2024-09-05 16:27:53 +03:00
refs	[#50 ] *: Replace NeoFS with FrostFS in doc comments	2024-09-05 16:27:09 +03:00
session	[#50 ] *: Replace NeoFS with FrostFS in doc comments	2024-09-05 16:27:09 +03:00
status	[#50 ] *: Replace NeoFS with FrostFS in doc comments	2024-09-05 16:27:09 +03:00
tombstone	[#50 ] *: Replace NeoFS with FrostFS in doc comments	2024-09-05 16:27:09 +03:00
.gitignore	[#58 ] *: Run pre-commit	2024-09-02 15:03:58 +03:00
.pre-commit-config.yaml	[#58 ] pre-commit: Add pre-commit and related Makefile targets	2024-09-02 15:02:24 +03:00
CHANGELOG.md	[#58 ] *: Run pre-commit	2024-09-02 15:03:58 +03:00
CONTRIBUTING.md	[#64 ] Update obsolete URLs	2024-09-11 14:08:39 +03:00
CREDITS.md	Rebranding	2022-12-08 15:21:43 +03:00
help.mk	[#58 ] pre-commit: Add pre-commit and related Makefile targets	2024-09-02 15:02:24 +03:00
LICENSE	Create LICENSE	2020-04-09 19:27:39 +03:00
Makefile	[#58 ] pre-commit: Add pre-commit and related Makefile targets	2024-09-02 15:02:24 +03:00
README.md	Meaningless commit to test PR workflows	2024-11-06 13:29:25 +03:00

README.md

FrostFS API language-agnostic protocol definitions

Overview

FrostFS-API repository is the basis for language-specific libraries, e.g.:

frostfs-api-go

Those libraries contain compiled protocol buffers definitions, wrapped with language-specific code. Use them to integrate applications with FrostFS.

This repository contains:

protocol buffers packages
auto-generated docs for protocol buffers

Contributing

Feel free to contribute to this project after reading the contributing guidelines.

Before you start working on a certain topic, first create a new issue describing the feature/topic you are going to implement.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details