Generate API docs from spec - #1833
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
September 18, 2026 19:02
65bf149 to
550364a
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, generated content with no runtime or auth impact; main risk is publishing incorrect API docs if the spec is wrong.
Overview
Automated API docs sync from the OpenAPI specs (
tools/api-docs-generator/sync-api-docs.yml). When the upstream spec differs from what’s checked in, this PR would refresh generated artifacts underdeveloper-tools/snyk-api/reference/, the API changelog, and typically the fetchedrest-spec.jsonasset.The PR description’s bullet list is the generator’s expected Reference nav entries for
developer-tools/SUMMARY.md—paste any missing lines if new reference pages were added.Note: The supplied diff is empty (
+++ /dev/nullonly), so this run may be a no-op (spec already matches generated docs). Confirm in the full PR file list before merging.Reviewed by Cursor Bugbot for commit 550364a. Bugbot is set up for automated code reviews on this repo. Configure here.