Skip to content

Commit c1e4b0a

Browse files
docs-botjules-p
andauthored
Update OpenAPI Description (#54799)
Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com>
1 parent 4dcb467 commit c1e4b0a

14 files changed

Lines changed: 848 additions & 1781 deletions

File tree

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": "afa8a986f4d2ae2625a2c6a5c36d27f2fa900d1a"
63+
"sha": "ef11ae693506cf915544201a6da5abd61a286259"
6464
}

src/rest/data/fpt-2022-11-28/schema.json

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -638,8 +638,7 @@
638638
{
639639
"\"Actions\" repository permissions": "read"
640640
}
641-
],
642-
"allowsPublicRead": true
641+
]
643642
},
644643
"codeExamples": [
645644
{
@@ -107463,6 +107462,7 @@
107463107462
"id": {
107464107463
"description": "Unique identifier of the webhook delivery.",
107465107464
"type": "integer",
107465+
"format": "int64",
107466107466
"examples": [
107467107467
42
107468107468
]
@@ -107533,6 +107533,7 @@
107533107533
"integer",
107534107534
"null"
107535107535
],
107536+
"format": "int64",
107536107537
"examples": [
107537107538
123
107538107539
]
@@ -107543,6 +107544,7 @@
107543107544
"integer",
107544107545
"null"
107545107546
],
107547+
"format": "int64",
107546107548
"examples": [
107547107549
123
107548107550
]
@@ -213632,7 +213634,7 @@
213632213634
}
213633213635
],
213634213636
"previews": [],
213635-
"descriptionHTML": "<p>Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
213637+
"descriptionHTML": "<p>Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint. The associated user must be a repository admin.</p>",
213636213638
"statusCodes": [
213637213639
{
213638213640
"httpStatusCode": "201",
@@ -213710,7 +213712,7 @@
213710213712
}
213711213713
],
213712213714
"previews": [],
213713-
"descriptionHTML": "<p>Deletes a development environment secret in a repository using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
213715+
"descriptionHTML": "<p>Deletes a development environment secret in a repository using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint. The associated user must be a repository admin.</p>",
213714213716
"statusCodes": [
213715213717
{
213716213718
"httpStatusCode": "204",
@@ -257435,7 +257437,7 @@
257435257437
}
257436257438
],
257437257439
"previews": [],
257438-
"descriptionHTML": "<p>Enable a custom deployment protection rule for an environment.</p>\n<p>The authenticated user must have admin or owner permissions to the repository to use this endpoint.</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
257440+
"descriptionHTML": "<p>Enable a custom deployment protection rule for an environment.</p>\n<p>The authenticated user must have admin or owner permissions to the repository to use this endpoint.</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>, as well as the <a href=\"https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules\">guide to creating custom deployment protection rules</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
257439257441
"statusCodes": [
257440257442
{
257441257443
"httpStatusCode": "201",
@@ -399455,6 +399457,22 @@
399455399457
"type": "string",
399456399458
"format": "date-time"
399457399459
}
399460+
},
399461+
{
399462+
"name": "token_id",
399463+
"description": "<p>The ID of the token</p>",
399464+
"in": "query",
399465+
"required": false,
399466+
"schema": {
399467+
"type": "array",
399468+
"maxItems": 50,
399469+
"items": {
399470+
"type": "string"
399471+
},
399472+
"examples": [
399473+
"token_id[]=1,token_id[]=2"
399474+
]
399475+
}
399458399476
}
399459399477
],
399460399478
"bodyParameters": [],
@@ -401208,6 +401226,22 @@
401208401226
"type": "string",
401209401227
"format": "date-time"
401210401228
}
401229+
},
401230+
{
401231+
"name": "token_id",
401232+
"description": "<p>The ID of the token</p>",
401233+
"in": "query",
401234+
"required": false,
401235+
"schema": {
401236+
"type": "array",
401237+
"maxItems": 50,
401238+
"items": {
401239+
"type": "string"
401240+
},
401241+
"examples": [
401242+
"token_id[]=1,token_id[]=2"
401243+
]
401244+
}
401211401245
}
401212401246
],
401213401247
"bodyParameters": [],
@@ -413255,6 +413289,7 @@
413255413289
"id": {
413256413290
"description": "Unique identifier of the webhook delivery.",
413257413291
"type": "integer",
413292+
"format": "int64",
413258413293
"examples": [
413259413294
42
413260413295
]
@@ -413325,6 +413360,7 @@
413325413360
"integer",
413326413361
"null"
413327413362
],
413363+
"format": "int64",
413328413364
"examples": [
413329413365
123
413330413366
]
@@ -413335,6 +413371,7 @@
413335413371
"integer",
413336413372
"null"
413337413373
],
413374+
"format": "int64",
413338413375
"examples": [
413339413376
123
413340413377
]
@@ -547290,6 +547327,7 @@
547290547327
"id": {
547291547328
"description": "Unique identifier of the webhook delivery.",
547292547329
"type": "integer",
547330+
"format": "int64",
547293547331
"examples": [
547294547332
42
547295547333
]
@@ -547360,6 +547398,7 @@
547360547398
"integer",
547361547399
"null"
547362547400
],
547401+
"format": "int64",
547363547402
"examples": [
547364547403
123
547365547404
]
@@ -547370,6 +547409,7 @@
547370547409
"integer",
547371547410
"null"
547372547411
],
547412+
"format": "int64",
547373547413
"examples": [
547374547414
123
547375547415
]

