Skip to content

Commit 15de668

Browse files
fix(openapi): sync with openapi definition (#331)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 23f9c3c commit 15de668

File tree

2 files changed

+6
-48
lines changed

2 files changed

+6
-48
lines changed

openapi.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8820,7 +8820,7 @@
88208820
"name": "language",
88218821
"in": "query",
88228822
"required": false,
8823-
"description": "Language for alert metadata (default: en-US)",
8823+
"description": "Language for alert metadata",
88248824
"schema": {
88258825
"type": "string",
88268826
"enum": [
@@ -8852,7 +8852,7 @@
88528852
"required": false
88538853
},
88548854
"security": [],
8855-
"description": "For an array of alert type identifiers, returns metadata for each alert type. Optionally, specify a language via the 'language' query parameter (default: 'en-US').\n\n## Query parameter\n- language: string (optional, default: 'en-US')\n\nExample request body:\n[\n \"badEncoding\",\n \"badSemver\"\n]\n\nExample response:\n[\n {\n \"type\": \"badEncoding\",\n \"title\": \"Bad text encoding\",\n \"description\": \"Source files are encoded using a non-standard text encoding.\",\n \"suggestion\": \"Ensure all published files are encoded using a standard encoding such as UTF8, UTF16, UTF32, SHIFT-JIS, etc.\",\n \"emoji\": \"⚠️\",\n \"nextStepTitle\": \"What is bad text encoding?\"\n }\n]\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:",
8855+
"description": "For an array of alert type identifiers, returns metadata for each alert type. Optionally, specify a language via the 'language' query parameter.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:",
88568856
"responses": {
88578857
"200": {
88588858
"content": {
@@ -30660,7 +30660,7 @@
3066030660
"description": "",
3066130661
"default": 50,
3066230662
"minimum": 1,
30663-
"maximum": 1000
30663+
"maximum": 100
3066430664
},
3066530665
"offset": {
3066630666
"type": "integer",

types/api.d.ts

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -406,28 +406,7 @@ export interface paths {
406406
'/alert-types': {
407407
/**
408408
* Alert Types Metadata
409-
* @description For an array of alert type identifiers, returns metadata for each alert type. Optionally, specify a language via the 'language' query parameter (default: 'en-US').
410-
*
411-
* ## Query parameter
412-
* - language: string (optional, default: 'en-US')
413-
*
414-
* Example request body:
415-
* [
416-
* "badEncoding",
417-
* "badSemver"
418-
* ]
419-
*
420-
* Example response:
421-
* [
422-
* {
423-
* "type": "badEncoding",
424-
* "title": "Bad text encoding",
425-
* "description": "Source files are encoded using a non-standard text encoding.",
426-
* "suggestion": "Ensure all published files are encoded using a standard encoding such as UTF8, UTF16, UTF32, SHIFT-JIS, etc.",
427-
* "emoji": "⚠️",
428-
* "nextStepTitle": "What is bad text encoding?"
429-
* }
430-
* ]
409+
* @description For an array of alert type identifiers, returns metadata for each alert type. Optionally, specify a language via the 'language' query parameter.
431410
*
432411
* This endpoint consumes 1 unit of your quota.
433412
*
@@ -4215,28 +4194,7 @@ export interface operations {
42154194
}
42164195
/**
42174196
* Alert Types Metadata
4218-
* @description For an array of alert type identifiers, returns metadata for each alert type. Optionally, specify a language via the 'language' query parameter (default: 'en-US').
4219-
*
4220-
* ## Query parameter
4221-
* - language: string (optional, default: 'en-US')
4222-
*
4223-
* Example request body:
4224-
* [
4225-
* "badEncoding",
4226-
* "badSemver"
4227-
* ]
4228-
*
4229-
* Example response:
4230-
* [
4231-
* {
4232-
* "type": "badEncoding",
4233-
* "title": "Bad text encoding",
4234-
* "description": "Source files are encoded using a non-standard text encoding.",
4235-
* "suggestion": "Ensure all published files are encoded using a standard encoding such as UTF8, UTF16, UTF32, SHIFT-JIS, etc.",
4236-
* "emoji": "⚠️",
4237-
* "nextStepTitle": "What is bad text encoding?"
4238-
* }
4239-
* ]
4197+
* @description For an array of alert type identifiers, returns metadata for each alert type. Optionally, specify a language via the 'language' query parameter.
42404198
*
42414199
* This endpoint consumes 1 unit of your quota.
42424200
*
@@ -4245,7 +4203,7 @@ export interface operations {
42454203
alertTypes: {
42464204
parameters: {
42474205
query?: {
4248-
/** @description Language for alert metadata (default: en-US) */
4206+
/** @description Language for alert metadata */
42494207
language?: 'ach-UG' | 'de-DE' | 'en-US' | 'es-ES' | 'fr-FR' | 'it-IT'
42504208
}
42514209
}

0 commit comments

Comments
 (0)