docs: add pullRequestTestSecrets settings to v1 API spec [TREX-2727] - #1537
Open
nick-watson wants to merge 1 commit into
Open
docs: add pullRequestTestSecrets settings to v1 API spec [TREX-2727]#1537nick-watson wants to merge 1 commit into
nick-watson wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
✅ 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. |
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.
What does this change do?
pullRequestTestSecretsEnabledandpullRequestTestSecretsSeverityto the v1 API specpullRequestTestCode*propertiesGET/PUT /org/{orgId}/settingsWhy do we need this change?
Notes for the reviewer
snyk-api/reference/,SUMMARY.mdandchangelog.mdare 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) andpullRequestTestSecretsSeverity(low/medium/high) on the org settings schema and in the GET/PUT/org/{orgId}/settingsJSON 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.