Skip to content

Commit a87dc59

Browse files
beccobecco
authored
Merge pull request #789 from github/openapi-update-c6df5306971888945b5e5ed37d3cae9a85cf0bcc987b8aed24a17c1ed2222133
Update OpenAPI 3.0 Descriptions
2 parents 9116938 + c255fbc commit a87dc59

20 files changed

Lines changed: 3498 additions & 4868 deletions

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

Lines changed: 41 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -13229,50 +13229,28 @@
1322913229
},
1323013230
"/orgs/{org}/secret-scanning/alerts": {
1323113231
"get": {
13232-
"summary": "List secret scanning alerts by organization",
13233-
"description": "Lists all secret scanning alerts for all eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
13232+
"summary": "List secret scanning alerts for an organization",
13233+
"description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
1323413234
"tags": [
1323513235
"secret-scanning"
1323613236
],
1323713237
"operationId": "secret-scanning/list-alerts-for-org",
1323813238
"externalDocs": {
1323913239
"description": "API method documentation",
13240-
"url": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-by-organization"
13240+
"url": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization"
1324113241
},
1324213242
"parameters": [
1324313243
{
1324413244
"$ref": "#/components/parameters/org"
1324513245
},
1324613246
{
13247-
"name": "state",
13248-
"in": "query",
13249-
"description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.",
13250-
"required": false,
13251-
"schema": {
13252-
"type": "string",
13253-
"enum": [
13254-
"open",
13255-
"resolved"
13256-
]
13257-
}
13247+
"$ref": "#/components/parameters/secret-scanning-alert-state"
1325813248
},
1325913249
{
13260-
"name": "secret_type",
13261-
"in": "query",
13262-
"description": "A comma-separated list of secret types to return. By default all secret types are returned.",
13263-
"required": false,
13264-
"schema": {
13265-
"type": "string"
13266-
}
13250+
"$ref": "#/components/parameters/secret-scanning-alert-secret-type"
1326713251
},
1326813252
{
13269-
"name": "resolution",
13270-
"in": "query",
13271-
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
13272-
"required": false,
13273-
"schema": {
13274-
"type": "string"
13275-
}
13253+
"$ref": "#/components/parameters/secret-scanning-alert-resolution"
1327613254
},
1327713255
{
1327813256
"$ref": "#/components/parameters/page"
@@ -39707,7 +39685,7 @@
3970739685
"/repos/{owner}/{repo}/secret-scanning/alerts": {
3970839686
"get": {
3970939687
"summary": "List secret scanning alerts for a repository",
39710-
"description": "Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
39688+
"description": "Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
3971139689
"tags": [
3971239690
"secret-scanning"
3971339691
],
@@ -39724,35 +39702,13 @@
3972439702
"$ref": "#/components/parameters/repo"
3972539703
},
3972639704
{
39727-
"name": "state",
39728-
"in": "query",
39729-
"description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.",
39730-
"required": false,
39731-
"schema": {
39732-
"type": "string",
39733-
"enum": [
39734-
"open",
39735-
"resolved"
39736-
]
39737-
}
39705+
"$ref": "#/components/parameters/secret-scanning-alert-state"
3973839706
},
3973939707
{
39740-
"name": "secret_type",
39741-
"in": "query",
39742-
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
39743-
"required": false,
39744-
"schema": {
39745-
"type": "string"
39746-
}
39708+
"$ref": "#/components/parameters/secret-scanning-alert-secret-type"
3974739709
},
3974839710
{
39749-
"name": "resolution",
39750-
"in": "query",
39751-
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
39752-
"required": false,
39753-
"schema": {
39754-
"type": "string"
39755-
}
39711+
"$ref": "#/components/parameters/secret-scanning-alert-resolution"
3975639712
},
3975739713
{
3975839714
"$ref": "#/components/parameters/page"
@@ -99723,6 +99679,37 @@
9972399679
"type": "integer"
9972499680
}
9972599681
},
99682+
"secret-scanning-alert-state": {
99683+
"name": "state",
99684+
"in": "query",
99685+
"description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.",
99686+
"required": false,
99687+
"schema": {
99688+
"type": "string",
99689+
"enum": [
99690+
"open",
99691+
"resolved"
99692+
]
99693+
}
99694+
},
99695+
"secret-scanning-alert-secret-type": {
99696+
"name": "secret_type",
99697+
"in": "query",
99698+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
99699+
"required": false,
99700+
"schema": {
99701+
"type": "string"
99702+
}
99703+
},
99704+
"secret-scanning-alert-resolution": {
99705+
"name": "resolution",
99706+
"in": "query",
99707+
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
99708+
"required": false,
99709+
"schema": {
99710+
"type": "string"
99711+
}
99712+
},
9972699713
"team-slug": {
9972799714
"name": "team_slug",
9972899715
"description": "team_slug parameter",

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

Lines changed: 40 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -9516,9 +9516,9 @@ paths:
95169516
subcategory:
95179517
"/orgs/{org}/secret-scanning/alerts":
95189518
get:
9519-
summary: List secret scanning alerts by organization
9519+
summary: List secret scanning alerts for an organization
95209520
description: |-
9521-
Lists all secret scanning alerts for all eligible repositories in an organization, from newest to oldest.
9521+
Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
95229522
To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.
95239523

95249524
GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
@@ -9527,34 +9527,12 @@ paths:
95279527
operationId: secret-scanning/list-alerts-for-org
95289528
externalDocs:
95299529
description: API method documentation
9530-
url: https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-by-organization
9530+
url: https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization
95319531
parameters:
95329532
- "$ref": "#/components/parameters/org"
9533-
- name: state
9534-
in: query
9535-
description: Set to `open` or `resolved` to only list secret scanning alerts
9536-
in a specific state.
9537-
required: false
9538-
schema:
9539-
type: string
9540-
enum:
9541-
- open
9542-
- resolved
9543-
- name: secret_type
9544-
in: query
9545-
description: A comma-separated list of secret types to return. By default
9546-
all secret types are returned.
9547-
required: false
9548-
schema:
9549-
type: string
9550-
- name: resolution
9551-
in: query
9552-
description: A comma-separated list of resolutions. Only secret scanning alerts
9553-
with one of these resolutions are listed. Valid resolutions are `false_positive`,
9554-
`wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.
9555-
required: false
9556-
schema:
9557-
type: string
9533+
- "$ref": "#/components/parameters/secret-scanning-alert-state"
9534+
- "$ref": "#/components/parameters/secret-scanning-alert-secret-type"
9535+
- "$ref": "#/components/parameters/secret-scanning-alert-resolution"
95589536
- "$ref": "#/components/parameters/page"
95599537
- "$ref": "#/components/parameters/per-page"
95609538
responses:
@@ -28431,7 +28409,7 @@ paths:
2843128409
get:
2843228410
summary: List secret scanning alerts for a repository
2843328411
description: |-
28434-
Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.
28412+
Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.
2843528413

2843628414
GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.
2843728415
tags:
@@ -28443,32 +28421,9 @@ paths:
2844328421
parameters:
2844428422
- "$ref": "#/components/parameters/owner"
2844528423
- "$ref": "#/components/parameters/repo"
28446-
- name: state
28447-
in: query
28448-
description: Set to `open` or `resolved` to only list secret scanning alerts
28449-
in a specific state.
28450-
required: false
28451-
schema:
28452-
type: string
28453-
enum:
28454-
- open
28455-
- resolved
28456-
- name: secret_type
28457-
in: query
28458-
description: A comma-separated list of secret types to return. By default
28459-
all secret types are returned. See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)"
28460-
for a complete list of secret types (API slug).
28461-
required: false
28462-
schema:
28463-
type: string
28464-
- name: resolution
28465-
in: query
28466-
description: A comma-separated list of resolutions. Only secret scanning alerts
28467-
with one of these resolutions are listed. Valid resolutions are `false_positive`,
28468-
`wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.
28469-
required: false
28470-
schema:
28471-
type: string
28424+
- "$ref": "#/components/parameters/secret-scanning-alert-state"
28425+
- "$ref": "#/components/parameters/secret-scanning-alert-secret-type"
28426+
- "$ref": "#/components/parameters/secret-scanning-alert-resolution"
2847228427
- "$ref": "#/components/parameters/page"
2847328428
- "$ref": "#/components/parameters/per-page"
2847428429
responses:
@@ -76100,6 +76055,36 @@ components:
7610076055
required: true
7610176056
schema:
7610276057
type: integer
76058+
secret-scanning-alert-state:
76059+
name: state
76060+
in: query
76061+
description: Set to `open` or `resolved` to only list secret scanning alerts
76062+
in a specific state.
76063+
required: false
76064+
schema:
76065+
type: string
76066+
enum:
76067+
- open
76068+
- resolved
76069+
secret-scanning-alert-secret-type:
76070+
name: secret_type
76071+
in: query
76072+
description: |-
76073+
A comma-separated list of secret types to return. By default all secret types are returned.
76074+
See "[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)"
76075+
for a complete list of secret types (API slug).
76076+
required: false
76077+
schema:
76078+
type: string
76079+
secret-scanning-alert-resolution:
76080+
name: resolution
76081+
in: query
76082+
description: A comma-separated list of resolutions. Only secret scanning alerts
76083+
with one of these resolutions are listed. Valid resolutions are `false_positive`,
76084+
`wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.
76085+
required: false
76086+
schema:
76087+
type: string
7610376088
team-slug:
7610476089
name: team_slug
7610576090
description: team_slug parameter

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94881,15 +94881,15 @@
9488194881
},
9488294882
"/orgs/{org}/secret-scanning/alerts": {
9488394883
"get": {
94884-
"summary": "List secret scanning alerts by organization",
94885-
"description": "Lists all secret scanning alerts for all eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
94884+
"summary": "List secret scanning alerts for an organization",
94885+
"description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
9488694886
"tags": [
9488794887
"secret-scanning"
9488894888
],
9488994889
"operationId": "secret-scanning/list-alerts-for-org",
9489094890
"externalDocs": {
9489194891
"description": "API method documentation",
94892-
"url": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-by-organization"
94892+
"url": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization"
9489394893
},
9489494894
"parameters": [
9489594895
{
@@ -94916,7 +94916,7 @@
9491694916
{
9491794917
"name": "secret_type",
9491894918
"in": "query",
94919-
"description": "A comma-separated list of secret types to return. By default all secret types are returned.",
94919+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
9492094920
"required": false,
9492194921
"schema": {
9492294922
"type": "string"
@@ -347542,7 +347542,7 @@
347542347542
"/repos/{owner}/{repo}/secret-scanning/alerts": {
347543347543
"get": {
347544347544
"summary": "List secret scanning alerts for a repository",
347545-
"description": "Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
347545+
"description": "Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
347546347546
"tags": [
347547347547
"secret-scanning"
347548347548
],
@@ -347584,7 +347584,7 @@
347584347584
{
347585347585
"name": "secret_type",
347586347586
"in": "query",
347587-
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
347587+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
347588347588
"required": false,
347589347589
"schema": {
347590347590
"type": "string"

0 commit comments

Comments
 (0)