diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 05a3793c9..aabedc55c 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -13969,7 +13969,7 @@ }, "deployment_name": { "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}\n", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", "minLength": 1, "maxLength": 128 }, @@ -35035,8 +35035,20 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-dispatch-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-dispatch-response" + } + } + } + } } }, "requestBody": { @@ -124339,21 +124351,32 @@ }, "workflow-run-id": { "title": "Workflow Run ID", - "description": "The unique identifier for a workflow run", + "description": "The ID of the workflow run.", "type": "integer", "format": "int64" }, "workflow-dispatch-response": { "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID", + "description": "Response containing the workflow run ID and URLs.", "type": "object", "properties": { "workflow_run_id": { "$ref": "#/components/schemas/workflow-run-id" + }, + "run_url": { + "type": "string", + "format": "uri", + "description": "The URL to the workflow run." + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "workflow_run_id" + "workflow_run_id", + "run_url", + "html_url" ] }, "workflow-usage": { @@ -300848,7 +300871,9 @@ }, "workflow-dispatch-response": { "value": { - "workflow_run_id": 1 + "workflow_run_id": 1, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" } }, "workflow-usage": { diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 54573bf1c..eb6503449 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -10099,7 +10099,8 @@ paths: description: | The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a record set, the following format is recommended: - {namespaceName}-{deploymentName}-{containerName} + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. minLength: 1 maxLength: 128 github_repository: @@ -25336,8 +25337,15 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: - '204': + '200': description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/workflow-dispatch-response" + examples: + default: + "$ref": "#/components/examples/workflow-dispatch-response" requestBody: required: true content: @@ -90218,18 +90226,27 @@ components: - updated_at workflow-run-id: title: Workflow Run ID - description: The unique identifier for a workflow run + description: The ID of the workflow run. type: integer format: int64 workflow-dispatch-response: title: Workflow Dispatch Response - description: Response containing the workflow run ID + description: Response containing the workflow run ID and URLs. type: object properties: workflow_run_id: "$ref": "#/components/schemas/workflow-run-id" + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri required: - workflow_run_id + - run_url + - html_url workflow-usage: title: Workflow Usage description: Workflow Usage @@ -222778,6 +222795,8 @@ components: workflow-dispatch-response: value: workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 workflow-usage: value: billable: diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 05a3793c9..aabedc55c 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -13969,7 +13969,7 @@ }, "deployment_name": { "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}\n", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", "minLength": 1, "maxLength": 128 }, @@ -35035,8 +35035,20 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-dispatch-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-dispatch-response" + } + } + } + } } }, "requestBody": { @@ -124339,21 +124351,32 @@ }, "workflow-run-id": { "title": "Workflow Run ID", - "description": "The unique identifier for a workflow run", + "description": "The ID of the workflow run.", "type": "integer", "format": "int64" }, "workflow-dispatch-response": { "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID", + "description": "Response containing the workflow run ID and URLs.", "type": "object", "properties": { "workflow_run_id": { "$ref": "#/components/schemas/workflow-run-id" + }, + "run_url": { + "type": "string", + "format": "uri", + "description": "The URL to the workflow run." + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "workflow_run_id" + "workflow_run_id", + "run_url", + "html_url" ] }, "workflow-usage": { @@ -300848,7 +300871,9 @@ }, "workflow-dispatch-response": { "value": { - "workflow_run_id": 1 + "workflow_run_id": 1, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" } }, "workflow-usage": { diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 54573bf1c..eb6503449 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -10099,7 +10099,8 @@ paths: description: | The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a record set, the following format is recommended: - {namespaceName}-{deploymentName}-{containerName} + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. minLength: 1 maxLength: 128 github_repository: @@ -25336,8 +25337,15 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: - '204': + '200': description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/workflow-dispatch-response" + examples: + default: + "$ref": "#/components/examples/workflow-dispatch-response" requestBody: required: true content: @@ -90218,18 +90226,27 @@ components: - updated_at workflow-run-id: title: Workflow Run ID - description: The unique identifier for a workflow run + description: The ID of the workflow run. type: integer format: int64 workflow-dispatch-response: title: Workflow Dispatch Response - description: Response containing the workflow run ID + description: Response containing the workflow run ID and URLs. type: object properties: workflow_run_id: "$ref": "#/components/schemas/workflow-run-id" + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri required: - workflow_run_id + - run_url + - html_url workflow-usage: title: Workflow Usage description: Workflow Usage @@ -222778,6 +222795,8 @@ components: workflow-dispatch-response: value: workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 workflow-usage: value: billable: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index e72800b67..8a9beb0ed 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -99862,7 +99862,7 @@ }, "deployment_name": { "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}\n", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", "minLength": 1, "maxLength": 128 }, @@ -268747,8 +268747,48 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Workflow Dispatch Response", + "description": "Response containing the workflow run ID and URLs.", + "type": "object", + "properties": { + "workflow_run_id": { + "title": "Workflow Run ID", + "description": "The ID of the workflow run.", + "type": "integer", + "format": "int64" + }, + "run_url": { + "type": "string", + "format": "uri", + "description": "The URL to the workflow run." + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "workflow_run_id", + "run_url", + "html_url" + ] + }, + "examples": { + "default": { + "value": { + "workflow_run_id": 1, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" + } + } + } + } + } } }, "requestBody": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index d25fea90c..fb253ff04 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -25470,7 +25470,8 @@ paths: description: | The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a record set, the following format is recommended: - {namespaceName}-{deploymentName}-{containerName} + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. minLength: 1 maxLength: 128 github_repository: @@ -56047,8 +56048,37 @@ paths: - *312 - *363 responses: - '204': + '200': description: Response + content: + application/json: + schema: + title: Workflow Dispatch Response + description: Response containing the workflow run ID and URLs. + type: object + properties: + workflow_run_id: + title: Workflow Run ID + description: The ID of the workflow run. + type: integer + format: int64 + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri + required: + - workflow_run_id + - run_url + - html_url + examples: + default: + value: + workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 requestBody: required: true content: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index e72800b67..8a9beb0ed 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -99862,7 +99862,7 @@ }, "deployment_name": { "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}\n", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", "minLength": 1, "maxLength": 128 }, @@ -268747,8 +268747,48 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Workflow Dispatch Response", + "description": "Response containing the workflow run ID and URLs.", + "type": "object", + "properties": { + "workflow_run_id": { + "title": "Workflow Run ID", + "description": "The ID of the workflow run.", + "type": "integer", + "format": "int64" + }, + "run_url": { + "type": "string", + "format": "uri", + "description": "The URL to the workflow run." + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "workflow_run_id", + "run_url", + "html_url" + ] + }, + "examples": { + "default": { + "value": { + "workflow_run_id": 1, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" + } + } + } + } + } } }, "requestBody": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index d25fea90c..fb253ff04 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -25470,7 +25470,8 @@ paths: description: | The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a record set, the following format is recommended: - {namespaceName}-{deploymentName}-{containerName} + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. minLength: 1 maxLength: 128 github_repository: @@ -56047,8 +56048,37 @@ paths: - *312 - *363 responses: - '204': + '200': description: Response + content: + application/json: + schema: + title: Workflow Dispatch Response + description: Response containing the workflow run ID and URLs. + type: object + properties: + workflow_run_id: + title: Workflow Run ID + description: The ID of the workflow run. + type: integer + format: int64 + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri + required: + - workflow_run_id + - run_url + - html_url + examples: + default: + value: + workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 requestBody: required: true content: diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 47bb3ad4d..47d6cdffb 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -146397,7 +146397,7 @@ }, "deployment_name": { "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}\n", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", "minLength": 1, "maxLength": 128 }, @@ -325090,8 +325090,48 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Workflow Dispatch Response", + "description": "Response containing the workflow run ID and URLs.", + "type": "object", + "properties": { + "workflow_run_id": { + "title": "Workflow Run ID", + "description": "The ID of the workflow run.", + "type": "integer", + "format": "int64" + }, + "run_url": { + "type": "string", + "format": "uri", + "description": "The URL to the workflow run." + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "workflow_run_id", + "run_url", + "html_url" + ] + }, + "examples": { + "default": { + "value": { + "workflow_run_id": 1, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" + } + } + } + } + } } }, "requestBody": { diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index adf6872a3..9199dc7cd 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -38548,7 +38548,8 @@ paths: description: | The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a record set, the following format is recommended: - {namespaceName}-{deploymentName}-{containerName} + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. minLength: 1 maxLength: 128 github_repository: @@ -68422,8 +68423,37 @@ paths: - *442 - *479 responses: - '204': + '200': description: Response + content: + application/json: + schema: + title: Workflow Dispatch Response + description: Response containing the workflow run ID and URLs. + type: object + properties: + workflow_run_id: + title: Workflow Run ID + description: The ID of the workflow run. + type: integer + format: int64 + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri + required: + - workflow_run_id + - run_url + - html_url + examples: + default: + value: + workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 requestBody: required: true content: diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 47bb3ad4d..47d6cdffb 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -146397,7 +146397,7 @@ }, "deployment_name": { "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}\n", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", "minLength": 1, "maxLength": 128 }, @@ -325090,8 +325090,48 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Workflow Dispatch Response", + "description": "Response containing the workflow run ID and URLs.", + "type": "object", + "properties": { + "workflow_run_id": { + "title": "Workflow Run ID", + "description": "The ID of the workflow run.", + "type": "integer", + "format": "int64" + }, + "run_url": { + "type": "string", + "format": "uri", + "description": "The URL to the workflow run." + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "workflow_run_id", + "run_url", + "html_url" + ] + }, + "examples": { + "default": { + "value": { + "workflow_run_id": 1, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" + } + } + } + } + } } }, "requestBody": { diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index adf6872a3..9199dc7cd 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -38548,7 +38548,8 @@ paths: description: | The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a record set, the following format is recommended: - {namespaceName}-{deploymentName}-{containerName} + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. minLength: 1 maxLength: 128 github_repository: @@ -68422,8 +68423,37 @@ paths: - *442 - *479 responses: - '204': + '200': description: Response + content: + application/json: + schema: + title: Workflow Dispatch Response + description: Response containing the workflow run ID and URLs. + type: object + properties: + workflow_run_id: + title: Workflow Run ID + description: The ID of the workflow run. + type: integer + format: int64 + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri + required: + - workflow_run_id + - run_url + - html_url + examples: + default: + value: + workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 requestBody: required: true content: diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 0e7ec099f..95c4fca37 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -23725,7 +23725,7 @@ }, "deployment_name": { "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}\n", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", "minLength": 1, "maxLength": 128 }, @@ -46958,8 +46958,20 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-dispatch-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-dispatch-response" + } + } + } + } } }, "requestBody": { @@ -145661,21 +145673,32 @@ }, "workflow-run-id": { "title": "Workflow Run ID", - "description": "The unique identifier for a workflow run", + "description": "The ID of the workflow run.", "type": "integer", "format": "int64" }, "workflow-dispatch-response": { "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID", + "description": "Response containing the workflow run ID and URLs.", "type": "object", "properties": { "workflow_run_id": { "$ref": "#/components/schemas/workflow-run-id" + }, + "run_url": { + "type": "string", + "format": "uri", + "description": "The URL to the workflow run." + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "workflow_run_id" + "workflow_run_id", + "run_url", + "html_url" ] }, "workflow-usage": { @@ -325211,7 +325234,9 @@ }, "workflow-dispatch-response": { "value": { - "workflow_run_id": 1 + "workflow_run_id": 1, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" } }, "workflow-usage": { diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 513ecd7bd..0a41c56b7 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -17060,7 +17060,8 @@ paths: description: | The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a record set, the following format is recommended: - {namespaceName}-{deploymentName}-{containerName} + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. minLength: 1 maxLength: 128 github_repository: @@ -33891,8 +33892,15 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: - '204': + '200': description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/workflow-dispatch-response" + examples: + default: + "$ref": "#/components/examples/workflow-dispatch-response" requestBody: required: true content: @@ -105528,18 +105536,27 @@ components: - updated_at workflow-run-id: title: Workflow Run ID - description: The unique identifier for a workflow run + description: The ID of the workflow run. type: integer format: int64 workflow-dispatch-response: title: Workflow Dispatch Response - description: Response containing the workflow run ID + description: Response containing the workflow run ID and URLs. type: object properties: workflow_run_id: "$ref": "#/components/schemas/workflow-run-id" + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri required: - workflow_run_id + - run_url + - html_url workflow-usage: title: Workflow Usage description: Workflow Usage @@ -240249,6 +240266,8 @@ components: workflow-dispatch-response: value: workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 workflow-usage: value: billable: diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 0e7ec099f..95c4fca37 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -23725,7 +23725,7 @@ }, "deployment_name": { "type": "string", - "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}\n", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", "minLength": 1, "maxLength": 128 }, @@ -46958,8 +46958,20 @@ } ], "responses": { - "204": { - "description": "Response" + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-dispatch-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-dispatch-response" + } + } + } + } } }, "requestBody": { @@ -145661,21 +145673,32 @@ }, "workflow-run-id": { "title": "Workflow Run ID", - "description": "The unique identifier for a workflow run", + "description": "The ID of the workflow run.", "type": "integer", "format": "int64" }, "workflow-dispatch-response": { "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID", + "description": "Response containing the workflow run ID and URLs.", "type": "object", "properties": { "workflow_run_id": { "$ref": "#/components/schemas/workflow-run-id" + }, + "run_url": { + "type": "string", + "format": "uri", + "description": "The URL to the workflow run." + }, + "html_url": { + "type": "string", + "format": "uri" } }, "required": [ - "workflow_run_id" + "workflow_run_id", + "run_url", + "html_url" ] }, "workflow-usage": { @@ -325211,7 +325234,9 @@ }, "workflow-dispatch-response": { "value": { - "workflow_run_id": 1 + "workflow_run_id": 1, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" } }, "workflow-usage": { diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 513ecd7bd..0a41c56b7 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -17060,7 +17060,8 @@ paths: description: | The unique identifier for the deployment represented by the new record. To accommodate differing containers and namespaces within a record set, the following format is recommended: - {namespaceName}-{deploymentName}-{containerName} + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. minLength: 1 maxLength: 128 github_repository: @@ -33891,8 +33892,15 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/workflow-id" responses: - '204': + '200': description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/workflow-dispatch-response" + examples: + default: + "$ref": "#/components/examples/workflow-dispatch-response" requestBody: required: true content: @@ -105528,18 +105536,27 @@ components: - updated_at workflow-run-id: title: Workflow Run ID - description: The unique identifier for a workflow run + description: The ID of the workflow run. type: integer format: int64 workflow-dispatch-response: title: Workflow Dispatch Response - description: Response containing the workflow run ID + description: Response containing the workflow run ID and URLs. type: object properties: workflow_run_id: "$ref": "#/components/schemas/workflow-run-id" + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri required: - workflow_run_id + - run_url + - html_url workflow-usage: title: Workflow Usage description: Workflow Usage @@ -240249,6 +240266,8 @@ components: workflow-dispatch-response: value: workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 workflow-usage: value: billable: diff --git a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json index 7b1c5cd5a..2e4194b4f 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json +++ b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.json @@ -111541,25 +111541,6 @@ "updated_at" ] }, - "workflow-run-id": { - "title": "Workflow Run ID", - "description": "The unique identifier for a workflow run", - "type": "integer", - "format": "int64" - }, - "workflow-dispatch-response": { - "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID", - "type": "object", - "properties": { - "workflow_run_id": { - "$ref": "#/components/schemas/workflow-run-id" - } - }, - "required": [ - "workflow_run_id" - ] - }, "activity": { "title": "Activity", "description": "Activity", @@ -276776,11 +276757,6 @@ "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" } }, - "workflow-dispatch-response": { - "value": { - "workflow_run_id": 1 - } - }, "activity-items": { "value": [ { diff --git a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml index 7c089d678..db9925923 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml +++ b/descriptions-next/ghes-3.14/ghes-3.14.2022-11-28.yaml @@ -80310,20 +80310,6 @@ components: - badge_url - created_at - updated_at - workflow-run-id: - title: Workflow Run ID - description: The unique identifier for a workflow run - type: integer - format: int64 - workflow-dispatch-response: - title: Workflow Dispatch Response - description: Response containing the workflow run ID - type: object - properties: - workflow_run_id: - "$ref": "#/components/schemas/workflow-run-id" - required: - - workflow_run_id activity: title: Activity description: Activity @@ -204179,9 +204165,6 @@ components: url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg - workflow-dispatch-response: - value: - workflow_run_id: 1 activity-items: value: - id: 1296269 diff --git a/descriptions-next/ghes-3.14/ghes-3.14.json b/descriptions-next/ghes-3.14/ghes-3.14.json index 7b1c5cd5a..2e4194b4f 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.json +++ b/descriptions-next/ghes-3.14/ghes-3.14.json @@ -111541,25 +111541,6 @@ "updated_at" ] }, - "workflow-run-id": { - "title": "Workflow Run ID", - "description": "The unique identifier for a workflow run", - "type": "integer", - "format": "int64" - }, - "workflow-dispatch-response": { - "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID", - "type": "object", - "properties": { - "workflow_run_id": { - "$ref": "#/components/schemas/workflow-run-id" - } - }, - "required": [ - "workflow_run_id" - ] - }, "activity": { "title": "Activity", "description": "Activity", @@ -276776,11 +276757,6 @@ "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" } }, - "workflow-dispatch-response": { - "value": { - "workflow_run_id": 1 - } - }, "activity-items": { "value": [ { diff --git a/descriptions-next/ghes-3.14/ghes-3.14.yaml b/descriptions-next/ghes-3.14/ghes-3.14.yaml index 7c089d678..db9925923 100644 --- a/descriptions-next/ghes-3.14/ghes-3.14.yaml +++ b/descriptions-next/ghes-3.14/ghes-3.14.yaml @@ -80310,20 +80310,6 @@ components: - badge_url - created_at - updated_at - workflow-run-id: - title: Workflow Run ID - description: The unique identifier for a workflow run - type: integer - format: int64 - workflow-dispatch-response: - title: Workflow Dispatch Response - description: Response containing the workflow run ID - type: object - properties: - workflow_run_id: - "$ref": "#/components/schemas/workflow-run-id" - required: - - workflow_run_id activity: title: Activity description: Activity @@ -204179,9 +204165,6 @@ components: url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg - workflow-dispatch-response: - value: - workflow_run_id: 1 activity-items: value: - id: 1296269 diff --git a/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json index d279fb1fd..48caaa7dd 100644 --- a/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json +++ b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.json @@ -112414,25 +112414,6 @@ "updated_at" ] }, - "workflow-run-id": { - "title": "Workflow Run ID", - "description": "The unique identifier for a workflow run", - "type": "integer", - "format": "int64" - }, - "workflow-dispatch-response": { - "title": "Workflow Dispatch Response", - "description": "Response containing the workflow run ID", - "type": "object", - "properties": { - "workflow_run_id": { - "$ref": "#/components/schemas/workflow-run-id" - } - }, - "required": [ - "workflow_run_id" - ] - }, "activity": { "title": "Activity", "description": "Activity", @@ -277447,11 +277428,6 @@ "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" } }, - "workflow-dispatch-response": { - "value": { - "workflow_run_id": 1 - } - }, "activity-items": { "value": [ { diff --git a/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml index ba32145e7..08ced7d6b 100644 --- a/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml +++ b/descriptions-next/ghes-3.15/ghes-3.15.2022-11-28.yaml @@ -81043,20 +81043,6 @@ components: - badge_url - created_at - updated_at - workflow-run-id: - title: Workflow Run ID - description: The unique identifier for a workflow run - type: integer - format: int64 - workflow-dispatch-response: - title: Workflow Dispatch Response - description: Response containing the workflow run ID - type: object - properties: - workflow_run_id: - "$ref": "#/components/schemas/workflow-run-id" - required: - - workflow_run_id activity: title: Activity description: Activity @@ -204839,9 +204825,6 @@{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}