Add api documentation in readme

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 2b90d94a249ab88e333051a3321c88aa215cf13c..819b9a8f5a594f0b5e5a6960db4a02c080e0ec72 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -20,7 +20,16 @@ interested in, user interface, design, decentralized architecture...
 ## Write documentation
 
 You can help to write the documentation of the REST API, code, architecture,
-demonstrations...
+demonstrations.
+
+For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory.
+Then, you can just open the `openapi.yaml` file in a special editor like [http://editor.swagger.io/](http://editor.swagger.io/) to easily see and edit the documentation.
+
+Some hints:
+ * Routes are defined in [/server/controllers/](/server/controllers/) directory
+ * Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory
+ * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory
+
 
 ## Develop
 

diff --git a/README.md b/README.md
index e8871a7ccf006f108730397a4be2c9c3859cb77d..491b09a3676aa586ff34cbdcf78908d338667123 100644 (file)
--- a/README.md
+++ b/README.md
@@ -147,6 +147,13 @@ guide](/.github/CONTRIBUTING.md)
 to see how to contribute to PeerTube. Spoiler alert: you don't need to be a
 coder to help!
 
+## API REST documentation
+
+For now only on Github:
+
+ * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html)
+ * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
+
 ## Architecture
 
 See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.