ci: scheduled refresh of OpenAPI specs from semgrep.dev#2706
Draft
gaprl wants to merge 2 commits into
Draft
Conversation
gaprl
marked this pull request as draft
July 13, 2026 19:47
Base automatically changed from
gabriellopes/appex-1187-make-v2-openapi-docs-available-in-mintlify-docs
to
main
July 14, 2026 17:06
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stack context
Stacked on #2703 (auto-generated API reference for v1 + v2). That PR makes Mintlify render the API docs from the checked-in specs; this one keeps those specs fresh. Merge #2703 first.
What
New workflow
update-openapi-specs.yml(weekday-morning cron + manualworkflow_dispatch):docs/public_v1.openapi.yaml← https://semgrep.dev/api/v1/public_v1.openapi.yamldocs/public_v2.openapi.yaml← https://semgrep.dev/api/v2/openapi.yamlx-displayNametag names intox-group(Mintlify's extension for nav group labels; skipped once upstream emitsx-groupnatively).mintlify validateagainst the fetched specs — a bad or partial upstream spec blocks the update instead of breaking the live docs.peter-evans/create-pull-request,chore/update-openapi-specsbranch, auto-deleted after merge).Actions are pinned to full commit SHAs with version comments.
Caveats
GITHUB_TOKENdon't trigger Docs CI on the created PR. Reviewers can close/reopen to run CI, or provide aDOCS_BOT_TOKENsecret (the workflow prefers it automatically when present).type: bool, duplicate tags, prose in atype:field) that were patched in the checked-in copies in API reference: auto-generate from OpenAPI specs, add v1 and v2 #2703. Until they're fixed at the source in semgrep-app, the first scheduled run will fail at the validate step by design — that's the guard doing its job, not a workflow bug.