diff options
Diffstat (limited to 'descriptions/api.github.com/api.github.com.yaml')
| -rw-r--r-- | descriptions/api.github.com/api.github.com.yaml | 70 |
1 files changed, 61 insertions, 9 deletions
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 |