diff options
| author | Rigel Kent <sendmemail@rigelk.eu> | 2020-02-17 09:33:45 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-17 09:33:45 +0100 |
| commit | c9925e2d13f3b525badb0e8c8a8206bfa759b83c (patch) | |
| tree | 342117cdede829c61ed0c02290fd7ba6aa4c871c | |
| parent | 1d17d86349fd2b3a9bc85145d02383ba4aea4dc0 (diff) | |
| download | PeerTube-c9925e2d13f3b525badb0e8c8a8206bfa759b83c.tar.gz PeerTube-c9925e2d13f3b525badb0e8c8a8206bfa759b83c.tar.zst PeerTube-c9925e2d13f3b525badb0e8c8a8206bfa759b83c.zip | |
Add libraries section to the REST Quickstart
Document the new OpenAPI clients in the RESTÂ Quickstart, listing supported languages and their repositories.
| -rw-r--r-- | support/doc/api/quickstart.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/support/doc/api/quickstart.md b/support/doc/api/quickstart.md index 2222be741..677745969 100644 --- a/support/doc/api/quickstart.md +++ b/support/doc/api/quickstart.md | |||
| @@ -52,3 +52,13 @@ $ curl -H 'Authorization: Bearer 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0' https | |||
| 52 | ```bash | 52 | ```bash |
| 53 | $ curl https://peertube.example.com/api/v1/videos | 53 | $ curl https://peertube.example.com/api/v1/videos |
| 54 | ``` | 54 | ``` |
| 55 | |||
| 56 | ## Libraries | ||
| 57 | |||
| 58 | [Convenience libraries](https://framagit.org/framasoft/peertube/clients) are generated automatically from the [OpenAPI specification](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml) for the following languages: | ||
| 59 | |||
| 60 | - [python](https://framagit.org/framasoft/peertube/clients/python) | ||
| 61 | - [go](https://framagit.org/framasoft/peertube/clients/go) | ||
| 62 | - [kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) | ||
| 63 | |||
| 64 | Other [languages supported by the OpenAPI generator](https://openapi-generator.tech/docs/generators/#client-generators) can be added to the generation, provided they make a common enough use case. | ||