LogalDeveloper/owncast
0
Fork 0
Code Activity

Update API gen, cleanup, add missing property to status response (#3987)

Browse Source 
* fix(api): remove invalid tag properties from components

* chore(api): update api validation/linter to use redocly

* fix(api): add missing streamTitle property to status object. Closes #3983

* chore: add redocly config file

* Commit updated API documentation

---------

Co-authored-by: Owncast <owncast@owncast.online>
This commit is contained in:
Gabe Kangas
2024-10-27 15:36:31 -07:00
committed by GitHub
parent 5a3600e01f
commit eed34b528e
6 changed files with 4549 additions and 4588 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
build/gen-api.sh
View File

@@ -8,8 +8,8 @@ folderPath="webserver/handlers/generated"
specPath="openapi.yaml"
# validate scripts are installed
if ! command -v swagger-cli &>/dev/null; then
echo "Please install \`swagger-cli\` before running this script"
if ! command -v redocly &>/dev/null; then
echo "Please install \`redocly cli\` before running this script: npm install -g @redocly/cli"
exit 1
fi
@@ -20,7 +20,7 @@ if ! command -v oapi-codegen &>/dev/null; then
fi
# validate schema
swagger-cli validate $specPath
npx redocly lint $specPath
if [ $? -ne 0 ]; then
echo "Open API specification is not valid"
exit 1