8acb1ee5bf
Add some code to generate a basic markdown file documenting a generated API. Generate this document for the API in satellite/console/consoleweb/consoleapi/gen. The documentation is not completely correct, as it may include some values in the request body that are not actually usable by the requester. This can be fixed by making sure all types used within the generated API are properly annotated with `json` tags. Issue: https://github.com/storj/storj-private/issues/244 Change-Id: I57b259967fb0db8f548b6598a10c825da15ba723 |
||
|---|---|---|
| .github | ||
| certificate | ||
| cmd | ||
| crashcollect | ||
| docs | ||
| installer/windows | ||
| multinode | ||
| private | ||
| resources | ||
| satellite | ||
| scripts | ||
| storagenode | ||
| testsuite | ||
| versioncontrol | ||
| web | ||
| .dockerignore | ||
| .earthlyignore | ||
| .gitattributes | ||
| .gitignore | ||
| .gitreview | ||
| CODE_OF_CONDUCT.md | ||
| CODEOWNERS | ||
| CONTRIBUTING.md | ||
| DEVELOPING.md | ||
| docker-compose.tests.yaml | ||
| Earthfile | ||
| go.mod | ||
| go.sum | ||
| Jenkinsfile | ||
| Jenkinsfile.premerge | ||
| Jenkinsfile.public | ||
| Jenkinsfile.verify | ||
| LICENSE | ||
| MAINTAINERS.md | ||
| Makefile | ||
| monkit.lock | ||
| proto.lock | ||
| README.md | ||
Storj V3 Network
Storj is building a distributed cloud storage network. Check out our white paper for more info!
Storj is an S3-compatible platform and suite of distributed applications that allows you to store data in a secure and distributed manner. Your files are encrypted, broken into little pieces and stored in a global distributed network of computers. Luckily, we also support allowing you (and only you) to retrieve those files!
Table of Contents
Contributing to Storj
All of our code for Storj v3 is open source. If anything feels off, or if you feel that some functionality is missing, please check out the contributing page. There you will find instructions for sharing your feedback, building the tool locally, and submitting pull requests to the project.
A Note about Versioning
While we are practicing semantic versioning for our client libraries such as uplink, we are not practicing semantic versioning in this repo, as we do not intend for it to be used via Go modules. We may have backwards-incompatible changes between minor and patch releases in this repo.
Start using Storj
Our wiki has documentation and tutorials. Check out these three tutorials:
License
This repository is currently licensed with the AGPLv3 license.
For code released under the AGPLv3, we request that contributors sign our Contributor License Agreement (CLA) so that we can relicense the code under Apache v2, or other licenses in the future.
Support
If you have any questions or suggestions please reach out to us on our community forum or file a ticket at https://support.storj.io/.