Skip to content

Commit 133d385

Browse files
jencarluccijencarlucci
committed
Merge branch 'pr-6462'
2 parents 532b49d + 21b9438 commit 133d385

12 files changed

Lines changed: 4089 additions & 0 deletions

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

Lines changed: 369 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49368,6 +49368,148 @@
4936849368
}
4936949369
}
4937049370
},
49371+
"/repos/{owner}/{repo}/code-quality/setup": {
49372+
"get": {
49373+
"summary": "Get a code quality setup configuration",
49374+
"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.",
49375+
"tags": [
49376+
"code-quality"
49377+
],
49378+
"operationId": "code-quality/get-setup",
49379+
"externalDocs": {
49380+
"description": "API method documentation",
49381+
"url": "https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-setup-configuration"
49382+
},
49383+
"parameters": [
49384+
{
49385+
"$ref": "#/components/parameters/owner"
49386+
},
49387+
{
49388+
"$ref": "#/components/parameters/repo"
49389+
}
49390+
],
49391+
"responses": {
49392+
"200": {
49393+
"description": "Response",
49394+
"content": {
49395+
"application/json": {
49396+
"schema": {
49397+
"$ref": "#/components/schemas/code-quality-setup"
49398+
},
49399+
"examples": {
49400+
"default": {
49401+
"$ref": "#/components/examples/code-quality-setup"
49402+
}
49403+
}
49404+
}
49405+
}
49406+
},
49407+
"403": {
49408+
"$ref": "#/components/responses/code_quality_forbidden_read"
49409+
},
49410+
"404": {
49411+
"$ref": "#/components/responses/not_found"
49412+
},
49413+
"503": {
49414+
"$ref": "#/components/responses/service_unavailable"
49415+
}
49416+
},
49417+
"x-github": {
49418+
"githubCloudOnly": false,
49419+
"enabledForGitHubApps": true,
49420+
"category": "code-quality",
49421+
"subcategory": "code-quality"
49422+
}
49423+
},
49424+
"patch": {
49425+
"summary": "Update a code quality setup configuration",
49426+
"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.",
49427+
"tags": [
49428+
"code-quality"
49429+
],
49430+
"operationId": "code-quality/update-setup",
49431+
"externalDocs": {
49432+
"description": "API method documentation",
49433+
"url": "https://docs.github.com/rest/code-quality/code-quality#update-a-code-quality-setup-configuration"
49434+
},
49435+
"parameters": [
49436+
{
49437+
"$ref": "#/components/parameters/owner"
49438+
},
49439+
{
49440+
"$ref": "#/components/parameters/repo"
49441+
}
49442+
],
49443+
"requestBody": {
49444+
"required": true,
49445+
"content": {
49446+
"application/json": {
49447+
"schema": {
49448+
"$ref": "#/components/schemas/code-quality-setup-update"
49449+
},
49450+
"examples": {
49451+
"default": {
49452+
"$ref": "#/components/examples/code-quality-setup-update"
49453+
}
49454+
}
49455+
}
49456+
}
49457+
},
49458+
"responses": {
49459+
"200": {
49460+
"description": "Response",
49461+
"content": {
49462+
"application/json": {
49463+
"schema": {
49464+
"$ref": "#/components/schemas/empty-object"
49465+
},
49466+
"examples": {
49467+
"default": {
49468+
"value": null
49469+
}
49470+
}
49471+
}
49472+
}
49473+
},
49474+
"202": {
49475+
"description": "Response",
49476+
"content": {
49477+
"application/json": {
49478+
"schema": {
49479+
"$ref": "#/components/schemas/code-quality-setup-update-response"
49480+
},
49481+
"examples": {
49482+
"default": {
49483+
"$ref": "#/components/examples/code-quality-setup-update-response"
49484+
}
49485+
}
49486+
}
49487+
}
49488+
},
49489+
"403": {
49490+
"$ref": "#/components/responses/code_quality_forbidden_write"
49491+
},
49492+
"404": {
49493+
"$ref": "#/components/responses/not_found"
49494+
},
49495+
"409": {
49496+
"$ref": "#/components/responses/code_quality_conflict"
49497+
},
49498+
"422": {
49499+
"$ref": "#/components/responses/code_quality_invalid_state"
49500+
},
49501+
"503": {
49502+
"$ref": "#/components/responses/service_unavailable"
49503+
}
49504+
},
49505+
"x-github": {
49506+
"githubCloudOnly": false,
49507+
"enabledForGitHubApps": true,
49508+
"category": "code-quality",
49509+
"subcategory": "code-quality"
49510+
}
49511+
}
49512+
},
4937149513
"/repos/{owner}/{repo}/code-scanning/alerts": {
4937249514
"get": {
4937349515
"summary": "List code scanning alerts for a repository",
@@ -140271,6 +140413,164 @@
140271140413
}
140272140414
}
140273140415
},
140416+
"code-quality-setup": {
140417+
"description": "Configuration for code quality setup.",
140418+
"type": "object",
140419+
"properties": {
140420+
"state": {
140421+
"description": "Code quality setup has been configured or not.",
140422+
"type": "string",
140423+
"enum": [
140424+
"configured",
140425+
"not-configured"
140426+
]
140427+
},
140428+
"languages": {
140429+
"description": "Languages to be analyzed.",
140430+
"type": "array",
140431+
"items": {
140432+
"type": "string",
140433+
"enum": [
140434+
"csharp",
140435+
"go",
140436+
"java-kotlin",
140437+
"javascript-typescript",
140438+
"python",
140439+
"ruby",
140440+
"rust"
140441+
]
140442+
}
140443+
},
140444+
"runner_type": {
140445+
"description": "Runner type to be used.",
140446+
"type": [
140447+
"string",
140448+
"null"
140449+
],
140450+
"enum": [
140451+
"standard",
140452+
"labeled",
140453+
null
140454+
]
140455+
},
140456+
"runner_label": {
140457+
"description": "Runner label to be used if the runner type is labeled.",
140458+
"type": [
140459+
"string",
140460+
"null"
140461+
],
140462+
"examples": [
140463+
"code-scanning"
140464+
]
140465+
},
140466+
"updated_at": {
140467+
"description": "Timestamp of latest configuration update.",
140468+
"type": [
140469+
"string",
140470+
"null"
140471+
],
140472+
"format": "date-time",
140473+
"examples": [
140474+
"2023-12-06T14:20:20.000Z"
140475+
]
140476+
},
140477+
"schedule": {
140478+
"description": "The frequency of the periodic analysis.",
140479+
"type": [
140480+
"string",
140481+
"null"
140482+
],
140483+
"enum": [
140484+
"weekly",
140485+
null
140486+
]
140487+
}
140488+
}
140489+
},
140490+
"code-quality-setup-update": {
140491+
"description": "Configuration for code quality setup.",
140492+
"type": "object",
140493+
"properties": {
140494+
"state": {
140495+
"description": "The desired state of code quality setup.",
140496+
"type": "string",
140497+
"enum": [
140498+
"configured",
140499+
"not-configured"
140500+
]
140501+
},
140502+
"runner_type": {
140503+
"description": "Runner type to be used.",
140504+
"type": "string",
140505+
"enum": [
140506+
"standard",
140507+
"labeled"
140508+
]
140509+
},
140510+
"runner_label": {
140511+
"description": "Runner label to be used if the runner type is labeled.",
140512+
"type": [
140513+
"string",
140514+
"null"
140515+
],
140516+
"examples": [
140517+
"code-scanning"
140518+
]
140519+
},
140520+
"languages": {
140521+
"description": "Languages to be analyzed.",
140522+
"type": "array",
140523+
"items": {
140524+
"type": "string",
140525+
"enum": [
140526+
"csharp",
140527+
"go",
140528+
"java-kotlin",
140529+
"javascript-typescript",
140530+
"python",
140531+
"ruby"
140532+
]
140533+
}
140534+
}
140535+
},
140536+
"anyOf": [
140537+
{
140538+
"required": [
140539+
"state"
140540+
]
140541+
},
140542+
{
140543+
"required": [
140544+
"runner_type"
140545+
]
140546+
},
140547+
{
140548+
"required": [
140549+
"runner_label"
140550+
]
140551+
},
140552+
{
140553+
"required": [
140554+
"languages"
140555+
]
140556+
}
140557+
],
140558+
"additionalProperties": false
140559+
},
140560+
"code-quality-setup-update-response": {
140561+
"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.",
140562+
"type": "object",
140563+
"properties": {
140564+
"run_id": {
140565+
"description": "ID of the corresponding run.",
140566+
"type": "integer"
140567+
},
140568+
"run_url": {
140569+
"description": "URL of the corresponding run.",
140570+
"type": "string"
140571+
}
140572+
}
140573+
},
140274140574
"code-scanning-alert-items": {
140275140575
"type": "object",
140276140576
"properties": {
@@ -321125,6 +321425,35 @@
321125321425
]
321126321426
}
321127321427
},
321428+
"code-quality-setup": {
321429+
"value": {
321430+
"state": "configured",
321431+
"languages": [
321432+
"javascript-typescript",
321433+
"python"
321434+
],
321435+
"runner_type": "standard",
321436+
"runner_label": null,
321437+
"updated_at": "2023-01-01T00:00:00Z",
321438+
"schedule": "weekly"
321439+
}
321440+
},
321441+
"code-quality-setup-update": {
321442+
"value": {
321443+
"state": "configured",
321444+
"languages": [
321445+
"javascript-typescript",
321446+
"python",
321447+
"ruby"
321448+
]
321449+
}
321450+
},
321451+
"code-quality-setup-update-response": {
321452+
"value": {
321453+
"run_id": 42,
321454+
"run_url": "https://api.github.com/repos/octocat/hello-world/actions/runs/42"
321455+
}
321456+
},
321128321457
"code-scanning-alert-items": {
321129321458
"value": [
321130321459
{
@@ -340222,6 +340551,46 @@
340222340551
}
340223340552
}
340224340553
},
340554+
"code_quality_forbidden_read": {
340555+
"description": "Response if the user is not authorized to access Code quality for this repository.",
340556+
"content": {
340557+
"application/json": {
340558+
"schema": {
340559+
"$ref": "#/components/schemas/basic-error"
340560+
}
340561+
}
340562+
}
340563+
},
340564+
"code_quality_forbidden_write": {
340565+
"description": "Response if the repository is archived or if Code quality is not enabled for this repository",
340566+
"content": {
340567+
"application/json": {
340568+
"schema": {
340569+
"$ref": "#/components/schemas/basic-error"
340570+
}
340571+
}
340572+
}
340573+
},
340574+
"code_quality_conflict": {
340575+
"description": "Response if there is already a code quality setup configuration update in progress",
340576+
"content": {
340577+
"application/json": {
340578+
"schema": {
340579+
"$ref": "#/components/schemas/basic-error"
340580+
}
340581+
}
340582+
}
340583+
},
340584+
"code_quality_invalid_state": {
340585+
"description": "Response if the configuration change cannot be made",
340586+
"content": {
340587+
"application/json": {
340588+
"schema": {
340589+
"$ref": "#/components/schemas/basic-error"
340590+
}
340591+
}
340592+
}
340593+
},
340225340594
"code_scanning_forbidden_read": {
340226340595
"description": "Response if GitHub Advanced Security is not enabled for this repository",
340227340596
"content": {

0 commit comments

Comments
 (0)