Skip to content

Commit 044287c

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #580 from github/openapi-update-5dea882e28633323f2f0e642586f9eb3e8df7c2d9a19fb014540a38583485934
Update OpenAPI Descriptions
2 parents 8f3a397 + 2979f99 commit 044287c

24 files changed

+1137
-5462
lines changed

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

Lines changed: 275 additions & 856 deletions
Large diffs are not rendered by default.

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

Lines changed: 234 additions & 834 deletions
Large diffs are not rendered by default.

‎descriptions/api.github.com/dereferenced/api.github.com.deref.json

Lines changed: 19 additions & 623 deletions
Large diffs are not rendered by default.

‎descriptions/api.github.com/dereferenced/api.github.com.deref.yaml

Lines changed: 168 additions & 770 deletions
Large diffs are not rendered by default.

‎descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99940,8 +99940,7 @@
9994099940
"note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
9994199941
}
9994299942
],
99943-
"category": "repos",
99944-
"subcategory": null
99943+
"category": "repos"
9994599944
}
9994699945
},
9994799946
"patch": {
@@ -149106,6 +149105,10 @@
149106149105
"type": "string",
149107149106
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
149108149107
},
149108+
"category": {
149109+
"type": "string",
149110+
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
149111+
},
149109149112
"state": {
149110149113
"type": "string",
149111149114
"description": "State of a code scanning alert.",

‎descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25373,7 +25373,6 @@ paths:
2537325373
application/vnd.github.scarlet-witch-preview+json
2537425374
```
2537525375
category: repos
25376-
subcategory:
2537725376
patch:
2537825377
summary: Update a repository
2537925378
description: "**Note**: To edit a repository's topics, use the [Replace all
@@ -34670,6 +34669,12 @@ paths:
3467034669
the environment in which the analysis that generated this
3467134670
alert instance was performed, such as the language that
3467234671
was analyzed.
34672+
category:
34673+
type: string
34674+
description: Identifies the configuration under which the
34675+
analysis was executed. Used to distinguish between multiple
34676+
analyses for the same tool and commit, but performed on
34677+
different languages or different parts of the code.
3467334678
state:
3467434679
type: string
3467534680
description: State of a code scanning alert.

‎descriptions/ghes-2.22/ghes-2.22.json

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16472,8 +16472,7 @@
1647216472
"note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
1647316473
}
1647416474
],
16475-
"category": "repos",
16476-
"subcategory": null
16475+
"category": "repos"
1647716476
}
1647816477
},
1647916478
"patch": {
@@ -57223,6 +57222,10 @@
5722357222
"type": "string",
5722457223
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
5722557224
},
57225+
"code-scanning-analysis-category": {
57226+
"type": "string",
57227+
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
57228+
},
5722657229
"code-scanning-alert-location": {
5722757230
"type": "object",
5722857231
"description": "Describe a region within a file for the alert.",
@@ -57267,6 +57270,9 @@
5726757270
"environment": {
5726857271
"$ref": "#/components/schemas/code-scanning-alert-environment"
5726957272
},
57273+
"category": {
57274+
"$ref": "#/components/schemas/code-scanning-analysis-category"
57275+
},
5727057276
"state": {
5727157277
"$ref": "#/components/schemas/code-scanning-alert-state"
5727257278
},
@@ -57472,10 +57478,6 @@
5747257478
"type": "string",
5747357479
"description": "Identifies the variable values associated with the environment in which this analysis was performed."
5747457480
},
57475-
"code-scanning-analysis-category": {
57476-
"type": "string",
57477-
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
57478-
},
5747957481
"code-scanning-analysis-created-at": {
5748057482
"type": "string",
5748157483
"description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",

‎descriptions/ghes-2.22/ghes-2.22.yaml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11810,7 +11810,6 @@ paths:
1181011810
application/vnd.github.scarlet-witch-preview+json
1181111811
```
1181211812
category: repos
11813-
subcategory:
1181411813
patch:
1181511814
summary: Update a repository
1181611815
description: "**Note**: To edit a repository's topics, use the [Replace all
@@ -41837,6 +41836,11 @@ components:
4183741836
description: Identifies the variable values associated with the environment
4183841837
in which the analysis that generated this alert instance was performed, such
4183941838
as the language that was analyzed.
41839+
code-scanning-analysis-category:
41840+
type: string
41841+
description: Identifies the configuration under which the analysis was executed.
41842+
Used to distinguish between multiple analyses for the same tool and commit,
41843+
but performed on different languages or different parts of the code.
4184041844
code-scanning-alert-location:
4184141845
type: object
4184241846
description: Describe a region within a file for the alert.
@@ -41869,6 +41873,8 @@ components:
4186941873
"$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
4187041874
environment:
4187141875
"$ref": "#/components/schemas/code-scanning-alert-environment"
41876+
category:
41877+
"$ref": "#/components/schemas/code-scanning-analysis-category"
4187241878
state:
4187341879
"$ref": "#/components/schemas/code-scanning-alert-state"
4187441880
commit_sha:
@@ -42023,11 +42029,6 @@ components:
4202342029
type: string
4202442030
description: Identifies the variable values associated with the environment
4202542031
in which this analysis was performed.
42026-
code-scanning-analysis-category:
42027-
type: string
42028-
description: Identifies the configuration under which the analysis was executed.
42029-
Used to distinguish between multiple analyses for the same tool and commit,
42030-
but performed on different languages or different parts of the code.
4203142032
code-scanning-analysis-created-at:
4203242033
type: string
4203342034
description: 'The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'

‎descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.json

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105598,8 +105598,7 @@
105598105598
"note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
105599105599
}
105600105600
],
105601-
"category": "repos",
105602-
"subcategory": null
105601+
"category": "repos"
105603105602
}
105604105603
},
105605105604
"patch": {
@@ -155328,6 +155327,10 @@
155328155327
"type": "string",
155329155328
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
155330155329
},
155330+
"category": {
155331+
"type": "string",
155332+
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
155333+
},
155331155334
"state": {
155332155335
"type": "string",
155333155336
"description": "State of a code scanning alert.",
@@ -155919,6 +155922,10 @@
155919155922
"type": "string",
155920155923
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
155921155924
},
155925+
"category": {
155926+
"type": "string",
155927+
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
155928+
},
155922155929
"state": {
155923155930
"type": "string",
155924155931
"description": "State of a code scanning alert.",
@@ -156509,6 +156516,10 @@
156509156516
"type": "string",
156510156517
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
156511156518
},
156519+
"category": {
156520+
"type": "string",
156521+
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
156522+
},
156512156523
"state": {
156513156524
"type": "string",
156514156525
"description": "State of a code scanning alert.",

‎descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26837,7 +26837,6 @@ paths:
2683726837
application/vnd.github.scarlet-witch-preview+json
2683826838
```
2683926839
category: repos
26840-
subcategory:
2684126840
patch:
2684226841
summary: Update a repository
2684326842
description: "**Note**: To edit a repository's topics, use the [Replace all
@@ -36357,6 +36356,12 @@ paths:
3635736356
the environment in which the analysis that generated this
3635836357
alert instance was performed, such as the language that
3635936358
was analyzed.
36359+
category:
36360+
type: string
36361+
description: Identifies the configuration under which the
36362+
analysis was executed. Used to distinguish between multiple
36363+
analyses for the same tool and commit, but performed on
36364+
different languages or different parts of the code.
3636036365
state:
3636136366
type: string
3636236367
description: State of a code scanning alert.

0 commit comments

Comments
 (0)