Skip to content

Commit bc9f8b2

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

File tree

2 files changed

+228
-0
lines changed

2 files changed

+228
-0
lines changed

‎openapi.json

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1606,10 +1606,16 @@
16061606
"type": "boolean",
16071607
"default": false,
16081608
"description": ""
1609+
},
1610+
"specificValue": {
1611+
"type": "string",
1612+
"description": "",
1613+
"default": ""
16091614
}
16101615
},
16111616
"required": [
16121617
"result",
1618+
"specificValue",
16131619
"value"
16141620
]
16151621
},
@@ -8802,6 +8808,127 @@
88028808
"x-readme": {}
88038809
}
88048810
},
8811+
"/alert-types": {
8812+
"post": {
8813+
"tags": [
8814+
"Alert Types"
8815+
],
8816+
"summary": "Alert Types Metadata",
8817+
"operationId": "alertTypes",
8818+
"parameters": [
8819+
{
8820+
"name": "language",
8821+
"in": "query",
8822+
"required": false,
8823+
"description": "Language for alert metadata (default: en-US)",
8824+
"schema": {
8825+
"type": "string",
8826+
"enum": [
8827+
"ach-UG",
8828+
"de-DE",
8829+
"en-US",
8830+
"es-ES",
8831+
"fr-FR",
8832+
"it-IT"
8833+
],
8834+
"default": "en-US"
8835+
}
8836+
}
8837+
],
8838+
"requestBody": {
8839+
"content": {
8840+
"application/json": {
8841+
"schema": {
8842+
"type": "array",
8843+
"items": {
8844+
"type": "string",
8845+
"description": "",
8846+
"default": ""
8847+
},
8848+
"description": ""
8849+
}
8850+
}
8851+
},
8852+
"required": false
8853+
},
8854+
"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:",
8856+
"responses": {
8857+
"200": {
8858+
"content": {
8859+
"application/json": {
8860+
"schema": {
8861+
"type": "array",
8862+
"items": {
8863+
"type": "object",
8864+
"additionalProperties": false,
8865+
"description": "",
8866+
"properties": {
8867+
"type": {
8868+
"type": "string",
8869+
"description": "",
8870+
"default": ""
8871+
},
8872+
"title": {
8873+
"type": "string",
8874+
"description": "",
8875+
"default": ""
8876+
},
8877+
"description": {
8878+
"type": "string",
8879+
"description": "",
8880+
"default": ""
8881+
},
8882+
"suggestion": {
8883+
"type": "string",
8884+
"description": "",
8885+
"default": ""
8886+
},
8887+
"emoji": {
8888+
"type": "string",
8889+
"description": "",
8890+
"default": ""
8891+
},
8892+
"nextStepTitle": {
8893+
"type": "string",
8894+
"description": "",
8895+
"default": ""
8896+
},
8897+
"props": {
8898+
"type": "object",
8899+
"additionalProperties": {
8900+
"type": "string",
8901+
"description": "",
8902+
"default": ""
8903+
},
8904+
"properties": {},
8905+
"description": "",
8906+
"nullable": true
8907+
}
8908+
},
8909+
"required": [
8910+
"description",
8911+
"emoji",
8912+
"nextStepTitle",
8913+
"props",
8914+
"suggestion",
8915+
"title",
8916+
"type"
8917+
]
8918+
},
8919+
"description": ""
8920+
}
8921+
}
8922+
},
8923+
"description": "Metadata for the requested alert types"
8924+
},
8925+
"400": {
8926+
"$ref": "#/components/responses/SocketBadRequest"
8927+
}
8928+
},
8929+
"x-readme": {}
8930+
}
8931+
},
88058932
"/orgs/{org_slug}/audit-log": {
88068933
"get": {
88078934
"tags": [

‎types/api.d.ts

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,38 @@ export interface paths {
403403
*/
404404
post: operations['licenseMetadata']
405405
}
406+
'/alert-types': {
407+
/**
408+
* 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+
* ]
431+
*
432+
* This endpoint consumes 1 unit of your quota.
433+
*
434+
* This endpoint requires the following org token scopes:
435+
*/
436+
post: operations['alertTypes']
437+
}
406438
'/orgs/{org_slug}/audit-log': {
407439
/**
408440
* Get Audit Log Events
@@ -1793,6 +1825,8 @@ export interface components {
17931825
result: number
17941826
/** @default false */
17951827
value: boolean
1828+
/** @default */
1829+
specificValue: string
17961830
}
17971831
severity: {
17981832
/** @default 0 */
@@ -4179,6 +4213,73 @@ export interface operations {
41794213
400: components['responses']['SocketBadRequest']
41804214
}
41814215
}
4216+
/**
4217+
* 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+
* ]
4240+
*
4241+
* This endpoint consumes 1 unit of your quota.
4242+
*
4243+
* This endpoint requires the following org token scopes:
4244+
*/
4245+
alertTypes: {
4246+
parameters: {
4247+
query?: {
4248+
/** @description Language for alert metadata (default: en-US) */
4249+
language?: 'ach-UG' | 'de-DE' | 'en-US' | 'es-ES' | 'fr-FR' | 'it-IT'
4250+
}
4251+
}
4252+
requestBody?: {
4253+
content: {
4254+
'application/json': string[]
4255+
}
4256+
}
4257+
responses: {
4258+
/** @description Metadata for the requested alert types */
4259+
200: {
4260+
content: {
4261+
'application/json': Array<{
4262+
/** @default */
4263+
type: string
4264+
/** @default */
4265+
title: string
4266+
/** @default */
4267+
description: string
4268+
/** @default */
4269+
suggestion: string
4270+
/** @default */
4271+
emoji: string
4272+
/** @default */
4273+
nextStepTitle: string
4274+
props: {
4275+
[key: string]: string
4276+
} | null
4277+
}>
4278+
}
4279+
}
4280+
400: components['responses']['SocketBadRequest']
4281+
}
4282+
}
41824283
/**
41834284
* Get Audit Log Events
41844285
* @description Paginated list of audit log events.

0 commit comments

Comments
 (0)