Skip to content

Commit 9116938

Browse files
authored
Merge pull request #782 from github/openapi-update-2bb36b41f26d446f92cddb1bfbcfc99b4bb6bc3c05f3aca0eb23476d37598b33
Update OpenAPI 3.0 Descriptions
2 parents 87e12a8 + 452b7ce commit 9116938

File tree

12 files changed

+970
-800
lines changed

12 files changed

+970
-800
lines changed

descriptions/api.github.com/api.github.com.json

Lines changed: 56 additions & 7 deletions
Large diffs are not rendered by default.

descriptions/api.github.com/api.github.com.yaml

Lines changed: 49 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2968,7 +2968,7 @@ paths:
29682968
"$ref": "#/components/responses/code_scanning_forbidden_read"
29692969
x-github:
29702970
githubCloudOnly: false
2971-
enabledForGitHubApps: true
2971+
enabledForGitHubApps: false
29722972
previews: []
29732973
category: enterprise-admin
29742974
subcategory: billing
@@ -17714,6 +17714,18 @@ paths:
1771417714
- "$ref": "#/components/parameters/page"
1771517715
- "$ref": "#/components/parameters/per-page"
1771617716
- "$ref": "#/components/parameters/git-ref"
17717+
- "$ref": "#/components/parameters/direction"
17718+
- name: sort
17719+
description: Can be one of `created`, `updated`, `number`.
17720+
in: query
17721+
required: false
17722+
schema:
17723+
type: string
17724+
enum:
17725+
- created
17726+
- updated
17727+
- number
17728+
default: number
1771717729
- name: state
1771817730
description: Set to `open`, `fixed`, or `dismissed` to list code scanning
1771917731
alerts in a specific state.
@@ -17790,8 +17802,10 @@ paths:
1779017802
patch:
1779117803
summary: Update a code scanning alert
1779217804
description: Updates the status of a single code scanning alert. You must use
17793-
an access token with the `security_events` scope to use this endpoint. GitHub
17794-
Apps must have the `security_events` write permission to use this endpoint.
17805+
an access token with the `security_events` scope to use this endpoint with
17806+
private repositories. You can also use tokens with the `public_repo` scope
17807+
for public repositories only. GitHub Apps must have the `security_events`
17808+
write permission to use this endpoint.
1779517809
operationId: code-scanning/update-alert
1779617810
tags:
1779717811
- code-scanning
@@ -18019,7 +18033,7 @@ paths:
1801918033
description: |-
1802018034
Deletes a specified code scanning analysis from a repository. For
1802118035
private repositories, you must use an access token with the `repo` scope. For public repositories,
18022-
you must use an access token with `public_repo` and `repo:security_events` scopes.
18036+
you must use an access token with `public_repo` scope.
1802318037
GitHub Apps must have the `security_events` write permission to use this endpoint.
1802418038

1802518039
You can delete one analysis at a time.
@@ -18136,7 +18150,7 @@ paths:
1813618150
post:
1813718151
summary: Upload an analysis as SARIF data
1813818152
description: |-
18139-
Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.
18153+
Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.
1814018154

