mirror of
https://github.com/discourse/discourse.git
synced 2024-11-27 15:06:17 +08:00
19089f21d2
This commit adds API documentation for the new upload endpoints related to direct + multipart external uploads. Also included is a rake task which watches the files in the spec/requests/api directory and calls a script file (spec/regenerate_swagger_docs) whenever one changes. This script runs rake rswag:specs:swaggerize and then copies the openapi.yml file over to the discourse_api_docs repo directory, and hits a script there to convert the YML to JSON so the API docs are refreshed while the server is still running. This makes the loop of making a doc change and seeing it in the local server much faster. The rake task is rake autospec:swagger
11 lines
478 B
Bash
Executable File
11 lines
478 B
Bash
Executable File
#!/bin/sh
|
|
if [[ -z "${DISCOURSE_REPO_BASE_DIRECTORY}" ]]; then
|
|
echo "Set DISCOURSE_REPO_BASE_DIRECTORY before running this script."
|
|
else
|
|
discourse_api_docs_dir="${DISCOURSE_REPO_BASE_DIRECTORY}/discourse_api_docs/"
|
|
RUBYOPT="W0" rake rswag:specs:swaggerize && cp openapi/openapi.yaml ${discourse_api_docs_dir}openapi.yml
|
|
(cd $discourse_api_docs_dir ; sh ${discourse_api_docs_dir}openapi_changed.sh)
|
|
|
|
echo "Swagger openapi.yml file copied to $discourse_api_docs_dir"
|
|
fi
|