Skip to content

Fix api spec generation #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pelzerim wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix api spec generation #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d65d42
fix: api spec update
pelzerim Mar 5, 2026
ad97319
fix: schema issues with IcmpMonitorCreate
pelzerim Mar 6, 2026
ce0867f
Merge branch 'main' into immanuel/fix-api-spec
pelzerim Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,4 @@ Thumbs.db
test-results/
playwright-report/
playwright/.cache/
.checkly_openapi_tmp.json
7 changes: 6 additions & 1 deletion update-api-spec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ set -e

LIVE_API_URL="https://api.checklyhq.com/openapi.json"
API_SPEC_PATH="./api-reference/openapi.json"
TEMP_FILE="/tmp/checkly_openapi.json"
TEMP_FILE="./.checkly_openapi_tmp.json"

echo "📥 Fetching live API specification from $LIVE_API_URL..."
curl -s "$LIVE_API_URL" > "$TEMP_FILE"
Expand All @@ -16,6 +16,11 @@ if [ ! -s "$TEMP_FILE" ]; then
exit 1
fi

echo "🔧 Fixing invalid OpenAPI schema fields..."
# Fix maxPacketLossThreshold.minimum which contains a Joi.ref() object instead of a number
jq '.components.schemas.IcmpMonitorCreate.properties.maxPacketLossThreshold.minimum = 0
| .components.schemas.IcmpMonitorUpdate.properties.maxPacketLossThreshold.minimum = 0' "$TEMP_FILE" > "${TEMP_FILE}.fixed" && mv "${TEMP_FILE}.fixed" "$TEMP_FILE"

echo "🔧 Cleaning up HTML in descriptions..."
# Convert common HTML tags to Markdown
# Order matters: convert <code> first so <b> patterns work on remaining content
Expand Down
Loading