Skip to content

Commit 67b17bf

Browse files
Update OpenAPI Descriptions (#23061)
1 parent 6d176d7 commit 67b17bf

12 files changed

Lines changed: 4995 additions & 553 deletions

lib/rest/static/decorated/api.github.com.json

Lines changed: 1553 additions & 4 deletions
Large diffs are not rendered by default.

lib/rest/static/decorated/ghes-3.0.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51590,7 +51590,7 @@
5159051590
"properties": {
5159151591
"state": {
5159251592
"type": "string",
51593-
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code> <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
51593+
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code>, <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
5159451594
"enum": [
5159551595
"error",
5159651596
"failure",
@@ -51603,7 +51603,7 @@
5160351603
"name": "state",
5160451604
"in": "body",
5160551605
"rawType": "string",
51606-
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
51606+
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
5160751607
"childParamsGroups": []
5160851608
},
5160951609
"target_url": {
@@ -51714,7 +51714,7 @@
5171451714
"bodyParameters": [
5171551715
{
5171651716
"type": "string",
51717-
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code> <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
51717+
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code>, <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
5171851718
"enum": [
5171951719
"error",
5172051720
"failure",
@@ -51727,7 +51727,7 @@
5172751727
"name": "state",
5172851728
"in": "body",
5172951729
"rawType": "string",
51730-
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
51730+
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
5173151731
"childParamsGroups": []
5173251732
},
5173351733
{

lib/rest/static/decorated/ghes-3.1.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52259,7 +52259,7 @@
5225952259
"properties": {
5226052260
"state": {
5226152261
"type": "string",
52262-
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code> <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
52262+
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code>, <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
5226352263
"enum": [
5226452264
"error",
5226552265
"failure",
@@ -52272,7 +52272,7 @@
5227252272
"name": "state",
5227352273
"in": "body",
5227452274
"rawType": "string",
52275-
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.1/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
52275+
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.1/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
5227652276
"childParamsGroups": []
5227752277
},
5227852278
"target_url": {
@@ -52383,7 +52383,7 @@
5238352383
"bodyParameters": [
5238452384
{
5238552385
"type": "string",
52386-
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code> <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
52386+
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code>, <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.1/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
5238752387
"enum": [
5238852388
"error",
5238952389
"failure",
@@ -52396,7 +52396,7 @@
5239652396
"name": "state",
5239752397
"in": "body",
5239852398
"rawType": "string",
52399-
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.1/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
52399+
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.1/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
5240052400
"childParamsGroups": []
5240152401
},
5240252402
{

lib/rest/static/decorated/ghes-3.2.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53525,7 +53525,7 @@
5352553525
"properties": {
5352653526
"state": {
5352753527
"type": "string",
53528-
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code> <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
53528+
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code>, <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
5352953529
"enum": [
5353053530
"error",
5353153531
"failure",
@@ -53538,7 +53538,7 @@
5353853538
"name": "state",
5353953539
"in": "body",
5354053540
"rawType": "string",
53541-
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
53541+
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
5354253542
"childParamsGroups": []
5354353543
},
5354453544
"target_url": {
@@ -53649,7 +53649,7 @@
5364953649
"bodyParameters": [
5365053650
{
5365153651
"type": "string",
53652-
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code> <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
53652+
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code>, <code>pending</code>, or <code>success</code>. <strong>Note:</strong> To use the <code>inactive</code> state, you must provide the <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments\"><code>application/vnd.github.ant-man-preview+json</code></a> custom media type. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
5365353653
"enum": [
5365453654
"error",
5365553655
"failure",
@@ -53662,7 +53662,7 @@
5366253662
"name": "state",
5366353663
"in": "body",
5366453664
"rawType": "string",
53665-
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
53665+
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
5366653666
"childParamsGroups": []
5366753667
},
5366853668
{

lib/rest/static/decorated/ghes-3.3.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53709,7 +53709,7 @@
5370953709
"properties": {
5371053710
"state": {
5371153711
"type": "string",
53712-
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code> <code>pending</code>, or <code>success</code>. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
53712+
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code>, <code>pending</code>, or <code>success</code>. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
5371353713
"enum": [
5371453714
"error",
5371553715
"failure",
@@ -53722,7 +53722,7 @@
5372253722
"name": "state",
5372353723
"in": "body",
5372453724
"rawType": "string",
53725-
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
53725+
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
5372653726
"childParamsGroups": []
5372753727
},
5372853728
"target_url": {
@@ -53819,7 +53819,7 @@
5381953819
"bodyParameters": [
5382053820
{
5382153821
"type": "string",
53822-
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code> <code>pending</code>, or <code>success</code>. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
53822+
"description": "<p><strong>Required</strong>. The state of the status. Can be one of <code>error</code>, <code>failure</code>, <code>inactive</code>, <code>in_progress</code>, <code>queued</code>, <code>pending</code>, or <code>success</code>. When you set a transient deployment to <code>inactive</code>, the deployment will be shown as <code>destroyed</code> in GitHub.</p>",
5382353823
"enum": [
5382453824
"error",
5382553825
"failure",
@@ -53832,7 +53832,7 @@
5383253832
"name": "state",
5383353833
"in": "body",
5383453834
"rawType": "string",
53835-
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
53835+
"rawDescription": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.",
5383653836
"childParamsGroups": []
5383753837
},
5383853838
{

0 commit comments

Comments
 (0)