Repository navigation
Generate API docs from spec - #1939
Closed
github-actions[bot] wants to merge 0 commit into
Closed
github-actions[bot] wants to merge 0 commit into
github-actions[bot] wants to merge 0 commit into
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
October 6, 2026 09:22
7fcde50 to
600f724
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 sync from OpenAPI specs with no auth, data, or product code changes.
Overview
This is an automated PR from the Synchronize API Docs workflow. It runs
tools/api-docs-generatorto pull the latest REST OpenAPI spec (and use the in-repo v1 spec), then regenerates the GitBook API reference underdeveloper-tools/snyk-api/reference/.The generated pages embed
{% openapi %}blocks pointing atdeveloper-tools/.gitbook/assets/rest-spec.json(and v1 assets where applicable), so any merge reflects current published API surface in user docs rather than hand-edited reference text.Reviewers should confirm the updated spec and regenerated endpoint pages match what Snyk intends to document; no application runtime code is involved.
Reviewed by Cursor Bugbot for commit 600f724. Bugbot is set up for automated code reviews on this repo. Configure here.