From d59a8da813491d4cfad188adb0e3fc7a2306f835 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Wed, 24 Jan 2018 12:02:38 +0100 Subject: [PATCH] Add api documentation in readme --- .github/CONTRIBUTING.md | 11 ++++++++++- README.md | 7 +++++++ 2 files changed, 17 insertions(+), 1 deletion(-) 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... ## 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 e8871a7cc..491b09a36 100644 --- 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. -- 2.41.0