1814118155
There are two places where you can upload code scanning results.
1814218156
- If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
@@ -24823,8 +24837,7 @@ paths:
2482324837
"/repos/{owner}/{repo}/lfs":
2482424838
put:
2482524839
summary: Enable Git LFS for a repository
24826-
description: "**Note:** The Git LFS API endpoints are currently in beta and
24827-
are subject to change."
24840+
description: ''
2482824841
operationId: repos/enable-lfs-for-repo
2482924842
tags:
2483024843
- repos
@@ -24851,8 +24864,7 @@ paths:
2485124864
subcategory: lfs
2485224865
delete:
2485324866
summary: Disable Git LFS for a repository
24854-
description: "**Note:** The Git LFS API endpoints are currently in beta and
24855-
are subject to change."
24867+
description: ''
2485624868
operationId: repos/disable-lfs-for-repo
2485724869
tags:
2485824870
- repos
@@ -24904,10 +24916,8 @@ paths:
2490424916
"/repos/{owner}/{repo}/merge-upstream":
2490524917
post:
2490624918
summary: Sync a fork branch with the upstream repository
24907-
description: |-
24908-
**Note:** This endpoint is currently in beta and subject to change.
24909-
24910-
Sync a branch of a forked repository to keep it up-to-date with the upstream repository.
24919+
description: Sync a branch of a forked repository to keep it up-to-date with
24920+
the upstream repository.
2491124921
tags:
2491224922
- repos
2491324923
operationId: repos/merge-upstream
@@ -48199,11 +48209,23 @@ components:
4819948209
- closed
4820048210
- dismissed
4820148211
- fixed
48212+
alert-updated-at:
48213+
type: string
48214+
description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
48215+
format: date-time
48216+
readOnly: true
4820248217
alert-instances-url:
4820348218
type: string
4820448219
description: The REST API URL for fetching the list of instances for an alert.
4820548220
format: uri
4820648221
readOnly: true
48222+
code-scanning-alert-fixed-at:
48223+
type: string
48224+
description: 'The time that the alert was no longer detected and was considered
48225+
fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
48226+
format: date-time
48227+
readOnly: true
48228+
nullable: true
4820748229
code-scanning-alert-dismissed-at:
4820848230
type: string
4820948231
description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
@@ -48332,6 +48354,8 @@ components:
4833248354
"$ref": "#/components/schemas/alert-number"
4833348355
created_at:
4833448356
"$ref": "#/components/schemas/alert-created-at"
48357+
updated_at:
48358+
"$ref": "#/components/schemas/alert-updated-at"
4833548359
url:
4833648360
"$ref": "#/components/schemas/alert-url"
4833748361
html_url:
@@ -48340,6 +48364,8 @@ components:
4834048364
"$ref": "#/components/schemas/alert-instances-url"
4834148365
state:
4834248366
"$ref": "#/components/schemas/code-scanning-alert-state"
48367+
fixed_at:
48368+
"$ref": "#/components/schemas/code-scanning-alert-fixed-at"
4834348369
dismissed_by:
4834448370
"$ref": "#/components/schemas/nullable-simple-user"
4834548371
dismissed_at:
@@ -48416,6 +48442,8 @@ components:
4841648442
"$ref": "#/components/schemas/alert-number"
4841748443
created_at:
4841848444
"$ref": "#/components/schemas/alert-created-at"
48445+
updated_at:
48446+
"$ref": "#/components/schemas/alert-updated-at"
4841948447
url:
4842048448
"$ref": "#/components/schemas/alert-url"
4842148449
html_url:
@@ -48424,6 +48452,8 @@ components:
4842448452
"$ref": "#/components/schemas/alert-instances-url"
4842548453
state:
4842648454
"$ref": "#/components/schemas/code-scanning-alert-state"
48455+
fixed_at:
48456+
"$ref": "#/components/schemas/code-scanning-alert-fixed-at"
4842748457
dismissed_by:
4842848458
"$ref": "#/components/schemas/nullable-simple-user"
4842948459
dismissed_at:
@@ -65251,6 +65281,7 @@ components:
6525165281
url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4
6525265282
html_url: https://github.com/octocat/hello-world/code-scanning/4
6525365283
state: open
65284+
fixed_at:
6525465285
dismissed_by:
6525565286
dismissed_at:
6525665287
dismissed_reason:
@@ -65285,6 +65316,7 @@ components:
6528565316
url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3
6528665317
html_url: https://github.com/octocat/hello-world/code-scanning/3
6528765318
state: dismissed
65319+
fixed_at:
6528865320
dismissed_by:
6528965321
login: octocat
6529065322
id: 1
@@ -65338,6 +65370,7 @@ components:
6533865370
url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42
6533965371
html_url: https://github.com/octocat/hello-world/code-scanning/42
6534065372
state: dismissed
65373+
fixed_at:
6534165374
dismissed_by:
6534265375
login: octocat
6534365376
id: 54933897
@@ -65403,6 +65436,7 @@ components:
6540365436
url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42
6540465437
html_url: https://github.com/octocat/hello-world/code-scanning/42
6540565438
state: dismissed
65439+
fixed_at:
6540665440
dismissed_by:
6540765441
login: octocat
6540865442
id: 1
@@ -65467,6 +65501,7 @@ components:
6546765501
analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build"
6546865502
environment: ''
6546965503
state: open
65504+
fixed_at:
6547065505
commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930
6547165506
message:
6547265507
text: This path depends on a user-provided value.
@@ -65483,6 +65518,7 @@ components:
6548365518
environment: ''
6548465519
category: ".github/workflows/codeql-analysis.yml:CodeQL-Build"
6548565520
state: fixed
65521+
fixed_at: '2020-02-14T12:29:18Z'
6548665522
commit_sha: b09da05606e27f463a2b49287684b4ae777092f2
6548765523
message:
6548865524
text: This suffix check is missing a length comparison to correctly handle

0 commit comments

Comments
 (0)