diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 823c9403e..d6637ff38 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -13897,7 +13897,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 }, @@ -34869,8 +34869,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": { @@ -122143,21 +122155,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": { @@ -291924,7 +291947,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 8b2d200c3..0a43113bf 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -10065,7 +10065,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: @@ -25254,8 +25255,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: @@ -89767,18 +89775,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 @@ -219519,6 +219536,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 823c9403e..d6637ff38 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -13897,7 +13897,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 }, @@ -34869,8 +34869,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": { @@ -122143,21 +122155,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": { @@ -291924,7 +291947,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/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 8b2d200c3..0a43113bf 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -10065,7 +10065,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: @@ -25254,8 +25255,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: @@ -89767,18 +89775,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 @@ -219519,6 +219536,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 1b1074aa4..b59a9a31e 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -86596,7 +86596,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 }, @@ -232527,8 +232527,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 24d6a2155..2a74a3f1c 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -24678,7 +24678,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: @@ -54483,8 +54484,37 @@ paths: - *328 - *379 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/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 1b1074aa4..b59a9a31e 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -86596,7 +86596,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 }, @@ -232527,8 +232527,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/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 24d6a2155..2a74a3f1c 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -24678,7 +24678,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: @@ -54483,8 +54484,37 @@ paths: - *328 - *379 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/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index ae1f4de04..fd6f9e06e 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -129885,7 +129885,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 }, @@ -284918,8 +284918,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/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 1fe82ed32..5fe83bcff 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -37544,7 +37544,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: @@ -66690,8 +66691,37 @@ paths: - *460 - *497 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/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index ae1f4de04..fd6f9e06e 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -129885,7 +129885,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 }, @@ -284918,8 +284918,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/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 1fe82ed32..5fe83bcff 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -37544,7 +37544,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: @@ -66690,8 +66691,37 @@ paths: - *460 - *497 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/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index cde38262a..76e23fbc5 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -23637,7 +23637,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 }, @@ -46772,8 +46772,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": { @@ -143170,21 +143182,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": { @@ -315844,7 +315867,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/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 07efac65e..971b2b7cd 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -17018,7 +17018,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: @@ -33799,8 +33800,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: @@ -104949,18 +104957,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 @@ -236788,6 +236805,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/ghec/ghec.json b/descriptions/ghec/ghec.json index cde38262a..76e23fbc5 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -23637,7 +23637,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 }, @@ -46772,8 +46772,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": { @@ -143170,21 +143182,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": { @@ -315844,7 +315867,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/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 07efac65e..971b2b7cd 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -17018,7 +17018,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: @@ -33799,8 +33800,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: @@ -104949,18 +104957,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 @@ -236788,6 +236805,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/ghes-3.14/ghes-3.14.2022-11-28.json b/descriptions/ghes-3.14/ghes-3.14.2022-11-28.json index 737b723c7..ef08306c3 100644 --- a/descriptions/ghes-3.14/ghes-3.14.2022-11-28.json +++ b/descriptions/ghes-3.14/ghes-3.14.2022-11-28.json @@ -109434,25 +109434,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", @@ -268329,11 +268310,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/ghes-3.14/ghes-3.14.2022-11-28.yaml b/descriptions/ghes-3.14/ghes-3.14.2022-11-28.yaml index 52d1c61cd..72e0f237b 100644 --- a/descriptions/ghes-3.14/ghes-3.14.2022-11-28.yaml +++ b/descriptions/ghes-3.14/ghes-3.14.2022-11-28.yaml @@ -79749,20 +79749,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 @@ -200943,9 +200929,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/ghes-3.14/ghes-3.14.json b/descriptions/ghes-3.14/ghes-3.14.json index 737b723c7..ef08306c3 100644 --- a/descriptions/ghes-3.14/ghes-3.14.json +++ b/descriptions/ghes-3.14/ghes-3.14.json @@ -109434,25 +109434,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", @@ -268329,11 +268310,6 @@ "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" } {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}