diff options
24 files changed, 406 insertions, 68 deletions
diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 2254b5523..1460f63da 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { @@ -17322,7 +17322,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { "get": { "summary": "Get a workflow", - "description": "Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "actions" ], @@ -17370,10 +17370,49 @@ } } }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + "put": { + "summary": "Disable a workflow", + "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/disable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/workflows/#disable-a-workflow" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/workflow-id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { "post": { "summary": "Create a workflow dispatch event", - "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", "operationId": "actions/create-workflow-dispatch", "tags": [ "actions" @@ -17442,10 +17481,49 @@ } } }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + "put": { + "summary": "Enable a workflow", + "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/enable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/workflows/#enable-a-workflow" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/workflow-id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs", - "description": "List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" ], @@ -17530,7 +17608,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { "get": { "summary": "Get workflow usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "actions" ], diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 2659b7ffe..a939808b7 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: @@ -12464,11 +12464,11 @@ paths: "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": get: summary: Get a workflow - description: Gets a specific workflow. You can also replace `:workflow_id` with - `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with - read access to the repository can use this endpoint. If the repository is - private you must use an access token with the `repo` scope. GitHub Apps must - have the `actions:read` permission to use this endpoint. + description: Gets a specific workflow. You can replace `workflow_id` with the + workflow file name. For example, you could use `main.yaml`. Anyone with read + access to the repository can use this endpoint. If the repository is private + you must use an access token with the `repo` scope. GitHub Apps must have + the `actions:read` permission to use this endpoint. tags: - actions operationId: actions/get-workflow @@ -12495,11 +12495,37 @@ paths: previews: [] category: actions subcategory: workflows + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": + put: + summary: Disable a workflow + description: |- + Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + + You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + tags: + - actions + operationId: actions/disable-workflow + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflows/#disable-a-workflow + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/workflow-id" + responses: + '204': + description: Empty response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: workflows "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": post: summary: Create a workflow dispatch event description: |- - You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yaml`. + You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." @@ -12549,11 +12575,37 @@ paths: previews: [] category: actions subcategory: workflows + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": + put: + summary: Enable a workflow + description: |- + Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + + You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + tags: + - actions + operationId: actions/enable-workflow + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflows/#enable-a-workflow + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/workflow-id" + responses: + '204': + description: Empty response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: workflows "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": get: summary: List workflow runs description: |- - List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters). + List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters). Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. tags: @@ -12606,7 +12658,7 @@ paths: Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. tags: - actions operationId: actions/get-workflow-usage 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 779f15b24..4380140d6 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { @@ -99735,7 +99735,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { "get": { "summary": "Get a workflow", - "description": "Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "actions" ], @@ -99884,10 +99884,72 @@ } } }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + "put": { + "summary": "Disable a workflow", + "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/disable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/workflows/#disable-a-workflow" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { "post": { "summary": "Create a workflow dispatch event", - "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", "operationId": "actions/create-workflow-dispatch", "tags": [ "actions" @@ -99979,10 +100041,72 @@ } } }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + "put": { + "summary": "Enable a workflow", + "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/enable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/v3/actions/workflows/#enable-a-workflow" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs", - "description": "List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" ], @@ -101642,7 +101766,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { "get": { "summary": "Get workflow usage", - "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "**Warning:** This GitHub Actions usage endpoint is currently in public beta and subject to change. For more information, see \"[GitHub Actions API workflow usage](https://developer.github.com/changes/2020-05-15-actions-api-workflow-usage).\"\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "actions" ], 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 1abe3b88d..f7e0b4859 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: @@ -76495,11 +76495,11 @@ paths: "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": get: summary: Get a workflow - description: Gets a specific workflow. You can also replace `:workflow_id` with - `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with - read access to the repository can use this endpoint. If the repository is - private you must use an access token with the `repo` scope. GitHub Apps must - have the `actions:read` permission to use this endpoint. + description: Gets a specific workflow. You can replace `workflow_id` with the + workflow file name. For example, you could use `main.yaml`. Anyone with read + access to the repository can use this endpoint. If the repository is private + you must use an access token with the `repo` scope. GitHub Apps must have + the `actions:read` permission to use this endpoint. tags: - actions operationId: actions/get-workflow @@ -76605,11 +76605,53 @@ paths: previews: [] category: actions subcategory: workflows + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": + put: + summary: Disable a workflow + description: |- + Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + + You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + tags: + - actions + operationId: actions/disable-workflow + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflows/#disable-a-workflow + parameters: + - name: owner + in: path + required: true + schema: + type: string + - name: repo + in: path + required: true + schema: + type: string + - name: workflow_id + in: path + description: The ID of the workflow. You can also pass the workflow file name + as a string. + required: true + schema: + oneOf: + - type: integer + - type: string + responses: + '204': + description: Empty response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: workflows "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": post: summary: Create a workflow dispatch event description: |- - You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yaml`. + You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." @@ -76675,11 +76717,53 @@ paths: previews: [] category: actions subcategory: workflows + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": + put: + summary: Enable a workflow + description: |- + Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + + You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + tags: + - actions + operationId: actions/enable-workflow + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/workflows/#enable-a-workflow + parameters: + - name: owner + in: path + required: true + schema: + type: string + - name: repo + in: path + required: true + schema: + type: string + - name: workflow_id + in: path + description: The ID of the workflow. You can also pass the workflow file name + as a string. + required: true + schema: + oneOf: + - type: integer + - type: string + responses: + '204': + description: Empty response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: workflows "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": get: summary: List workflow runs description: |- - List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters). + List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters). Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. tags: @@ -77981,7 +78065,7 @@ paths: Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. tags: - actions operationId: actions/get-workflow-usage diff --git a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json index 13028c126..960e4f365 100644 --- a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json +++ b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml index 6f9142958..302f40561 100644 --- a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml +++ b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.18/ghes-2.18.json b/descriptions/ghes-2.18/ghes-2.18.json index c6f2a9a45..d1e387adb 100644 --- a/descriptions/ghes-2.18/ghes-2.18.json +++ b/descriptions/ghes-2.18/ghes-2.18.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.18/ghes-2.18.yaml b/descriptions/ghes-2.18/ghes-2.18.yaml index b0619d696..18f3d65b2 100644 --- a/descriptions/ghes-2.18/ghes-2.18.yaml +++ b/descriptions/ghes-2.18/ghes-2.18.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json index 2813b0afd..bfe6a407e 100644 --- a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json +++ b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml index d51b66d9a..4564b65be 100644 --- a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml +++ b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.19/ghes-2.19.json b/descriptions/ghes-2.19/ghes-2.19.json index 986ae91c4..6f5450df7 100644 --- a/descriptions/ghes-2.19/ghes-2.19.json +++ b/descriptions/ghes-2.19/ghes-2.19.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.19/ghes-2.19.yaml b/descriptions/ghes-2.19/ghes-2.19.yaml index c68675a53..72146983f 100644 --- a/descriptions/ghes-2.19/ghes-2.19.yaml +++ b/descriptions/ghes-2.19/ghes-2.19.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json index 6b752c0f8..3fbf2c3c6 100644 --- a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json +++ b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml index 72d35ccb1..8643ba3a5 100644 --- a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml +++ b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.20/ghes-2.20.json b/descriptions/ghes-2.20/ghes-2.20.json index ae4b3fe67..479b284fe 100644 --- a/descriptions/ghes-2.20/ghes-2.20.json +++ b/descriptions/ghes-2.20/ghes-2.20.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.20/ghes-2.20.yaml b/descriptions/ghes-2.20/ghes-2.20.yaml index 1f2e3d603..9fa5369c9 100644 --- a/descriptions/ghes-2.20/ghes-2.20.yaml +++ b/descriptions/ghes-2.20/ghes-2.20.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json index 3033eb7b3..2aa622aec 100644 --- a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json +++ b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml index f079cb576..4b1ccf48e 100644 --- a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml +++ b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.21/ghes-2.21.json b/descriptions/ghes-2.21/ghes-2.21.json index 98af798bc..68d9b5070 100644 --- a/descriptions/ghes-2.21/ghes-2.21.json +++ b/descriptions/ghes-2.21/ghes-2.21.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { diff --git a/descriptions/ghes-2.21/ghes-2.21.yaml b/descriptions/ghes-2.21/ghes-2.21.yaml index 447b56bdb..bb85023a1 100644 --- a/descriptions/ghes-2.21/ghes-2.21.yaml +++ b/descriptions/ghes-2.21/ghes-2.21.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: diff --git a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json index aa86cc70b..3ed88f6a2 100644 --- a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json +++ b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { @@ -93697,7 +93697,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { "get": { "summary": "Get a workflow", - "description": "Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "actions" ], @@ -93849,7 +93849,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { "post": { "summary": "Create a workflow dispatch event", - "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", "operationId": "actions/create-workflow-dispatch", "tags": [ "actions" @@ -93944,7 +93944,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs", - "description": "List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/enterprise/2.22/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/enterprise/2.22/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" ], diff --git a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml index 9bff892aa..8281ca197 100644 --- a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml +++ b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: @@ -71804,11 +71804,11 @@ paths: "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": get: summary: Get a workflow - description: Gets a specific workflow. You can also replace `:workflow_id` with - `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with - read access to the repository can use this endpoint. If the repository is - private you must use an access token with the `repo` scope. GitHub Apps must - have the `actions:read` permission to use this endpoint. + description: Gets a specific workflow. You can replace `workflow_id` with the + workflow file name. For example, you could use `main.yaml`. Anyone with read + access to the repository can use this endpoint. If the repository is private + you must use an access token with the `repo` scope. GitHub Apps must have + the `actions:read` permission to use this endpoint. tags: - actions operationId: actions/get-workflow @@ -71918,7 +71918,7 @@ paths: post: summary: Create a workflow dispatch event description: |- - You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yaml`. + You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." @@ -71988,7 +71988,7 @@ paths: get: summary: List workflow runs description: |- - List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/enterprise/2.22/v3/#parameters). + List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/enterprise/2.22/v3/#parameters). Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. tags: diff --git a/descriptions/ghes-2.22/ghes-2.22.json b/descriptions/ghes-2.22/ghes-2.22.json index 9142fac7a..18b91b87f 100644 --- a/descriptions/ghes-2.22/ghes-2.22.json +++ b/descriptions/ghes-2.22/ghes-2.22.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "1.0.0-rc.3", + "version": "1.0.0-rc.4", "title": "GitHub v3 REST API", "description": "GitHub's v3 REST API.", "license": { @@ -17672,7 +17672,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { "get": { "summary": "Get a workflow", - "description": "Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "actions" ], @@ -17723,7 +17723,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { "post": { "summary": "Create a workflow dispatch event", - "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", "operationId": "actions/create-workflow-dispatch", "tags": [ "actions" @@ -17795,7 +17795,7 @@ "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { "summary": "List workflow runs", - "description": "List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/enterprise/2.22/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/enterprise/2.22/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" ], diff --git a/descriptions/ghes-2.22/ghes-2.22.yaml b/descriptions/ghes-2.22/ghes-2.22.yaml index b556c5179..6b62b2843 100644 --- a/descriptions/ghes-2.22/ghes-2.22.yaml +++ b/descriptions/ghes-2.22/ghes-2.22.yaml @@ -1,7 +1,7 @@ --- openapi: 3.0.3 info: - version: 1.0.0-rc.3 + version: 1.0.0-rc.4 title: GitHub v3 REST API description: GitHub's v3 REST API. license: @@ -12748,11 +12748,11 @@ paths: "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": get: summary: Get a workflow - description: Gets a specific workflow. You can also replace `:workflow_id` with - `:workflow_file_name`. For example, you could use `main.yaml`. Anyone with - read access to the repository can use this endpoint. If the repository is - private you must use an access token with the `repo` scope. GitHub Apps must - have the `actions:read` permission to use this endpoint. + description: Gets a specific workflow. You can replace `workflow_id` with the + workflow file name. For example, you could use `main.yaml`. Anyone with read + access to the repository can use this endpoint. If the repository is private + you must use an access token with the `repo` scope. GitHub Apps must have + the `actions:read` permission to use this endpoint. tags: - actions operationId: actions/get-workflow @@ -12783,7 +12783,7 @@ paths: post: summary: Create a workflow dispatch event description: |- - You can use this endpoint to manually trigger a GitHub Actions workflow run. You can also replace `{workflow_id}` with the workflow file name. For example, you could use `main.yaml`. + You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." @@ -12837,7 +12837,7 @@ paths: get: summary: List workflow runs description: |- - List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/enterprise/2.22/v3/#parameters). + List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/enterprise/2.22/v3/#parameters). Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. tags: |