]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/commitdiff
Add libraries section to the REST Quickstart
authorRigel Kent <sendmemail@rigelk.eu>
Mon, 17 Feb 2020 08:33:45 +0000 (09:33 +0100)
committerGitHub <noreply@github.com>
Mon, 17 Feb 2020 08:33:45 +0000 (09:33 +0100)
Document the new OpenAPI clients in the REST Quickstart, listing supported languages and their repositories.

support/doc/api/quickstart.md

index 2222be741af6088dd0c9a79f5b05a77977603bfd..6777459698617359be5c9fcbc11416a1dfd73063 100644 (file)
@@ -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.