OpenCloud
/
PeerTube
mirror of https://github.com/Chocobozzz/PeerTube
1
0
Fork 0
Code Issues Releases Wiki Activity

Add openapi doc guide in documentation

pull/5615/head
Chocobozzz 2023-02-16 16:24:57 +01:00
parent aaaaa0090e
commit 1f26c0b846
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
.github/CONTRIBUTING.md vendored
View File

@ -22,6 +22,8 @@ Interested in contributing? Awesome!
- [Unit/integration tests](#unitintegration-tests) - [Unit/integration tests](#unitintegration-tests)
- [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers) - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
- [Emails](#emails) - [Emails](#emails)
- [OpenAPI documentation](#openapi-documentation)
- [Environment variables](#environment-variables)
- [Plugins & Themes](#plugins--themes) - [Plugins & Themes](#plugins--themes)
<!-- END doctoc generated TOC please keep comment here to allow auto update --> <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@ -221,6 +223,15 @@ To test emails with PeerTube:
* Run [mailslurper](http://mailslurper.com/) * 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` * 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 ### Environment variables
PeerTube can be configured using environment variables. PeerTube can be configured using environment variables.