Skip to content

Commit 8755e44

Browse files
docs-botjc-clark
docs-bot
and
jc-clark
authored
Update OpenAPI Description (#61718)
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
1 parent 14bca7a commit 8755e44

28 files changed

Lines changed: 549 additions & 521 deletions

File tree

‎content/code-security/tutorials/secure-your-organization/respond-to-a-security-incident.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,18 @@ There are several containment actions you can choose to perform to limit the att
101101

102102
For exposed or exploited credentials, the most immediate action you can take is to revoke the affected credentials to prevent further misuse.
103103

104-
{% ifversion fpt or ghec or ghes > 3.17 %}
104+
{% ifversion fpt or ghec %}
105+
105106
* **Revoke via the API**
106107

107108
If the token is one of the following types, and the literal value of the token is known, you (or anybody) can revoke it by **submitting a request via the REST API**. See [AUTOTITLE](/rest/credentials/revoke?apiVersion=2022-11-28#revoke-a-list-of-credentials).
108109

109110
* {% data variables.product.pat_v1_caps %}
110-
* {% data variables.product.pat_v2_caps %}{% ifversion fpt or ghec or ghes > 3.20 %}
111+
* {% data variables.product.pat_v2_caps %}
111112
* {% data variables.product.prodname_oauth_app %} access token
112113
* {% data variables.product.prodname_github_app %} user access token
113-
* {% data variables.product.prodname_github_app %} refresh token{% endif %}
114+
* {% data variables.product.prodname_github_app %} refresh token
115+
114116
{% endif %}
115117

116118
* **Revocation and containment options**

‎content/organizations/managing-programmatic-access-to-your-organization/github-credential-types.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The following sections describe revocation options for each credential type base
3838

3939
* If the token **belongs to you**, you can delete it via your personal account settings. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#deleting-a-personal-access-token).
4040
{% data reusables.credentials.revoke-via-api %}
41-
* **Organization owners** and **enterprise owners** do not have direct visibility into or control over individual tokens. However, they can:{% ifversion fpt or ghec or ghes > 3.17 %}
41+
* **Organization owners** and **enterprise owners** do not have direct visibility into or control over individual tokens. However, they can:{% ifversion fpt or ghec %}
4242
* Revoke them using the REST API, if the actual token value is known. See [AUTOTITLE](/rest/credentials/revoke?apiVersion=2022-11-28#revoke-a-list-of-credentials).{% endif %}
4343
* Restrict the access of {% data variables.product.pat_generic_plural %} to the organization or enterprise entirely. See [AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization) and [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise).
4444
* **Organization owners and enterprise owners** on {% data variables.product.prodname_ghe_cloud %} with SSO enforced can revoke the SSO authorization for a specific {% data variables.product.pat_v1 %}. See [Revoking SSO authorization](#revoking-sso-authorization) for details.
@@ -49,7 +49,7 @@ The following sections describe revocation options for each credential type base
4949
* If the token **belongs to you**, you can delete it via your personal account settings. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#deleting-a-personal-access-token).
5050
{% data reusables.credentials.revoke-via-api %}
5151
* **Organization owners**: Can view and revoke individual tokens. Note, however, that when an organization owner revokes a {% data variables.product.pat_v2 %}, any SSH keys created by the token will continue to work and the token will still be able to read public resources within the organization. The revocation changes the resource owner from the organization to the user, and the user can reassign it back. See [AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/reviewing-and-revoking-personal-access-tokens-in-your-organization).
52-
* **Organization owners** and **enterprise owners** can:{% ifversion fpt or ghec or ghes > 3.17 %}
52+
* **Organization owners** and **enterprise owners** can:{% ifversion fpt or ghec %}
5353
* Revoke the token using the REST API. See [AUTOTITLE](/rest/credentials/revoke?apiVersion=2022-11-28#revoke-a-list-of-credentials).{% endif %}
5454
* Restrict the access of {% data variables.product.pat_generic_plural %} to the organization or enterprise entirely. See [AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/setting-a-personal-access-token-policy-for-your-organization) and [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-personal-access-tokens-in-your-enterprise).
5555
* **Revoked automatically** if pushed to a public repository or gist, or if unused for one year. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation).

‎content/rest/credentials/revoke.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ intro: >-
77
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
88
fpt: '*'
99
ghec: '*'
10-
ghes: '>=3.18'
1110
autogenerated: rest
1211
allowTitleToDifferFromFilename: true
1312
category:

‎data/reusables/credentials/revoke-via-api.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
{% ifversion fpt or ghec or ghes > 3.17 %}
1+
{% ifversion fpt or ghec %}
22
* If the token is owned by someone else, and the actual token value is known, **anyone** can submit a request to revoke it using the REST API. The API doesn't require authentication - anyone with the token value can submit it for revocation. See [AUTOTITLE](/rest/credentials/revoke?apiVersion=2022-11-28#revoke-a-list-of-credentials) in the REST API documentation.{% endif %}

‎src/github-apps/lib/config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "5228aaa58229307d5c18092199d4d3b09050265a"
63+
"sha": "7a0a14cf24805c7efd23fef351bfab80391ec8fb"
6464
}

‎src/rest/data/fpt-2022-11-28/billing.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
},
2929
{
3030
"name": "per_page",
31-
"description": "<p>The number of results per page (max 10).</p>",
31+
"description": "<p>The number of results per page (max 100).</p>",
3232
"in": "query",
3333
"schema": {
3434
"type": "integer",
@@ -61,7 +61,7 @@
6161
}
6262
],
6363
"bodyParameters": [],
64-
"descriptionHTML": "<p>Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.\nEach page returns up to 10 budgets.</p>",
64+
"descriptionHTML": "<p>Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.\nEach page returns up to 100 budgets.</p>",
6565
"codeExamples": [
6666
{
6767
"request": {

‎src/rest/data/fpt-2022-11-28/code-security.json‎

Lines changed: 54 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,10 @@
145145
]
146146
},
147147
"description": {
148-
"type": "string",
148+
"type": [
149+
"string",
150+
"null"
151+
],
149152
"description": "A description of the code security configuration"
150153
},
151154
"advanced_security": {
@@ -487,8 +490,7 @@
487490
{
488491
"type": "string",
489492
"name": "description",
490-
"description": "<p>A description of the code security configuration</p>",
491-
"isRequired": true
493+
"description": "<p>A description of the code security configuration</p>"
492494
},
493495
{
494496
"type": "string",
@@ -808,7 +810,10 @@
808810
]
809811
},
810812
"description": {
811-
"type": "string",
813+
"type": [
814+
"string",
815+
"null"
816+
],
812817
"description": "A description of the code security configuration"
813818
},
814819
"advanced_security": {
@@ -1267,7 +1272,10 @@
12671272
]
12681273
},
12691274
"description": {
1270-
"type": "string",
1275+
"type": [
1276+
"string",
1277+
"null"
1278+
],
12711279
"description": "A description of the code security configuration"
12721280
},
12731281
"advanced_security": {
@@ -1669,7 +1677,10 @@
16691677
]
16701678
},
16711679
"description": {
1672-
"type": "string",
1680+
"type": [
1681+
"string",
1682+
"null"
1683+
],
16731684
"description": "A description of the code security configuration"
16741685
},
16751686
"advanced_security": {
@@ -2327,7 +2338,10 @@
23272338
]
23282339
},
23292340
"description": {
2330-
"type": "string",
2341+
"type": [
2342+
"string",
2343+
"null"
2344+
],
23312345
"description": "A description of the code security configuration"
23322346
},
23332347
"advanced_security": {
@@ -2958,7 +2972,10 @@
29582972
]
29592973
},
29602974
"description": {
2961-
"type": "string",
2975+
"type": [
2976+
"string",
2977+
"null"
2978+
],
29622979
"description": "A description of the code security configuration"
29632980
},
29642981
"advanced_security": {
@@ -4000,7 +4017,10 @@
40004017
]
40014018
},
40024019
"description": {
4003-
"type": "string",
4020+
"type": [
4021+
"string",
4022+
"null"
4023+
],
40044024
"description": "A description of the code security configuration"
40054025
},
40064026
"advanced_security": {
@@ -4346,8 +4366,7 @@
43464366
{
43474367
"type": "string",
43484368
"name": "description",
4349-
"description": "<p>A description of the code security configuration</p>",
4350-
"isRequired": true
4369+
"description": "<p>A description of the code security configuration</p>"
43514370
},
43524371
{
43534372
"type": "string",
@@ -4743,7 +4762,10 @@
47434762
]
47444763
},
47454764
"description": {
4746-
"type": "string",
4765+
"type": [
4766+
"string",
4767+
"null"
4768+
],
47474769
"description": "A description of the code security configuration"
47484770
},
47494771
"advanced_security": {
@@ -5194,7 +5216,10 @@
51945216
]
51955217
},
51965218
"description": {
5197-
"type": "string",
5219+
"type": [
5220+
"string",
5221+
"null"
5222+
],
51985223
"description": "A description of the code security configuration"
51995224
},
52005225
"advanced_security": {
@@ -5711,7 +5736,10 @@
57115736
]
57125737
},
57135738
"description": {
5714-
"type": "string",
5739+
"type": [
5740+
"string",
5741+
"null"
5742+
],
57155743
"description": "A description of the code security configuration"
57165744
},
57175745
"advanced_security": {
@@ -6437,7 +6465,10 @@
64376465
]
64386466
},
64396467
"description": {
6440-
"type": "string",
6468+
"type": [
6469+
"string",
6470+
"null"
6471+
],
64416472
"description": "A description of the code security configuration"
64426473
},
64436474
"advanced_security": {
@@ -7068,7 +7099,10 @@
70687099
]
70697100
},
70707101
"description": {
7071-
"type": "string",
7102+
"type": [
7103+
"string",
7104+
"null"
7105+
],
70727106
"description": "A description of the code security configuration"
70737107
},
70747108
"advanced_security": {
@@ -8076,7 +8110,10 @@
80768110
]
80778111
},
80788112
"description": {
8079-
"type": "string",
8113+
"type": [
8114+
"string",
8115+
"null"
8116+
],
80808117
"description": "A description of the code security configuration"
80818118
},
80828119
"advanced_security": {

‎src/rest/data/fpt-2026-03-10/billing.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
},
2929
{
3030
"name": "per_page",
31-
"description": "<p>The number of results per page (max 10).</p>",
31+
"description": "<p>The number of results per page (max 100).</p>",
3232
"in": "query",
3333
"schema": {
3434
"type": "integer",
@@ -61,7 +61,7 @@
6161
}
6262
],
6363
"bodyParameters": [],
64-
"descriptionHTML": "<p>Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.\nEach page returns up to 10 budgets.</p>",
64+
"descriptionHTML": "<p>Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.\nEach page returns up to 100 budgets.</p>",
6565
"codeExamples": [
6666
{
6767
"request": {

0 commit comments

Comments
 (0)