src/rest/data/ghec-2022-11-28/schema.json

Lines changed: 45 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -638,8 +638,7 @@
638638
{
639639
"\"Actions\" repository permissions": "read"
640640
}
641-
],
642-
"allowsPublicRead": true
641+
]
643642
},
644643
"codeExamples": [
645644
{
@@ -116671,6 +116670,7 @@
116671116670
"id": {
116672116671
"description": "Unique identifier of the webhook delivery.",
116673116672
"type": "integer",
116673+
"format": "int64",
116674116674
"examples": [
116675116675
42
116676116676
]
@@ -116741,6 +116741,7 @@
116741116741
"integer",
116742116742
"null"
116743116743
],
116744+
"format": "int64",
116744116745
"examples": [
116745116746
123
116746116747
]
@@ -116751,6 +116752,7 @@
116751116752
"integer",
116752116753
"null"
116753116754
],
116755+
"format": "int64",
116754116756
"examples": [
116755116757
123
116756116758
]
@@ -224907,7 +224909,7 @@
224907224909
}
224908224910
],
224909224911
"previews": [],
224910-
"descriptionHTML": "<p>Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
224912+
"descriptionHTML": "<p>Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint. The associated user must be a repository admin.</p>",
224911224913
"statusCodes": [
224912224914
{
224913224915
"httpStatusCode": "201",
@@ -224985,7 +224987,7 @@
224985224987
}
224986224988
],
224987224989
"previews": [],
224988-
"descriptionHTML": "<p>Deletes a development environment secret in a repository using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
224990+
"descriptionHTML": "<p>Deletes a development environment secret in a repository using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint. The associated user must be a repository admin.</p>",
224989224991
"statusCodes": [
224990224992
{
224991224993
"httpStatusCode": "204",
@@ -271316,7 +271318,7 @@
271316271318
}
271317271319
],
271318271320
"previews": [],
271319-
"descriptionHTML": "<p>Enable a custom deployment protection rule for an environment.</p>\n<p>The authenticated user must have admin or owner permissions to the repository to use this endpoint.</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
271321+
"descriptionHTML": "<p>Enable a custom deployment protection rule for an environment.</p>\n<p>The authenticated user must have admin or owner permissions to the repository to use this endpoint.</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>, as well as the <a href=\"https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules\">guide to creating custom deployment protection rules</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
271320271322
"statusCodes": [
271321271323
{
271322271324
"httpStatusCode": "201",
@@ -437282,6 +437284,22 @@
437282437284
"type": "string",
437283437285
"format": "date-time"
437284437286
}
437287+
},
437288+
{
437289+
"name": "token_id",
437290+
"description": "<p>The ID of the token</p>",
437291+
"in": "query",
437292+
"required": false,
437293+
"schema": {
437294+
"type": "array",
437295+
"maxItems": 50,
437296+
"items": {
437297+
"type": "string"
437298+
},
437299+
"examples": [
437300+
"token_id[]=1,token_id[]=2"
437301+
]
437302+
}
437285437303
}
437286437304
],
437287437305
"bodyParameters": [],
@@ -439047,6 +439065,22 @@
439047439065
"type": "string",
439048439066
"format": "date-time"
439049439067
}
439068+
},
439069+
{
439070+
"name": "token_id",
439071+
"description": "<p>The ID of the token</p>",
439072+
"in": "query",
439073+
"required": false,
439074+
"schema": {
439075+
"type": "array",
439076+
"maxItems": 50,
439077+
"items": {
439078+
"type": "string"
439079+
},
439080+
"examples": [
439081+
"token_id[]=1,token_id[]=2"
439082+
]
439083+
}
439050439084
}
439051439085
],
439052439086
"bodyParameters": [],
@@ -451112,6 +451146,7 @@
451112451146
"id": {
451113451147
"description": "Unique identifier of the webhook delivery.",
451114451148
"type": "integer",
451149+
"format": "int64",
451115451150
"examples": [
451116451151
42
451117451152
]
@@ -451182,6 +451217,7 @@
451182451217
"integer",
451183451218
"null"
451184451219
],
451220+
"format": "int64",
451185451221
"examples": [
451186451222
123
451187451223
]
@@ -451192,6 +451228,7 @@
451192451228
"integer",
451193451229
"null"
451194451230
],
451231+
"format": "int64",
451195451232
"examples": [
451196451233
123
451197451234
]
@@ -586326,6 +586363,7 @@
586326586363
"id": {
586327586364
"description": "Unique identifier of the webhook delivery.",
586328586365
"type": "integer",
586366+
"format": "int64",
586329586367
"examples": [
586330586368
42
586331586369
]
@@ -586396,6 +586434,7 @@
586396586434
"integer",
586397586435
"null"
586398586436
],
586437+
"format": "int64",
586399586438
"examples": [
586400586439
123
586401586440
]
@@ -586406,6 +586445,7 @@
586406586445
"integer",
586407586446
"null"
586408586447
],
586448+
"format": "int64",
586409586449
"examples": [
586410586450
123
586411586451
]

0 commit comments

Comments
 (0)