aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2018-01-24 12:02:38 +0100
committerChocobozzz <me@florianbigard.com>2018-01-24 12:02:38 +0100
commitd59a8da813491d4cfad188adb0e3fc7a2306f835 (patch)
tree03cf4099251431100c48b13fdcfcad673940d10f /.github
parent5e1c08eb94746c44b8b14a12c0937aadb34feb57 (diff)
downloadPeerTube-d59a8da813491d4cfad188adb0e3fc7a2306f835.tar.gz
PeerTube-d59a8da813491d4cfad188adb0e3fc7a2306f835.tar.zst
PeerTube-d59a8da813491d4cfad188adb0e3fc7a2306f835.zip
Add api documentation in readme
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md11
1 files changed, 10 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
22You can help to write the documentation of the REST API, code, architecture, 22You can help to write the documentation of the REST API, code, architecture,
23demonstrations... 23demonstrations.
24
25For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory.
26Then, 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
28Some 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