From c9925e2d13f3b525badb0e8c8a8206bfa759b83c Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Mon, 17 Feb 2020 09:33:45 +0100 Subject: Add libraries section to the REST Quickstart MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Document the new OpenAPI clients in the REST Quickstart, listing supported languages and their repositories. --- support/doc/api/quickstart.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'support') 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 ```bash $ curl https://peertube.example.com/api/v1/videos ``` + +## Libraries + +[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: + +- [python](https://framagit.org/framasoft/peertube/clients/python) +- [go](https://framagit.org/framasoft/peertube/clients/go) +- [kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) + +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. -- cgit v1.2.3