diff options
-rw-r--r-- | .github/CONTRIBUTING.md | 11 | ||||
-rw-r--r-- | README.md | 7 |
2 files changed, 17 insertions, 1 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2b90d94a2..819b9a8f5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md | |||
@@ -20,7 +20,16 @@ interested in, user interface, design, decentralized architecture... | |||
20 | ## Write documentation | 20 | ## Write documentation |
21 | 21 | ||
22 | You can help to write the documentation of the REST API, code, architecture, | 22 | You can help to write the documentation of the REST API, code, architecture, |
23 | demonstrations... | 23 | demonstrations. |
24 | |||
25 | For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory. | ||
26 | 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. | ||
27 | |||
28 | Some hints: | ||
29 | * Routes are defined in [/server/controllers/](/server/controllers/) directory | ||
30 | * Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory | ||
31 | * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory | ||
32 | |||
24 | 33 | ||
25 | ## Develop | 34 | ## Develop |
26 | 35 | ||
@@ -147,6 +147,13 @@ guide](/.github/CONTRIBUTING.md) | |||
147 | to see how to contribute to PeerTube. Spoiler alert: you don't need to be a | 147 | to see how to contribute to PeerTube. Spoiler alert: you don't need to be a |
148 | coder to help! | 148 | coder to help! |
149 | 149 | ||
150 | ## API REST documentation | ||
151 | |||
152 | For now only on Github: | ||
153 | |||
154 | * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html) | ||
155 | * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) | ||
156 | |||
150 | ## Architecture | 157 | ## Architecture |
151 | 158 | ||
152 | See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. | 159 | See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. |