Skip to content

Generate API docs from spec - #1778

Closed
github-actions[bot] wants to merge 0 commit into
mainfrom
docs/automatic-api-docs-update
Closed

github-actions[bot] wants to merge 0 commit into
mainfrom
docs/automatic-api-docs-update

Conversation

@github-actions

@github-actions github-actions Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

This PR was automatically generated by the API docs synchronization action. Please review the changes and merge if they look good.

generated menu for summary:
* [AccessRequests](developer-tools/snyk-api/reference/accessrequests.md)
* [AiBom](developer-tools/snyk-api/reference/aibom.md)
* [Apps](developer-tools/snyk-api/reference/apps.md)
* [Asset](developer-tools/snyk-api/reference/asset.md)
* [Assignments](developer-tools/snyk-api/reference/assignments.md)
* [Audit Logs](developer-tools/snyk-api/reference/audit-logs.md)
* [Cloud](developer-tools/snyk-api/reference/cloud.md)
* [Collection](developer-tools/snyk-api/reference/collection.md)
* [ContainerImage](developer-tools/snyk-api/reference/containerimage.md)
* [ContainerRegistryImportPolicy](developer-tools/snyk-api/reference/containerregistryimportpolicy.md)
* [Custom Base Images](developer-tools/snyk-api/reference/custom-base-images.md)
* [Dependencies (v1)](developer-tools/snyk-api/reference/dependencies-v1.md)
* [Entitlements (v1)](developer-tools/snyk-api/reference/entitlements-v1.md)
* [Export](developer-tools/snyk-api/reference/export.md)
* [Findings](developer-tools/snyk-api/reference/findings.md)
* [Group](developer-tools/snyk-api/reference/group.md)
* [Groups (v1)](developer-tools/snyk-api/reference/groups-v1.md)
* [Groups](developer-tools/snyk-api/reference/groups.md)
* [IacSettings](developer-tools/snyk-api/reference/iacsettings.md)
* [Ignores (v1)](developer-tools/snyk-api/reference/ignores-v1.md)
* [Import Projects (v1)](developer-tools/snyk-api/reference/import-projects-v1.md)
* [Integrations (v1)](developer-tools/snyk-api/reference/integrations-v1.md)
* [Inventory Assets](developer-tools/snyk-api/reference/inventory-assets.md)
* [Invites](developer-tools/snyk-api/reference/invites.md)
* [Issues](developer-tools/snyk-api/reference/issues.md)
* [Jira (v1)](developer-tools/snyk-api/reference/jira-v1.md)
* [LanguagesSettings](developer-tools/snyk-api/reference/languagessettings.md)
* [Licenses (v1)](developer-tools/snyk-api/reference/licenses-v1.md)
* [Monitor (v1)](developer-tools/snyk-api/reference/monitor-v1.md)
* [OpenSourceSettings](developer-tools/snyk-api/reference/opensourcesettings.md)
* [OpensourceSettings](developer-tools/snyk-api/reference/opensourcesettings.md)
* [Organizations (v1)](developer-tools/snyk-api/reference/organizations-v1.md)
* [Orgs](developer-tools/snyk-api/reference/orgs.md)
* [Package Version](developer-tools/snyk-api/reference/package-version.md)
* [Package](developer-tools/snyk-api/reference/package.md)
* [PersonalAccessToken](developer-tools/snyk-api/reference/personalaccesstoken.md)
* [Policies](developer-tools/snyk-api/reference/policies.md)
* [Projects (v1)](developer-tools/snyk-api/reference/projects-v1.md)
* [Projects](developer-tools/snyk-api/reference/projects.md)
* [Pull Request Templates](developer-tools/snyk-api/reference/pull-request-templates.md)
* [Reporting API (v1)](developer-tools/snyk-api/reference/reporting-api-v1.md)
* [SBOM](developer-tools/snyk-api/reference/sbom.md)
* [SastRuleExtensions](developer-tools/snyk-api/reference/sastruleextensions.md)
* [SastSettings](developer-tools/snyk-api/reference/sastsettings.md)
* [SecretsRuleExtensions](developer-tools/snyk-api/reference/secretsruleextensions.md)
* [SecretsSettings](developer-tools/snyk-api/reference/secretssettings.md)
* [ServiceAccounts](developer-tools/snyk-api/reference/serviceaccounts.md)
* [SlackSettings](developer-tools/snyk-api/reference/slacksettings.md)
* [Slack](developer-tools/snyk-api/reference/slack.md)
* [Snapshots (v1)](developer-tools/snyk-api/reference/snapshots-v1.md)
* [Targets](developer-tools/snyk-api/reference/targets.md)
* [TenantRole](developer-tools/snyk-api/reference/tenantrole.md)
* [Tenants](developer-tools/snyk-api/reference/tenants.md)
* [Test (v1)](developer-tools/snyk-api/reference/test-v1.md)
* [Tests](developer-tools/snyk-api/reference/tests.md)
* [Universal Broker](developer-tools/snyk-api/reference/universal-broker.md)
* [Users (v1)](developer-tools/snyk-api/reference/users-v1.md)
* [Users](developer-tools/snyk-api/reference/users.md)
* [Webhooks (v1)](developer-tools/snyk-api/reference/webhooks-v1.md)
* [learn](developer-tools/snyk-api/reference/learn.md)

Note

Low Risk
Documentation-only output from the official OpenAPI sources; no application or auth logic changes.

Overview
Automated refresh of Snyk API reference documentation produced by the sync-api-docs workflow running tools/api-docs-generator (make run).

The generator pulls the latest REST OpenAPI spec, uses the in-repo v1 spec, and rewrites generated reference pages under developer-tools/snyk-api/reference/ (and related synced assets such as the API changelog). The PR body menu lists the full set of reference topics after this run—including entries like Assignments, Secrets rule/settings pages, and SastRuleExtensions that may need a manual developer-tools/SUMMARY.md update if they are new or renamed (the generator does not edit SUMMARY.md).

Reviewers should spot-check regenerated endpoints against the specs rather than line-by-line prose.

Reviewed by Cursor Bugbot for commit 4267044. Bugbot is set up for automated code reviews on this repo. Configure here.

@snyk-io

snyk-io Bot commented Sep 10, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@github-actions
github-actions Bot force-pushed the docs/automatic-api-docs-update branch 28 times, most recently from 1384e6e to 36b1350 Compare September 11, 2026 12:25
@github-actions
github-actions Bot force-pushed the docs/automatic-api-docs-update branch 18 times, most recently from 26d8643 to 1c8dea1 Compare September 14, 2026 10:03
@github-actions github-actions Bot closed this Sep 14, 2026
@github-actions
github-actions Bot force-pushed the docs/automatic-api-docs-update branch from 1c8dea1 to 4267044 Compare September 14, 2026 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants