Add entries for new suppression endpoints - #73
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Update the 207 response schemas to represent the documented partial suppression results.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Adds OpenAPI entries for three organization-level suppression endpoints.
Changes:
- Documents vulnerability, vulnerability-group, and finding suppression endpoints.
- Adds request and response schemas.
- Documents authentication and error responses.
File summaries
| File | Summary |
|---|---|
go/api/openapi.yaml |
Defines the new endpoints and schemas. Moderate issue (3 votes): 207 responses at lines 1998, 2057, and 2116 use the generic Problem schema instead of exposing partial suppression results. |
Review details
Suppressed comments (2)
go/api/openapi.yaml:2057
- The 207 response is described as containing partial suppression results, but it is modeled as the generic RFC 7807
Problem. That prevents clients from seeing thesuppressed,unsuppressed, and per-itemerrorsfields provided bySuppressionResponse; use the result schema for this response (or define a dedicated partial-results schema matching the actual payload).
$ref: "#/components/schemas/Problem"
go/api/openapi.yaml:2116
- The 207 response is described as containing partial suppression results, but it is modeled as the generic RFC 7807
Problem. That prevents clients from seeing thesuppressed,unsuppressed, and per-itemerrorsfields provided bySuppressionResponse; use the result schema for this response (or define a dedicated partial-results schema matching the actual payload).
$ref: "#/components/schemas/Problem"
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Adds entries for the following endpoints: