mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-11 12:03:14 +00:00
5cb70407a6
- add extended mode to /record and /story - fix compilation in 1 file - better examples - todo : extended mode for /search - todo : check "include[]" available keys (compare with extended mode) - todo : remove 'id' type ?
22 lines
578 B
Markdown
22 lines
578 B
Markdown
# How to update the documentation in swaggerhub :
|
|
|
|
The doc is composed of 3 files
|
|
- `api.yaml` (main file)
|
|
- `responses.yaml`
|
|
- `schemas.yaml`
|
|
|
|
to update in swaggerhub (single file) :
|
|
- install swagger-cli
|
|
|
|
`sudo npm install -g swagger-cli`
|
|
|
|
|
|
- compile sources in a single file for swaggerhub (run from <phraseanet-dir>)
|
|
|
|
`swagger-cli bundle API_documentation/v3/api.yaml -r -o API_documentation/v3/_compiled.yaml -t yaml`
|
|
|
|
|
|
- copy/paste the generated content from `_compiled.yaml` to
|
|
|
|
https://app.swaggerhub.com/apis/alchemy-fr/phraseanet.api.v3/1.0.0-oas3
|