Skip to content

docs: add pullRequestTestSecrets settings to v1 API spec [TREX-2727] - #1537

Open
nick-watson wants to merge 1 commit into
mainfrom
chore/v1-api-spec-pr-secrets-settings
Open

docs: add pullRequestTestSecrets settings to v1 API spec [TREX-2727]#1537
nick-watson wants to merge 1 commit into
mainfrom
chore/v1-api-spec-pr-secrets-settings

Conversation

@nick-watson

@nick-watson nick-watson commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

What does this change do?

  • Adds pullRequestTestSecretsEnabled and pullRequestTestSecretsSeverity to the v1 API spec
    • Documented on the org settings schema, alongside the existing pullRequestTestCode* properties
    • Included in the request and response examples for GET/PUT /org/{orgId}/settings

Why do we need this change?

Notes for the reviewer

  • Schema properties only — no new endpoints, so snyk-api/reference/, SUMMARY.md and changelog.md are unchanged. Verified by running the API docs generator locally.

🤖 Generated with Claude Code


Note

Low Risk
OpenAPI documentation only; no runtime or endpoint behavior changes.

Overview
Documents Snyk Secrets pull-request test org settings in the v1 OpenAPI spec (Integrationsettings), parallel to the existing Snyk Code fields.

Adds pullRequestTestSecretsEnabled (boolean) and pullRequestTestSecretsSeverity (low / medium / high) on the org settings schema and in the GET/PUT /org/{orgId}/settings JSON examples so they appear on the public API reference.

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

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@nick-watson
nick-watson requested a review from a team as a code owner July 27, 2026 13:26
@snyk-io

snyk-io Bot commented Jul 27, 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.

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.

1 participant