Generate API docs from spec - #1692
Closed
github-actions[bot] wants to merge 0 commit into
Closed
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
github-actions
Bot
force-pushed
the
docs/automatic-api-docs-update
branch
from
August 28, 2026 15:07
9d13449 to
6fd7973
Compare
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.
This PR was automatically generated by the API docs synchronization action. Please review the changes and merge if they look good.
Note
Low Risk
Documentation-only regeneration from OpenAPI specs; no production code or auth paths are modified.
Overview
Automated API docs sync from the
synchronize-api-docsworkflow (tools/api-docs-generator), aligning user-docs with the current v1 and REST OpenAPI sources.The run refreshes GitBook reference pages under
developer-tools/snyk-api/reference/(the PR body lists the full tag menu—AccessRequests through learn, plus v1 groupings such as Projects, Users, and Webhooks). Expect updates to generated{% openapi %}markdown and any copied spec assets when the upstream spec differs frommain.Review for unintended endpoint or schema drift in the rendered reference, not application runtime behavior.
Reviewed by Cursor Bugbot for commit 6fd7973. Bugbot is set up for automated code reviews on this repo. Configure here.