From bbb21e21a7d5032c74044f14345ff15ceb6eb4ed Mon Sep 17 00:00:00 2001 From: Manuel Boy Date: Wed, 26 Aug 2026 14:18:14 +0200 Subject: [PATCH 1/5] feat(API): add Checks API endpoints 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) --- doc/compiled.json | 294 ++++++++++++++++++++++++++++++++++++++ main.yaml | 31 ++++ paths.yaml | 6 + paths/checks/dismiss.yaml | 54 +++++++ paths/checks/index.yaml | 85 +++++++++++ schemas.yaml | 2 + schemas/check_issue.yaml | 65 +++++++++ 7 files changed, 537 insertions(+) create mode 100644 paths/checks/dismiss.yaml create mode 100644 paths/checks/index.yaml create mode 100644 schemas/check_issue.yaml diff --git a/doc/compiled.json b/doc/compiled.json index 60b384e1..6ca88a99 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -56,6 +56,10 @@ "name": "Branches", "description": "### Branch creation\n\nBranches will be created asynchronously. State of branch creation is returned as state.\n\n#### Available States\n\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
StateDescription
initializedData received.
processingBranch is currently creating.
successBranch was created successfully
errorBranch creation failed.
\n
\n" }, + { + "name": "Checks", + "description": "The Checks API lets you list the check issues detected in a project and dismiss issues that should no longer appear on the list of active check issues.\n\n#### Available States\n\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
StateDescription
activeThe issue is unresolved and not dismissed.
solvedThe issue has been resolved.
dismissedThe issue has been dismissed by a user.
\n
\n" + }, { "name": "Comments" }, @@ -255,6 +259,7 @@ { "name": "Quality", "tags": [ + "Checks", "Glossaries", "Glossary Terms", "Glossary Term Translations" @@ -483,6 +488,87 @@ "updated_at": "2015-01-28T09:52:53Z" } }, + "check_issue": { + "type": "object", + "title": "check_issue", + "properties": { + "id": { + "type": "string" + }, + "check_name": { + "description": "Identifier of the check that reported this issue.", + "type": "string" + }, + "state": { + "description": "Current state of the check issue. One of: `active`, `solved`, `dismissed`.", + "type": "string", + "enum": [ + "active", + "solved", + "dismissed" + ] + }, + "description": { + "description": "Human-readable description of the reported issue, always in English.", + "type": "string" + }, + "dismissed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "solved_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "translation": { + "$ref": "#/components/schemas/translation" + } + }, + "example": { + "id": "abcd1234cdef1234abcd1234cdef1234", + "check_name": "translation_placeholder_usage", + "state": "active", + "description": "The translation contains invalid placeholders. (missing: %{count})", + "dismissed_at": null, + "solved_at": null, + "created_at": "2015-01-28T09:52:53Z", + "updated_at": "2015-01-28T09:52:53Z", + "translation": { + "id": "abcd1234cdef1234abcd1234cdef1234", + "content": "My translation", + "unverified": false, + "excluded": false, + "plural_suffix": "", + "key": { + "id": "abcd1234cdef1234abcd1234cdef1234", + "name": "home.index.headline", + "plural": false, + "use_ordinal_rules": false + }, + "locale": { + "id": "abcd1234cdef1234abcd1234cdef1234", + "name": "de", + "code": "de-DE" + }, + "placeholders": [ + "%{count}" + ], + "state": "translated", + "created_at": "2015-01-28T09:52:53Z", + "updated_at": "2015-01-28T09:52:53Z" + } + } + }, "branch_comparison": { "type": "object", "title": "branch_comparison", @@ -23435,6 +23521,214 @@ "x-cli-version": "2.5" } }, + "/projects/{project_id}/checks/issues": { + "get": { + "summary": "List check issues", + "description": "List check issues for the given project. Results can be filtered by locale, check name, and state.", + "operationId": "check_issues/list", + "tags": [ + "Checks" + ], + "parameters": [ + { + "$ref": "#/components/parameters/X-PhraseApp-OTP" + }, + { + "$ref": "#/components/parameters/project_id" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "description": "Filter by state of the check issue. Can be one of: `active`, `solved`, `dismissed`, `all`. Defaults to `active`.", + "name": "state", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "active", + "enum": [ + "active", + "solved", + "dismissed", + "all" + ] + }, + "example": "active" + }, + { + "description": "Filter by one or more locale IDs.", + "name": "locale_ids", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "abcd1234cdef1234abcd1234cdef1234" + ] + } + }, + { + "description": "Filter by one or more check names.", + "name": "check_names", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "translation_placeholder_usage" + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/check_issue" + } + } + } + }, + "headers": { + "X-Rate-Limit-Limit": { + "$ref": "#/components/headers/X-Rate-Limit-Limit" + }, + "X-Rate-Limit-Remaining": { + "$ref": "#/components/headers/X-Rate-Limit-Remaining" + }, + "X-Rate-Limit-Reset": { + "$ref": "#/components/headers/X-Rate-Limit-Reset" + }, + "Link": { + "$ref": "#/components/headers/Link" + }, + "Pagination": { + "$ref": "#/components/headers/Pagination" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403", + "description": "Forbidden. Returned when the access token lacks the `read` scope or when the requesting user is not allowed to view check issues in this project." + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "x-code-samples": [ + { + "lang": "Curl", + "source": "curl \"https://api.phrase.com/v2/projects/:project_id/checks/issues\" \\\n -u USERNAME_OR_ACCESS_TOKEN" + }, + { + "lang": "CLI v2", + "source": "phrase check_issues list \\\n--project_id \\\n--access_token " + } + ] + } + }, + "/projects/{project_id}/checks/issues/{id}/dismiss": { + "patch": { + "summary": "Dismiss a check issue", + "description": "Mark a check issue as dismissed so it no longer appears on the list of active check issues.", + "operationId": "check_issue/dismiss", + "tags": [ + "Checks" + ], + "parameters": [ + { + "$ref": "#/components/parameters/X-PhraseApp-OTP" + }, + { + "$ref": "#/components/parameters/project_id" + }, + { + "name": "id", + "in": "path", + "required": true, + "description": "Check Issue ID", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check_issue" + } + } + }, + "headers": { + "X-Rate-Limit-Limit": { + "$ref": "#/components/headers/X-Rate-Limit-Limit" + }, + "X-Rate-Limit-Remaining": { + "$ref": "#/components/headers/X-Rate-Limit-Remaining" + }, + "X-Rate-Limit-Reset": { + "$ref": "#/components/headers/X-Rate-Limit-Reset" + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/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." + }, + "404": { + "$ref": "#/components/responses/404" + }, + "422": { + "$ref": "#/components/responses/422" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "x-code-samples": [ + { + "lang": "Curl", + "source": "curl \"https://api.phrase.com/v2/projects/:project_id/checks/issues/:id/dismiss\" \\\n -u USERNAME_OR_ACCESS_TOKEN \\\n -X PATCH" + }, + { + "lang": "CLI v2", + "source": "phrase check_issues dismiss \\\n--project_id \\\n--id \\\n--access_token " + } + ] + } + }, "/projects/{project_id}/keys": { "get": { "summary": "List keys", diff --git a/main.yaml b/main.yaml index 7c272847..4d38ce59 100644 --- a/main.yaml +++ b/main.yaml @@ -113,6 +113,36 @@ tags: + - name: Checks + description: | + The Checks API lets you list the check issues detected in a project and dismiss issues that should no longer appear on the list of active check issues. + + #### Available States + +
+ + + + + + + + + + + + + + + + + + + + + +
StateDescription
activeThe issue is unresolved and not dismissed.
solvedThe issue has been resolved.
dismissedThe issue has been dismissed by a user.
+
- name: Comments - name: Comment Reactions - name: Comment Replies @@ -300,6 +330,7 @@ x-tagGroups: - Branches - name: Quality tags: + - Checks - Glossaries - Glossary Terms - Glossary Term Translations diff --git a/paths.yaml b/paths.yaml index 8cd0e974..c9db0a7b 100644 --- a/paths.yaml +++ b/paths.yaml @@ -480,6 +480,12 @@ "$ref": "./paths/blacklisted_keys/update.yaml" delete: "$ref": "./paths/blacklisted_keys/destroy.yaml" +"/projects/{project_id}/checks/issues": + get: + "$ref": "./paths/checks/index.yaml" +"/projects/{project_id}/checks/issues/{id}/dismiss": + patch: + "$ref": "./paths/checks/dismiss.yaml" "/projects/{project_id}/keys": get: "$ref": "./paths/keys/index.yaml" diff --git a/paths/checks/dismiss.yaml b/paths/checks/dismiss.yaml new file mode 100644 index 00000000..9c10345e --- /dev/null +++ b/paths/checks/dismiss.yaml @@ -0,0 +1,54 @@ +--- +summary: Dismiss a check issue +description: Mark a check issue as dismissed so it no longer appears on the list of active check issues. +operationId: check_issue/dismiss +tags: +- Checks +parameters: +- "$ref": "../../parameters.yaml#/X-PhraseApp-OTP" +- "$ref": "../../parameters.yaml#/project_id" +- name: id + in: path + required: true + description: Check Issue ID + schema: + type: string +responses: + '200': + description: OK + content: + application/json: + schema: + "$ref": "../../schemas/check_issue.yaml#/check_issue" + headers: + X-Rate-Limit-Limit: + "$ref": "../../headers.yaml#/X-Rate-Limit-Limit" + X-Rate-Limit-Remaining: + "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining" + X-Rate-Limit-Reset: + "$ref": "../../headers.yaml#/X-Rate-Limit-Reset" + '400': + "$ref": "../../responses.yaml#/400" + '404': + "$ref": "../../responses.yaml#/404" + '401': + "$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. + '422': + "$ref": "../../responses.yaml#/422" + '429': + "$ref": "../../responses.yaml#/429" +x-code-samples: +- lang: Curl + source: |- + curl "https://api.phrase.com/v2/projects/:project_id/checks/issues/:id/dismiss" \ + -u USERNAME_OR_ACCESS_TOKEN \ + -X PATCH +- lang: CLI v2 + source: |- + phrase check_issues dismiss \ + --project_id \ + --id \ + --access_token diff --git a/paths/checks/index.yaml b/paths/checks/index.yaml new file mode 100644 index 00000000..55f9c3bf --- /dev/null +++ b/paths/checks/index.yaml @@ -0,0 +1,85 @@ +--- +summary: List check issues +description: List check issues for the given project. Results can be filtered by locale, check name, and state. +operationId: check_issues/list +tags: +- Checks +parameters: +- "$ref": "../../parameters.yaml#/X-PhraseApp-OTP" +- "$ref": "../../parameters.yaml#/project_id" +- "$ref": "../../parameters.yaml#/page" +- "$ref": "../../parameters.yaml#/per_page" +- description: 'Filter by state of the check issue. Can be one of: `active`, `solved`, `dismissed`, `all`. Defaults to `active`.' + name: state + in: query + required: false + schema: + type: string + default: active + enum: + - active + - solved + - dismissed + - all + example: active +- description: Filter by one or more locale IDs. + name: locale_ids + in: query + required: false + schema: + type: array + items: + type: string + example: + - abcd1234cdef1234abcd1234cdef1234 +- description: Filter by one or more check names. + name: check_names + in: query + required: false + schema: + type: array + items: + type: string + example: + - translation_placeholder_usage +responses: + '200': + description: OK + content: + application/json: + schema: + type: array + items: + "$ref": "../../schemas/check_issue.yaml#/check_issue" + headers: + X-Rate-Limit-Limit: + "$ref": "../../headers.yaml#/X-Rate-Limit-Limit" + X-Rate-Limit-Remaining: + "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining" + X-Rate-Limit-Reset: + "$ref": "../../headers.yaml#/X-Rate-Limit-Reset" + Link: + "$ref": "../../headers.yaml#/Link" + Pagination: + "$ref": "../../headers.yaml#/Pagination" + '400': + "$ref": "../../responses.yaml#/400" + '404': + "$ref": "../../responses.yaml#/404" + '401': + "$ref": "../../responses.yaml#/401" + '403': + "$ref": "../../responses.yaml#/403" + description: Forbidden. Returned when the access token lacks the `read` scope or when the requesting user is not allowed to view check issues in this project. + '429': + "$ref": "../../responses.yaml#/429" +x-code-samples: +- lang: Curl + source: |- + curl "https://api.phrase.com/v2/projects/:project_id/checks/issues" \ + -u USERNAME_OR_ACCESS_TOKEN +- lang: CLI v2 + source: |- + phrase check_issues list \ + --project_id \ + --access_token diff --git a/schemas.yaml b/schemas.yaml index a1584bf0..0cf3d116 100644 --- a/schemas.yaml +++ b/schemas.yaml @@ -6,6 +6,8 @@ schemas: "$ref": schemas/authorization_with_token.yaml#/authorization_with_token blacklisted_key: "$ref": schemas/blacklisted_key.yaml#/blacklisted_key + check_issue: + "$ref": schemas/check_issue.yaml#/check_issue branch_comparison: "$ref": schemas/branch_comparison.yaml#/branch_comparison branch_comparison_diff: diff --git a/schemas/check_issue.yaml b/schemas/check_issue.yaml new file mode 100644 index 00000000..d381c000 --- /dev/null +++ b/schemas/check_issue.yaml @@ -0,0 +1,65 @@ +--- +check_issue: + type: object + title: check_issue + properties: + id: + type: string + check_name: + description: Identifier of the check that reported this issue. + type: string + state: + description: 'Current state of the check issue. One of: `active`, `solved`, `dismissed`.' + type: string + enum: + - active + - solved + - dismissed + description: + description: Human-readable description of the reported issue, always in English. + type: string + dismissed_at: + type: string + format: date-time + nullable: true + solved_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + translation: + "$ref": "./translation.yaml#/translation" + example: + id: abcd1234cdef1234abcd1234cdef1234 + check_name: translation_placeholder_usage + state: active + description: 'The translation contains invalid placeholders. (missing: %{count})' + dismissed_at: null + solved_at: null + created_at: '2015-01-28T09:52:53Z' + updated_at: '2015-01-28T09:52:53Z' + translation: + id: abcd1234cdef1234abcd1234cdef1234 + content: My translation + unverified: false + excluded: false + plural_suffix: '' + key: + id: abcd1234cdef1234abcd1234cdef1234 + name: home.index.headline + plural: false + use_ordinal_rules: false + locale: + id: abcd1234cdef1234abcd1234cdef1234 + name: de + code: de-DE + placeholders: + - "%{count}" + state: translated + created_at: '2015-01-28T09:52:53Z' + updated_at: '2015-01-28T09:52:53Z' From 68a9d58d77fb6532b5dcb05c061925f24ec97546 Mon Sep 17 00:00:00 2001 From: Manuel Boy Date: Wed, 26 Aug 2026 16:36:44 +0200 Subject: [PATCH 2/5] docs(API): document valid check_names values 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) --- doc/compiled.json | 18 ++++++++++++++---- paths/checks/index.yaml | 11 ++++++++++- schemas/check_issue.yaml | 6 +++++- 3 files changed, 29 insertions(+), 6 deletions(-) diff --git a/doc/compiled.json b/doc/compiled.json index 6ca88a99..b3de83a0 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -496,8 +496,13 @@ "type": "string" }, "check_name": { - "description": "Identifier of the check that reported this issue.", - "type": "string" + "description": "Identifier of the check that reported this issue. One of: `translation_content_length`, `translation_placeholder_usage`, `translation_glossary_usage`.", + "type": "string", + "enum": [ + "translation_content_length", + "translation_placeholder_usage", + "translation_glossary_usage" + ] }, "state": { "description": "Current state of the check issue. One of: `active`, `solved`, `dismissed`.", @@ -23575,14 +23580,19 @@ } }, { - "description": "Filter by one or more check names.", + "description": "Filter by one or more check names. Valid values are:\n\n- `translation_content_length` — the translation exceeds the maximum character limit configured for the key.\n- `translation_placeholder_usage` — the translation is missing placeholders present in the source, or contains unexpected ones.\n- `translation_glossary_usage` — the translation does not follow the glossary term translations.", "name": "check_names", "in": "query", "required": false, "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "enum": [ + "translation_content_length", + "translation_placeholder_usage", + "translation_glossary_usage" + ] }, "example": [ "translation_placeholder_usage" diff --git a/paths/checks/index.yaml b/paths/checks/index.yaml index 55f9c3bf..cf98dc39 100644 --- a/paths/checks/index.yaml +++ b/paths/checks/index.yaml @@ -32,7 +32,12 @@ parameters: type: string example: - abcd1234cdef1234abcd1234cdef1234 -- description: Filter by one or more check names. +- description: |- + Filter by one or more check names. Valid values are: + + - `translation_content_length` — the translation exceeds the maximum character limit configured for the key. + - `translation_placeholder_usage` — the translation is missing placeholders present in the source, or contains unexpected ones. + - `translation_glossary_usage` — the translation does not follow the glossary term translations. name: check_names in: query required: false @@ -40,6 +45,10 @@ parameters: type: array items: type: string + enum: + - translation_content_length + - translation_placeholder_usage + - translation_glossary_usage example: - translation_placeholder_usage responses: diff --git a/schemas/check_issue.yaml b/schemas/check_issue.yaml index d381c000..87b8bdfc 100644 --- a/schemas/check_issue.yaml +++ b/schemas/check_issue.yaml @@ -6,8 +6,12 @@ check_issue: id: type: string check_name: - description: Identifier of the check that reported this issue. + description: 'Identifier of the check that reported this issue. One of: `translation_content_length`, `translation_placeholder_usage`, `translation_glossary_usage`.' type: string + enum: + - translation_content_length + - translation_placeholder_usage + - translation_glossary_usage state: description: 'Current state of the check issue. One of: `active`, `solved`, `dismissed`.' type: string From d9672fd3265fd826ddcd5e0060fd3ec98d478d07 Mon Sep 17 00:00:00 2001 From: Manuel Boy Date: Wed, 26 Aug 2026 16:38:29 +0200 Subject: [PATCH 3/5] docs(API): note that check_issue description is display-only 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) --- doc/compiled.json | 2 +- schemas/check_issue.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/compiled.json b/doc/compiled.json index b3de83a0..9e5e1a50 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -514,7 +514,7 @@ ] }, "description": { - "description": "Human-readable description of the reported issue, always in English.", + "description": "Human-readable description of the reported issue, always in English. This message is intended for display only. Its wording may change at any time and it should not be parsed or relied upon programmatically.", "type": "string" }, "dismissed_at": { diff --git a/schemas/check_issue.yaml b/schemas/check_issue.yaml index 87b8bdfc..7a273e68 100644 --- a/schemas/check_issue.yaml +++ b/schemas/check_issue.yaml @@ -20,7 +20,7 @@ check_issue: - solved - dismissed description: - description: Human-readable description of the reported issue, always in English. + description: Human-readable description of the reported issue, always in English. This message is intended for display only. Its wording may change at any time and it should not be parsed or relied upon programmatically. type: string dismissed_at: type: string From c5e9543e86de19d060df0b07f4a70dbc48fffe80 Mon Sep 17 00:00:00 2001 From: Manuel Boy Date: Wed, 26 Aug 2026 16:41:17 +0200 Subject: [PATCH 4/5] docs(API): note that Checks API is still in development 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) --- doc/compiled.json | 2 +- main.yaml | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/compiled.json b/doc/compiled.json index 9e5e1a50..fd3af8d2 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -58,7 +58,7 @@ }, { "name": "Checks", - "description": "The Checks API lets you list the check issues detected in a project and dismiss issues that should no longer appear on the list of active check issues.\n\n#### Available States\n\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
StateDescription
activeThe issue is unresolved and not dismissed.
solvedThe issue has been resolved.
dismissedThe issue has been dismissed by a user.
\n
\n" + "description": "**Note:** The Checks API is still in development and might change in subsequent releases.\n\nThe Checks API lets you list the check issues detected in a project and dismiss issues that should no longer appear on the list of active check issues.\n\n#### Available States\n\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
StateDescription
activeThe issue is unresolved and not dismissed.
solvedThe issue has been resolved.
dismissedThe issue has been dismissed by a user.
\n
\n" }, { "name": "Comments" diff --git a/main.yaml b/main.yaml index 4d38ce59..3d2e1406 100644 --- a/main.yaml +++ b/main.yaml @@ -115,6 +115,8 @@ tags: - name: Checks description: | + **Note:** The Checks API is still in development and might change in subsequent releases. + The Checks API lets you list the check issues detected in a project and dismiss issues that should no longer appear on the list of active check issues. #### Available States From 5d755a285975fcf15d5ac4aefe9d4324f9ad2969 Mon Sep 17 00:00:00 2001 From: Manuel Boy Date: Wed, 26 Aug 2026 16:49:11 +0200 Subject: [PATCH 5/5] docs(API): add development note to Checks endpoints 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) --- doc/compiled.json | 4 ++-- paths/checks/dismiss.yaml | 5 ++++- paths/checks/index.yaml | 5 ++++- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/doc/compiled.json b/doc/compiled.json index fd3af8d2..2fee5c59 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -23529,7 +23529,7 @@ "/projects/{project_id}/checks/issues": { "get": { "summary": "List check issues", - "description": "List check issues for the given project. Results can be filtered by locale, check name, and state.", + "description": "**Note:** The Checks API is still in development and might change in subsequent releases.\n\nList check issues for the given project. Results can be filtered by locale, check name, and state.", "operationId": "check_issues/list", "tags": [ "Checks" @@ -23663,7 +23663,7 @@ "/projects/{project_id}/checks/issues/{id}/dismiss": { "patch": { "summary": "Dismiss a check issue", - "description": "Mark a check issue as dismissed so it no longer appears on the list of active check issues.", + "description": "**Note:** The Checks API is still in development and might change in subsequent releases.\n\nMark a check issue as dismissed so it no longer appears on the list of active check issues.", "operationId": "check_issue/dismiss", "tags": [ "Checks" diff --git a/paths/checks/dismiss.yaml b/paths/checks/dismiss.yaml index 9c10345e..e71b671a 100644 --- a/paths/checks/dismiss.yaml +++ b/paths/checks/dismiss.yaml @@ -1,6 +1,9 @@ --- summary: Dismiss a check issue -description: Mark a check issue as dismissed so it no longer appears on the list of active check issues. +description: |- + **Note:** The Checks API is still in development and might change in subsequent releases. + + Mark a check issue as dismissed so it no longer appears on the list of active check issues. operationId: check_issue/dismiss tags: - Checks diff --git a/paths/checks/index.yaml b/paths/checks/index.yaml index cf98dc39..6dbb09f3 100644 --- a/paths/checks/index.yaml +++ b/paths/checks/index.yaml @@ -1,6 +1,9 @@ --- summary: List check issues -description: List check issues for the given project. Results can be filtered by locale, check name, and state. +description: |- + **Note:** The Checks API is still in development and might change in subsequent releases. + + List check issues for the given project. Results can be filtered by locale, check name, and state. operationId: check_issues/list tags: - Checks