Skip to content

Commit abfff31

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent f5d3342 commit abfff31

12 files changed

Lines changed: 3921 additions & 0 deletions

‎descriptions/api.github.com/api.github.com.2022-11-28.json‎

Lines changed: 351 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49160,6 +49160,148 @@
4916049160
}
4916149161
}
4916249162
},
49163+
"/repos/{owner}/{repo}/code-quality/setup": {
49164+
"get": {
49165+
"summary": "Get a code quality setup configuration",
49166+
"description": "Gets a code quality setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
49167+
"tags": [
49168+
"code-quality"
49169+
],
49170+
"operationId": "code-quality/get-setup",
49171+
"externalDocs": {
49172+
"description": "API method documentation",
49173+
"url": "https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-setup-configuration"
49174+
},
49175+
"parameters": [
49176+
{
49177+
"$ref": "#/components/parameters/owner"
49178+
},
49179+
{
49180+
"$ref": "#/components/parameters/repo"
49181+
}
49182+
],
49183+
"responses": {
49184+
"200": {
49185+
"description": "Response",
49186+
"content": {
49187+
"application/json": {
49188+
"schema": {
49189+
"$ref": "#/components/schemas/code-quality-setup"
49190+
},
49191+
"examples": {
49192+
"default": {
49193+
"$ref": "#/components/examples/code-quality-setup"
49194+
}
49195+
}
49196+
}
49197+
}
49198+
},
49199+
"403": {
49200+
"$ref": "#/components/responses/code_quality_forbidden_read"
49201+
},
49202+
"404": {
49203+
"$ref": "#/components/responses/not_found"
49204+
},
49205+
"503": {
49206+
"$ref": "#/components/responses/service_unavailable"
49207+
}
49208+
},
49209+
"x-github": {
49210+
"githubCloudOnly": false,
49211+
"enabledForGitHubApps": true,
49212+
"category": "code-quality",
49213+
"subcategory": "code-quality"
49214+
}
49215+
},
49216+
"patch": {
49217+
"summary": "Update a code quality setup configuration",
49218+
"description": "Updates a code quality setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
49219+
"tags": [
49220+
"code-quality"
49221+
],
49222+
"operationId": "code-quality/update-setup",
49223+
"externalDocs": {
49224+
"description": "API method documentation",
49225+
"url": "https://docs.github.com/rest/code-quality/code-quality#update-a-code-quality-setup-configuration"
49226+
},
49227+
"parameters": [
49228+
{
49229+
"$ref": "#/components/parameters/owner"
49230+
},
49231+
{
49232+
"$ref": "#/components/parameters/repo"
49233+
}
49234+
],
49235+
"requestBody": {
49236+
"required": true,
49237+
"content": {
49238+
"application/json": {
49239+
"schema": {
49240+
"$ref": "#/components/schemas/code-quality-setup-update"
49241+
},
49242+
"examples": {
49243+
"default": {
49244+
"$ref": "#/components/examples/code-quality-setup-update"
49245+
}
49246+
}
49247+
}
49248+
}
49249+
},
49250+
"responses": {
49251+
"200": {
49252+
"description": "Response",
49253+
"content": {
49254+
"application/json": {
49255+
"schema": {
49256+
"$ref": "#/components/schemas/empty-object"
49257+
},
49258+
"examples": {
49259+
"default": {
49260+
"value": null
49261+
}
49262+
}
49263+
}
49264+
}
49265+
},
49266+
"202": {
49267+
"description": "Response",
49268+
"content": {
49269+
"application/json": {
49270+
"schema": {
49271+
"$ref": "#/components/schemas/code-quality-setup-update-response"
49272+
},
49273+
"examples": {
49274+
"default": {
49275+
"$ref": "#/components/examples/code-quality-setup-update-response"
49276+
}
49277+
}
49278+
}
49279+
}
49280+
},
49281+
"403": {
49282+
"$ref": "#/components/responses/code_quality_forbidden_write"
49283+
},
49284+
"404": {
49285+
"$ref": "#/components/responses/not_found"
49286+
},
49287+
"409": {
49288+
"$ref": "#/components/responses/code_quality_conflict"
49289+
},
49290+
"422": {
49291+
"$ref": "#/components/responses/code_quality_invalid_state"
49292+
},
49293+
"503": {
49294+
"$ref": "#/components/responses/service_unavailable"
49295+
}
49296+
},
49297+
"x-github": {
49298+
"githubCloudOnly": false,
49299+
"enabledForGitHubApps": true,
49300+
"category": "code-quality",
49301+
"subcategory": "code-quality"
49302+
}
49303+
}
49304+
},
4916349305
"/repos/{owner}/{repo}/code-scanning/alerts": {
4916449306
"get": {
4916549307
"summary": "List code scanning alerts for a repository",
@@ -137725,6 +137867,146 @@
137725137867
}
137726137868
}
137727137869
},
137870+
"code-quality-setup": {
137871+
"description": "Configuration for code quality setup.",
137872+
"type": "object",
137873+
"properties": {
137874+
"state": {
137875+
"description": "Code quality setup has been configured or not.",
137876+
"type": "string",
137877+
"enum": [
137878+
"configured",
137879+
"not-configured"
137880+
]
137881+
},
137882+
"languages": {
137883+
"description": "Languages to be analyzed.",
137884+
"type": "array",
137885+
"items": {
137886+
"type": "string",
137887+
"enum": [
137888+
"csharp",
137889+
"go",
137890+
"java-kotlin",
137891+
"javascript-typescript",
137892+
"python",
137893+
"ruby",
137894+
"rust"
137895+
]
137896+
}
137897+
},
137898+
"runner_type": {
137899+
"description": "Runner type to be used.",
137900+
"nullable": true,
137901+
"type": "string",
137902+
"enum": [
137903+
"standard",
137904+
"labeled"
137905+
]
137906+
},
137907+
"runner_label": {
137908+
"description": "Runner label to be used if the runner type is labeled.",
137909+
"nullable": true,
137910+
"type": "string",
137911+
"example": "code-scanning"
137912+
},
137913+
"updated_at": {
137914+
"description": "Timestamp of latest configuration update.",
137915+
"nullable": true,
137916+
"type": "string",
137917+
"format": "date-time",
137918+
"example": "2023-12-06T14:20:20.000Z"
137919+
},
137920+
"schedule": {
137921+
"description": "The frequency of the periodic analysis.",
137922+
"nullable": true,
137923+
"type": "string",
137924+
"enum": [
137925+
"weekly"
137926+
]
137927+
}
137928+
}
137929+
},
137930+
"code-quality-setup-update": {
137931+
"description": "Configuration for code quality setup.",
137932+
"type": "object",
137933+
"properties": {
137934+
"state": {
137935+
"description": "The desired state of code quality setup.",
137936+
"type": "string",
137937+
"enum": [
137938+
"configured",
137939+
"not-configured"
137940+
]
137941+
},
137942+
"runner_type": {
137943+
"description": "Runner type to be used.",
137944+
"type": "string",
137945+
"enum": [
137946+
"standard",
137947+
"labeled"
137948+
]
137949+
},
137950+
"runner_label": {
137951+
"nullable": true,
137952+
"description": "Runner label to be used if the runner type is labeled.",
137953+
"type": "string",
137954+
"example": "code-scanning"
137955+
},
137956+
"languages": {
137957+
"description": "Languages to be analyzed.",
137958+
"type": "array",
137959+
"items": {
137960+
"type": "string",
137961+
"enum": [
137962+
"csharp",
137963+
"go",
137964+
"java-kotlin",
137965+
"javascript-typescript",
137966+
"python",
137967+
"ruby"
137968+
]
137969+
}
137970+
}
137971+
},
137972+
"anyOf": [
137973+
{
137974+
"required": [
137975+
"state"
137976+
]
137977+
},
137978+
{
137979+
"required": [
137980+
"runner_type"
137981+
]
137982+
},
137983+
{
137984+
"required": [
137985+
"runner_label"
137986+
]
137987+
},
137988+
{
137989+
"required": [
137990+
"languages"
137991+
]
137992+
}
137993+
],
137994+
"additionalProperties": false
137995+
},
137996+
"code-quality-setup-update-response": {
137997+
"description": "You can use `run_url` to track the status of the run. This includes a property status and conclusion.\nYou should not rely on this always being an actions workflow run object.",
137998+
"type": "object",
137999+
"properties": {
138000+
"run_id": {
138001+
"description": "ID of the corresponding run.",
138002+
"type": "integer"
138003+
},
138004+
"run_url": {
138005+
"description": "URL of the corresponding run.",
138006+
"type": "string"
138007+
}
138008+
}
138009+
},
137728138010
"code-scanning-alert-items": {
137729138011
"type": "object",
137730138012
"properties": {
@@ -311934,6 +312216,35 @@
311934312216
]
311935312217
}
311936312218
},
312219+
"code-quality-setup": {
312220+
"value": {
312221+
"state": "configured",
312222+
"languages": [
312223+
"javascript-typescript",
312224+
"python"
312225+
],
312226+
"runner_type": "standard",
312227+
"runner_label": null,
312228+
"updated_at": "2023-01-01T00:00:00Z",
312229+
"schedule": "weekly"
312230+
}
312231+
},
312232+
"code-quality-setup-update": {
312233+
"value": {
312234+
"state": "configured",
312235+
"languages": [
312236+
"javascript-typescript",
312237+
"python",
312238+
"ruby"
312239+
]
312240+
}
312241+
},
312242+
"code-quality-setup-update-response": {
312243+
"value": {
312244+
"run_id": 42,
312245+
"run_url": "https://api.github.com/repos/octocat/hello-world/actions/runs/42"
312246+
}
312247+
},
311937312248
"code-scanning-alert-items": {
311938312249
"value": [
311939312250
{
@@ -331017,6 +331328,46 @@
331017331328
}
331018331329
}
331019331330
},
331331+
"code_quality_forbidden_read": {
331332+
"description": "Response if the user is not authorized to access Code quality for this repository.",
331333+
"content": {
331334+
"application/json": {
331335+
"schema": {
331336+
"$ref": "#/components/schemas/basic-error"
331337+
}
331338+
}
331339+
}
331340+
},
331341+
"code_quality_forbidden_write": {
331342+
"description": "Response if the repository is archived or if Code quality is not enabled for this repository",
331343+
"content": {
331344+
"application/json": {
331345+
"schema": {
331346+
"$ref": "#/components/schemas/basic-error"
331347+
}
331348+
}
331349+
}
331350+
},
331351+
"code_quality_conflict": {
331352+
"description": "Response if there is already a code quality setup configuration update in progress",
331353+
"content": {
331354+
"application/json": {
331355+
"schema": {
331356+
"$ref": "#/components/schemas/basic-error"
331357+
}
331358+
}
331359+
}
331360+
},
331361+
"code_quality_invalid_state": {
331362+
"description": "Response if the configuration change cannot be made",
331363+
"content": {
331364+
"application/json": {
331365+
"schema": {
331366+
"$ref": "#/components/schemas/basic-error"
331367+
}
331368+
}
331369+
}
331370+
},
331020331371
"code_scanning_forbidden_read": {
331021331372
"description": "Response if GitHub Advanced Security is not enabled for this repository",
331022331373
"content": {

0 commit comments

Comments
 (0)