From 1f26c0b846ce22877c432012d107bd72869bc562 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Thu, 16 Feb 2023 16:24:57 +0100 Subject: Add openapi doc guide in documentation --- .github/CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to '.github') diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 86b4ae704..2f1774756 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -22,6 +22,8 @@ Interested in contributing? Awesome! - [Unit/integration tests](#unitintegration-tests) - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers) - [Emails](#emails) + - [OpenAPI documentation](#openapi-documentation) + - [Environment variables](#environment-variables) - [Plugins & Themes](#plugins--themes) @@ -221,6 +223,15 @@ To test emails with PeerTube: * Run [mailslurper](http://mailslurper.com/) * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=dev node dist/server` +### OpenAPI documentation + +The [REST API documentation](https://docs.joinpeertube.org/api-rest-reference.html) is generated from `support/doc/api/openapi.yaml` file. +To quickly get a preview of your changes, you can generate the documentation *on the fly* using the following command: + +``` +npx redoc-cli serve --watch ./support/doc/api/openapi.yaml +``` + ### Environment variables PeerTube can be configured using environment variables. -- cgit v1.2.3