feat(API): add Checks API endpoints - #1242
Open
Manuel Boy (docstun) wants to merge 5 commits into
Open
Conversation
Add REST API endpoints for listing and dismissing check issues in a
project:
- GET /projects/{project_id}/checks/issues - list check issues,
filterable by state (active/solved/dismissed/all), locale_ids, and
check_names, with standard pagination.
- PATCH /projects/{project_id}/checks/issues/{id}/dismiss - mark a check
issue as dismissed so it drops off the default active list.
Adds the check_issue schema and a Checks tag under the Quality group.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Document the valid check names (translation_content_length, translation_placeholder_usage, translation_glossary_usage) as an enum on the check_names filter and the check_issue.check_name property. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Clarify that the description field may change at any time and should not be parsed or relied upon programmatically. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a note to the Checks tag description clarifying that the API is still in development and might change in subsequent releases. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The tag description is not rendered in Mintlify, so add the "still in development" note to each Checks endpoint description as well. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Manuel Boy (docstun)
marked this pull request as ready for review
August 26, 2026 15:03
jablan
reviewed
Aug 27, 2026
| "$ref": "../../responses.yaml#/401" | ||
| '403': | ||
| "$ref": "../../responses.yaml#/403" | ||
| description: Forbidden. Returned when the access token lacks the `write` scope or when the requesting user is not allowed to dismiss check issues in this project. |
Contributor
There was a problem hiding this comment.
overriding references doesn't work. either it should be only a reference, or a fully defined node. :(
jablan
reviewed
Aug 27, 2026
| solved_at: null | ||
| created_at: '2015-01-28T09:52:53Z' | ||
| updated_at: '2015-01-28T09:52:53Z' | ||
| translation: |
Contributor
There was a problem hiding this comment.
perhaps this could be a reference?
jablan
requested changes
Aug 27, 2026
jablan
left a comment
jablan
left a comment
Contributor
There was a problem hiding this comment.
cosmetic issues pointed out
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
2 participants
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
Adds REST API endpoints for the new Checks API:
GET /projects/{project_id}/checks/issues— list check issues for a project, filterable by:state—active(default),solved,dismissed, oralllocale_ids[]check_names[]page/per_pagepaginationPATCH /projects/{project_id}/checks/issues/{id}/dismiss— mark a check issue as dismissed so it drops off the default active list.Details
check_issueschema mirrors the API serializer:id,check_name,state,description,dismissed_at,solved_at,created_at,updated_at, and the embeddedtranslation.Checkstag added under the Quality tag group.readscope; dismissing requires thewritescope.Validated with
make lint(swagger-cli valid, no openapi-generator validation errors).🤖 Generated with Claude Code