Skip to content

Generate API docs from spec#1475

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

Generate API docs from spec#1475
github-actions[bot] wants to merge 0 commit into
mainfrom
docs/automatic-api-docs-update

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 17, 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, machine-generated from the API spec with no application or auth logic changes.

Overview
Automated API reference sync — this PR refreshes the generated Snyk API documentation under developer-tools/snyk-api/reference/ so it matches the current OpenAPI sources (rest-spec.json, v1-api-spec.yaml).

The sync action rebuilds per-tag reference pages (REST and v1) that embed GitBook {% openapi %} blocks for each operation. The PR description lists the full set of updated reference files (e.g. AccessRequests, Apps, Issues, Projects, SBOM, ServiceAccounts, and related v1 guides).

Note: The attached diff was empty in this review context; treat this as a routine docs-only regeneration and confirm any substantive spec deltas in the OpenAPI assets or a few representative reference pages rather than line-by-reading every generated file.

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

@github-actions
github-actions Bot requested a review from a team as a code owner July 17, 2026 12:21
@snyk-io

snyk-io Bot commented Jul 17, 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 closed this Jul 17, 2026
@github-actions
github-actions Bot force-pushed the docs/automatic-api-docs-update branch from 07e7198 to 49f4fd6 Compare July 17, 2026 13:28
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