2020-09-04 06:45:46 +00:00
|
|
|
<p align="center">
|
2022-12-08 11:22:14 +00:00
|
|
|
<img src="./.github/logo.svg" width="500px" alt="FrostFS">
|
2020-09-04 06:45:46 +00:00
|
|
|
</p>
|
|
|
|
|
<p align="center">
|
2022-12-08 11:22:14 +00:00
|
|
|
<a href="https://objectstorage.info">FrostFS</a> API language-agnostic protocol definitions
|
2020-09-04 06:45:46 +00:00
|
|
|
</p>
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
---
|
2022-12-08 11:22:14 +00:00
|
|
|
|
|
|
|
|
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
## Overview
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2022-12-08 11:22:14 +00:00
|
|
|
FrostFS-API repository is the basis for language-specific libraries, e.g.:
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2022-12-08 11:22:14 +00:00
|
|
|
- [frostfs-api-go](https://github.com/TrueCloudLab/frostfs-api-go)
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
Those libraries contain compiled protocol buffers definitions, wrapped with
|
2022-12-08 11:22:14 +00:00
|
|
|
language-specific code. Use them to integrate applications with FrostFS.
|
2020-01-30 11:41:24 +00:00
|
|
|
|
2020-04-01 15:04:37 +00:00
|
|
|
This repository contains:
|
|
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
- protocol buffers packages
|
|
|
|
|
- [auto-generated docs](proto-docs) for protocol buffers
|
2020-04-01 15:04:37 +00:00
|
|
|
|
2020-09-17 19:04:00 +00:00
|
|
|
## Contributing
|
2020-04-01 15:04:37 +00:00
|
|
|
|
2020-09-04 06:45:46 +00:00
|
|
|
Feel free to contribute to this project after reading the [contributing
|
|
|
|
|
guidelines](CONTRIBUTING.md).
|
2020-04-01 15:04:37 +00:00
|
|
|
|
2022-04-13 06:21:33 +00:00
|
|
|
Before you start working on a certain topic, first create a new issue
|
2020-09-04 06:45:46 +00:00
|
|
|
describing the feature/topic you are going to implement.
|
2020-01-30 11:41:24 +00:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2020-09-17 19:04:00 +00:00
|
|
|
This project is licensed under the Apache 2.0 License -
|
2020-04-10 06:25:00 +00:00
|
|
|
see the [LICENSE](LICENSE) file for details
|
