diff options
| author | github-openapi-bot <security+github-openapi-bot@github.com> | 2020-09-17 07:32:12 -0700 |
|---|---|---|
| committer | github-openapi-bot <security+github-openapi-bot@github.com> | 2020-09-17 07:32:12 -0700 |
| commit | 65fef3795686d51bb7243376e99b3f4ec8f7a47b (patch) | |
| tree | 50cf2b027fc5326ccbcba01766e5115f8ed4cfac /descriptions/api.github.com/dereferenced/api.github.com.deref.yaml | |
| parent | 225d2ff34b8d16a18640ddd645f80a0f886aec85 (diff) | |
| download | rest-api-description-65fef3795686d51bb7243376e99b3f4ec8f7a47b.tar.gz rest-api-description-65fef3795686d51bb7243376e99b3f4ec8f7a47b.zip | |
Update OpenAPI descriptions
Diffstat (limited to 'descriptions/api.github.com/dereferenced/api.github.com.deref.yaml')
| -rw-r--r-- | descriptions/api.github.com/dereferenced/api.github.com.deref.yaml | 8004 |
1 files changed, 7405 insertions, 599 deletions
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 6474dc8d4..303fa24c0 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: 0.0.5 + version: 0.0.7 title: GitHub v3 REST API description: GitHub's v3 REST API. license: @@ -481,13 +481,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: "/app-manifests/{code}/conversions": @@ -1102,7 +1096,7 @@ paths: format: date-time single_file_name: type: string - example: config.yml + example: config.yaml nullable: true app_slug: type: string @@ -1259,7 +1253,7 @@ paths: events: - push - pull_request - single_file_name: config.yml + single_file_name: config.yaml repository_selection: selected created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' @@ -1273,13 +1267,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: "/app/installations/{installation_id}": @@ -1527,7 +1515,7 @@ paths: format: date-time single_file_name: type: string - example: config.yml + example: config.yaml nullable: true app_slug: type: string @@ -1684,7 +1672,7 @@ paths: events: - push - pull_request - single_file_name: config.yml + single_file_name: config.yaml repository_selection: selected created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' @@ -1719,13 +1707,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: delete: @@ -1766,13 +1748,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: false - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: "/app/installations/{installation_id}/access_tokens": @@ -2827,13 +2803,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: "/app/installations/{installation_id}/suspended": @@ -3782,7 +3752,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -4214,7 +4184,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -4709,7 +4679,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -5092,7 +5062,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -5590,13 +5560,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: "/authorizations": @@ -5815,7 +5779,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -6246,7 +6210,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -6721,7 +6685,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -7051,7 +7015,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -7513,7 +7477,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -7836,7 +7800,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -8235,7 +8199,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -8648,7 +8612,7 @@ paths: - selected single_file_name: type: string - example: config.yml + example: config.yaml nullable: true repositories_url: type: string @@ -9455,7 +9419,2879 @@ paths: previews: [] category: emojis subcategory: - "/enterprises/{enterprise_id}/settings/billing/actions": + "/enterprises/{enterprise}/actions/runner-groups": + get: + summary: List self-hosted runner groups for an enterprise + description: |- + Lists all self-hosted runner groups for an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runner-groups-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#list-self-hosted-runner-groups-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: per_page + description: Results per page (max 100) + in: query + schema: + type: integer + default: 30 + - name: page + description: Page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + runner_groups: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_organizations_url: + type: string + runners_url: + type: string + examples: + default: + value: + total_count: 3 + runner_groups: + - id: 1 + name: Default + visibility: all + default: true + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners + - id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners + - id: 3 + name: expensive-hardware + visibility: private + default: false + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + post: + summary: Create a self-hosted runner group for an enterprise + description: |- + Creates a new self-hosted runner group for an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/create-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#create-self-hosted-runner-group-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: 'Visibility of a runner group. You can select all organizations + or select individual organization. Can be one of: `all` or `selected`' + type: string + enum: + - selected + - all + selected_organization_ids: + description: List of organization IDs that can access the runner + group. + type: array + items: + type: integer + description: Unique identifier of the organization. + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + required: + - name + example: + name: Expensive hardware runners + visibility: selected + selected_organization_ids: + - 32 + - 91 + runners: + - 9 + - 2 + responses: + '201': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_organizations_url: + type: string + runners_url: + type: string + examples: + default: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": + get: + summary: Get a self-hosted runner group for an enterprise + description: |- + Gets a specific self-hosted runner group for an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#get-a-self-hosted-runner-group-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_organizations_url: + type: string + runners_url: + type: string + examples: + default: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + patch: + summary: Update a self-hosted runner group for an enterprise + description: |- + Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/update-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#update-a-self-hosted-runner-group-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: 'Visibility of a runner group. You can select all organizations + or select individual organizations. Can be one of: `all` or `selected`' + type: string + enum: + - selected + - all + default: all + example: + name: Expensive hardware runners + visibility: selected + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_organizations_url: + type: string + runners_url: + type: string + examples: + default: + value: + id: 2 + name: Expensive hardware runners + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + delete: + summary: Delete a self-hosted runner group from an enterprise + description: |- + Deletes a self-hosted runner group for an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/delete-self-hosted-runner-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#delete-a-self-hosted-runner-group-from-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": + get: + summary: List organization access to a self-hosted runner group in an enterprise + description: |- + Lists the organizations with access to a self-hosted runner group. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#list-organization-access-to-a-self-hosted-runner-group-in-a-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: per_page + description: Results per page (max 100) + in: query + schema: + type: integer + default: 30 + - name: page + description: Page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + organizations: + type: array + items: + title: Organization Simple + description: Organization Simple + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + examples: + default: + value: + total_count: 1 + organizations: + - login: octocat + id: 161335 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + put: + summary: Set organization access for a self-hosted runner group in an enterprise + description: |- + Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#set-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_organization_ids: + description: List of organization IDs that can access the runner + group. + type: array + items: + type: integer + description: Unique identifier of the organization. + required: + - selected_organization_ids + example: + selected_organization_ids: + - 32 + - 91 + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": + put: + summary: Add organization access to a self-hosted runner group in an enterprise + description: |- + Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: org_id + description: Unique identifier of an organization. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + delete: + summary: Remove organization access to a self-hosted runner group in an enterprise + description: |- + Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: org_id + description: Unique identifier of an organization. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": + get: + summary: List self-hosted runners in a group for an enterprise + description: |- + Lists the self-hosted runners that are in a specific enterprise group. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runners-in-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#list-self-hosted-runners-in-a-group-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: per_page + description: Results per page (max 100) + in: query + schema: + type: integer + default: 30 + - name: page + description: Page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + runners: + type: array + items: + title: Self hosted runners + description: A self hosted runner + type: object + properties: + id: + description: The id of the runner. + type: integer + example: 5 + name: + description: The name of the runner. + type: string + example: iMac + os: + description: The Operating System of the runner. + type: string + example: macos + status: + description: The status of the runner. + type: string + example: online + busy: + type: boolean + labels: + type: array + items: + type: object + properties: + id: + type: integer + description: Unique identifier of the label. + name: + type: string + description: Name of the label. + type: + type: string + description: The type of label. Read-only labels are + applied automatically when the runner is configured. + enum: + - read-only + - custom + required: + - id + - name + - os + - status + - busy + - labels + examples: + default: + value: + total_count: 2 + runners: + - id: 23 + name: linux_runner + os: linux + status: online + busy: true + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 11 + name: Linux + type: read-only + - id: 24 + name: mac_runner + os: macos + status: offline + busy: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + headers: + Link: + example: <https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; + rel="last" + schema: + type: string + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + put: + summary: Set self-hosted runners in a group for an enterprise + description: |- + Replaces the list of self-hosted runners that that are part of an enterprise runner group. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-self-hosted-runners-in-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#set-self-hosted-runners-in-a-group-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + type: object + properties: + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + required: + - runners + example: + runners: + - 9 + - 2 + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": + put: + summary: Add a self-hosted runner to a group for an enterprise + description: |- + Adds a self-hosted runner to a runner group configured in an enterprise. + + You must authenticate using an access token with the `admin:enterprise` + scope to use this endpoint. + operationId: enterprise-admin/add-self-hosted-runner-to-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#add-a-self-hosted-runner-to-a-group-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: runner_id + description: Unique identifier of the self-hosted runner. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + delete: + summary: Remove a self-hosted runner from a group for an enterprise + description: |- + Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#remove-a-self-hosted-runner-from-a-group-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: runner_id + description: Unique identifier of the self-hosted runner. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/runners": + get: + summary: List self-hosted runners for an enterprise + description: |- + Lists all self-hosted runners configured for an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runners-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#list-self-hosted-runners-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: per_page + description: Results per page (max 100) + in: query + schema: + type: integer + default: 30 + - name: page + description: Page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + runners: + type: array + items: + title: Self hosted runners + description: A self hosted runner + type: object + properties: + id: + description: The id of the runner. + type: integer + example: 5 + name: + description: The name of the runner. + type: string + example: iMac + os: + description: The Operating System of the runner. + type: string + example: macos + status: + description: The status of the runner. + type: string + example: online + busy: + type: boolean + labels: + type: array + items: + type: object + properties: + id: + type: integer + description: Unique identifier of the label. + name: + type: string + description: Name of the label. + type: + type: string + description: The type of label. Read-only labels are + applied automatically when the runner is configured. + enum: + - read-only + - custom + required: + - id + - name + - os + - status + - busy + - labels + examples: + default: + value: + total_count: 2 + runners: + - id: 23 + name: linux_runner + os: linux + status: online + busy: true + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 11 + name: Linux + type: read-only + - id: 24 + name: mac_runner + os: macos + status: offline + busy: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + headers: + Link: + example: <https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; + rel="last" + schema: + type: string + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/runners/downloads": + get: + summary: List runner applications for an enterprise + description: |- + Lists binaries for the runner application that you can download and run. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-runner-applications-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#list-runner-applications-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: array + items: + title: Runner Application + description: Runner Application + type: object + properties: + os: + type: string + architecture: + type: string + download_url: + type: string + filename: + type: string + examples: + default: + value: + - os: osx + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz + filename: actions-runner-osx-x64-2.164.0.tar.gz + - os: linux + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz + filename: actions-runner-linux-x64-2.164.0.tar.gz + - os: linux + architecture: arm + download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz + filename: actions-runner-linux-arm-2.164.0.tar.gz + - os: win + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip + filename: actions-runner-win-x64-2.164.0.zip + - os: linux + architecture: arm64 + download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz + filename: actions-runner-linux-arm64-2.164.0.tar.gz + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/runners/registration-token": + post: + summary: Create a registration token for an enterprise + description: |- + Returns a token that you can pass to the `config` script. The token expires after one hour. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + + #### Example using registration token + + Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + + ``` + ./config.sh --url https://github.com/enterpises/octo-enterprise --token TOKEN + ``` + operationId: enterprise-admin/create-registration-token-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#create-a-registration-token-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + responses: + '201': + description: response + content: + application/json: + schema: + title: Authentication Token + description: Authentication Token + type: object + properties: + token: + description: The token used for authentication + type: string + example: v1.1f699f1069f60xxx + expires_at: + description: The time this token expires + type: string + format: date-time + example: '2016-07-11T22:14:10Z' + permissions: + type: object + example: + issues: read + deployments: write + repositories: + description: The repositories this token has access to + type: array + items: + title: Repository + description: A git repository + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + nullable: true + allOf: + - title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + nullable: true + allOf: + - title: Simple User + description: Simple User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: '' + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template + that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, + or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + template_repository: + type: object + nullable: true + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + owner: + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + avatar_url: + type: string + gravatar_id: + type: string + url: + type: string + html_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + organizations_url: + type: string + repos_url: + type: string + events_url: + type: string + received_events_url: + type: string + type: + type: string + site_admin: + type: boolean + private: + type: boolean + html_url: + type: string + description: + type: string + fork: + type: boolean + url: + type: string + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + downloads_url: + type: string + events_url: + type: string + forks_url: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + git_url: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + pulls_url: + type: string + releases_url: + type: string + ssh_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + clone_url: + type: string + mirror_url: + type: string + hooks_url: + type: string + svn_url: + type: string + homepage: + type: string + language: + type: string + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + created_at: + type: string + updated_at: + type: string + permissions: + type: object + properties: + admin: + type: boolean + push: + type: boolean + pull: + type: boolean + allow_rebase_merge: + type: boolean + template_repository: + type: string + temp_clone_token: + type: string + allow_squash_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_merge_commit: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + default: false + type: boolean + example: false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + subscribers_count: + type: integer + network_count: + type: integer + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + single_file: + type: string + example: config.yaml + nullable: true + repository_selection: + description: Describe whether all repositories have been selected + or there's a selection involved + type: string + enum: + - all + - selected + required: + - token + - expires_at + examples: + default: + value: + token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 + expires_at: '2020-01-22T12:13:35.123-08:00' + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/runners/remove-token": + post: + summary: Create a remove token for an enterprise + description: |- + Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + + #### Example using remove token + + To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + endpoint. + + ``` + ./config.sh remove --token TOKEN + ``` + operationId: enterprise-admin/create-remove-token-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#create-a-remove-token-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + responses: + '201': + description: response + content: + application/json: + schema: + title: Authentication Token + description: Authentication Token + type: object + properties: + token: + description: The token used for authentication + type: string + example: v1.1f699f1069f60xxx + expires_at: + description: The time this token expires + type: string + format: date-time + example: '2016-07-11T22:14:10Z' + permissions: + type: object + example: + issues: read + deployments: write + repositories: + description: The repositories this token has access to + type: array + items: + title: Repository + description: A git repository + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + nullable: true + allOf: + - title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + nullable: true + allOf: + - title: Simple User + description: Simple User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: '' + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template + that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, + or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + template_repository: + type: object + nullable: true + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + owner: + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + avatar_url: + type: string + gravatar_id: + type: string + url: + type: string + html_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + organizations_url: + type: string + repos_url: + type: string + events_url: + type: string + received_events_url: + type: string + type: + type: string + site_admin: + type: boolean + private: + type: boolean + html_url: + type: string + description: + type: string + fork: + type: boolean + url: + type: string + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + downloads_url: + type: string + events_url: + type: string + forks_url: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + git_url: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + pulls_url: + type: string + releases_url: + type: string + ssh_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + clone_url: + type: string + mirror_url: + type: string + hooks_url: + type: string + svn_url: + type: string + homepage: + type: string + language: + type: string + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + created_at: + type: string + updated_at: + type: string + permissions: + type: object + properties: + admin: + type: boolean + push: + type: boolean + pull: + type: boolean + allow_rebase_merge: + type: boolean + template_repository: + type: string + temp_clone_token: + type: string + allow_squash_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_merge_commit: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + default: false + type: boolean + example: false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + subscribers_count: + type: integer + network_count: + type: integer + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + single_file: + type: string + example: config.yaml + nullable: true + repository_selection: + description: Describe whether all repositories have been selected + or there's a selection involved + type: string + enum: + - all + - selected + required: + - token + - expires_at + examples: + default: + value: + token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 + expires_at: '2020-01-29T12:13:35.123-08:00' + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/actions/runners/{runner_id}": + get: + summary: Get a self-hosted runner for an enterprise + description: |- + Gets a specific self-hosted runner configured in an enterprise. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-self-hosted-runner-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#get-a-self-hosted-runner-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_id + description: Unique identifier of the self-hosted runner. + in: path + required: true + schema: + type: integer + responses: + '200': + description: response + content: + application/json: + schema: + title: Self hosted runners + description: A self hosted runner + type: object + properties: + id: + description: The id of the runner. + type: integer + example: 5 + name: + description: The name of the runner. + type: string + example: iMac + os: + description: The Operating System of the runner. + type: string + example: macos + status: + description: The status of the runner. + type: string + example: online + busy: + type: boolean + labels: + type: array + items: + type: object + properties: + id: + type: integer + description: Unique identifier of the label. + name: + type: string + description: Name of the label. + type: + type: string + description: The type of label. Read-only labels are applied + automatically when the runner is configured. + enum: + - read-only + - custom + required: + - id + - name + - os + - status + - busy + - labels + examples: + default: + value: + id: 23 + name: MBP + os: macos + status: online + busy: true + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + delete: + summary: Delete a self-hosted runner from an enterprise + description: |- + Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + + You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/delete-self-hosted-runner-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/actions/#delete-self-hosted-runner-from-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: runner_id + description: Unique identifier of the self-hosted runner. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + previews: [] + category: enterprise-admin + subcategory: actions + "/enterprises/{enterprise}/settings/billing/actions": get: summary: Get GitHub Actions billing for an enterprise description: |- @@ -9473,7 +12309,7 @@ paths: description: API method documentation url: https://developer.github.com/v3/billing/#get-github-actions-billing-for-an-enterprise parameters: - - name: enterprise_id + - name: enterprise description: Unique identifier of the GitHub Enterprise Cloud instance. in: path required: true @@ -9525,7 +12361,7 @@ paths: previews: [] category: enterprise-admin subcategory: billing - "/enterprises/{enterprise_id}/settings/billing/packages": + "/enterprises/{enterprise}/settings/billing/packages": get: summary: Get GitHub Packages billing for an enterprise description: |- @@ -9543,7 +12379,7 @@ paths: description: API method documentation url: https://developer.github.com/v3/billing/#get-github-packages-billing-for-an-enterprise parameters: - - name: enterprise_id + - name: enterprise description: Unique identifier of the GitHub Enterprise Cloud instance. in: path required: true @@ -9579,7 +12415,7 @@ paths: previews: [] category: enterprise-admin subcategory: billing - "/enterprises/{enterprise_id}/settings/billing/shared-storage": + "/enterprises/{enterprise}/settings/billing/shared-storage": get: summary: Get shared storage billing for an enterprise description: |- @@ -9597,7 +12433,7 @@ paths: description: API method documentation url: https://developer.github.com/v3/billing/#get-shared-storage-billing-for-an-enterprise parameters: - - name: enterprise_id + - name: enterprise description: Unique identifier of the GitHub Enterprise Cloud instance. in: path required: true @@ -18863,12 +21699,6 @@ paths: githubCloudOnly: false enabledForGitHubApps: true previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` - required: false name: mercy note: |- @@ -21005,12 +23835,6 @@ paths: enabledForGitHubApps: false previews: - required: false - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` - - required: false name: squirrel-girl note: |- An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details. @@ -27167,6 +29991,9 @@ paths: members_can_create_internal_repositories: type: boolean example: true + members_can_create_pages: + type: boolean + example: true updated_at: type: string format: date-time @@ -27243,6 +30070,7 @@ paths: members_can_create_public_repositories: false members_can_create_private_repositories: false members_can_create_internal_repositories: false + members_can_create_pages: true response-with-git-hub-plan-information: summary: Response with GitHub plan information value: @@ -27433,6 +30261,13 @@ paths: - all - private - none + members_can_create_pages: + type: boolean + description: "Toggles whether organization members can create GitHub + Pages sites. Can be one of: \n\\* `true` - all organization members + can create GitHub Pages sites. \n\\* `false` - no organization + members can create GitHub Pages sites. Existing published sites + will not be impacted. \nDefault: `true`. " blog: type: string example: '"http://github.blog"' @@ -27613,6 +30448,9 @@ paths: members_can_create_internal_repositories: type: boolean example: true + members_can_create_pages: + type: boolean + example: true updated_at: type: string format: date-time @@ -27687,6 +30525,7 @@ paths: members_can_create_public_repositories: false members_can_create_private_repositories: false members_can_create_internal_repositories: false + members_can_create_pages: true updated_at: '2014-03-03T18:58:10Z' '422': description: Validation Failed @@ -27789,13 +30628,1710 @@ paths: ``` category: orgs subcategory: + "/orgs/{org}/actions/runner-groups": + get: + summary: List self-hosted runner groups for an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/list-self-hosted-runner-groups-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#list-self-hosted-runner-groups-for-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: per_page + description: Results per page (max 100) + in: query + schema: + type: integer + default: 30 + - name: page + description: Page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + runner_groups: + type: array + items: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + type: string + runners_url: + type: string + inherited: + type: boolean + examples: + default: + value: + total_count: 3 + runner_groups: + - id: 1 + name: Default + visibility: all + default: true + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners + inherited: false + - id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + inherited: true + - id: 3 + name: expensive-hardware + visibility: private + default: false + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners + inherited: false + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + post: + summary: Create a self-hosted runner group for an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + Creates a new self-hosted runner group for an organization. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/create-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#create-a-self-hosted-runner-group-for-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: 'Visibility of a runner group. You can select all repositories, + select individual repositories, or limit access to private repositories. + Can be one of: `all`, `selected`, or `private`.' + type: string + enum: + - selected + - all + - private + default: all + selected_repository_ids: + description: List of repository IDs that can access the runner group. + type: array + items: + type: integer + description: Unique identifier of the repository. + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + required: + - name + example: + name: Expensive hardware runners + visibility: selected + selected_repository_ids: + - 32 + - 91 + runners: + - 9 + - 2 + responses: + '201': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + type: string + runners_url: + type: string + inherited: + type: boolean + examples: + default: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + inherited: false + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}": + get: + summary: Get a self-hosted runner group for an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + Gets a specific self-hosted runner group for an organization. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/get-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#get-a-self-hosted-runner-group-for-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + type: string + runners_url: + type: string + inherited: + type: boolean + examples: + default: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + inherited: false + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + patch: + summary: Update a self-hosted runner group for an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + Updates the `name` and `visibility` of a self-hosted runner group in an organization. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/update-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#update-a-self-hosted-runner-group-for-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: 'Visibility of a runner group. You can select all repositories, + select individual repositories, or all private repositories. Can + be one of: `all`, `selected`, or `private`.' + type: string + enum: + - selected + - all + - private + example: + name: Expensive hardware runners + visibility: selected + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + type: string + runners_url: + type: string + inherited: + type: boolean + examples: + default: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + inherited: false + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Delete a self-hosted runner group from an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + Deletes a self-hosted runner group for an organization. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/delete-self-hosted-runner-group-from-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#delete-a-self-hosted-runner-group-from-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": + get: + summary: List repository access to a self-hosted runner group in an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + Lists the repositories with access to a self-hosted runner group configured in an organization. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/list-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + repositories: + type: array + items: + title: Repository + description: A git repository + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + nullable: true + allOf: + - title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + nullable: true + allOf: + - title: Simple User + description: Simple User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: '' + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template + that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, + or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + template_repository: + type: object + nullable: true + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + owner: + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + avatar_url: + type: string + gravatar_id: + type: string + url: + type: string + html_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + organizations_url: + type: string + repos_url: + type: string + events_url: + type: string + received_events_url: + type: string + type: + type: string + site_admin: + type: boolean + private: + type: boolean + html_url: + type: string + description: + type: string + fork: + type: boolean + url: + type: string + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + downloads_url: + type: string + events_url: + type: string + forks_url: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + git_url: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + pulls_url: + type: string + releases_url: + type: string + ssh_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + clone_url: + type: string + mirror_url: + type: string + hooks_url: + type: string + svn_url: + type: string + homepage: + type: string + language: + type: string + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + created_at: + type: string + updated_at: + type: string + permissions: + type: object + properties: + admin: + type: boolean + push: + type: boolean + pull: + type: boolean + allow_rebase_merge: + type: boolean + template_repository: + type: string + temp_clone_token: + type: string + allow_squash_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_merge_commit: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + default: false + type: boolean + example: false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + subscribers_count: + type: integer + network_count: + type: integer + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + examples: + default: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set repository access for a self-hosted runner group in an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/set-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#set-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs that can access the runner group. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + example: + selected_repository_ids: + - 32 + - 91 + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": + put: + summary: Add repository access to a self-hosted runner group in an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + + Adds a repository to the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + + You must authenticate using an access token with the `admin:org` + scope to use this endpoint. + operationId: actions/add-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#add-repository-acess-to-a-self-hosted-runner-group-in-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove repository access to a self-hosted runner group in an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + + Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/remove-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": + get: + summary: List self-hosted runners in a group for an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + Lists self-hosted runners that are in a specific organization group. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/list-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#list-self-hosted-runners-in-a-group-for-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: per_page + description: Results per page (max 100) + in: query + schema: + type: integer + default: 30 + - name: page + description: Page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + runners: + type: array + items: + title: Self hosted runners + description: A self hosted runner + type: object + properties: + id: + description: The id of the runner. + type: integer + example: 5 + name: + description: The name of the runner. + type: string + example: iMac + os: + description: The Operating System of the runner. + type: string + example: macos + status: + description: The status of the runner. + type: string + example: online + busy: + type: boolean + labels: + type: array + items: + type: object + properties: + id: + type: integer + description: Unique identifier of the label. + name: + type: string + description: Name of the label. + type: + type: string + description: The type of label. Read-only labels are + applied automatically when the runner is configured. + enum: + - read-only + - custom + required: + - id + - name + - os + - status + - busy + - labels + examples: + default: + value: + total_count: 2 + runners: + - id: 23 + name: linux_runner + os: linux + status: online + busy: true + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 11 + name: Linux + type: read-only + - id: 24 + name: mac_runner + os: macos + status: offline + busy: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + headers: + Link: + example: <https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; + rel="last" + schema: + type: string + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set self-hosted runners in a group for an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + Replaces the list of self-hosted runners that are part of an organization runner group. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/set-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#set-self-hosted-runners-in-a-group-for-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + type: object + properties: + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + required: + - runners + example: + runners: + - 9 + - 2 + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": + put: + summary: Add a self-hosted runner to a group for an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + + Adds a self-hosted runner to a runner group configured in an organization. + + You must authenticate using an access token with the `admin:org` + scope to use this endpoint. + operationId: actions/add-self-hosted-runner-to-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#add-a-self-hosted-runner-to-a-group-for-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: runner_id + description: Unique identifier of the self-hosted runner. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove a self-hosted runner from a group for an organization + description: |- + The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)." + + + Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + + You must authenticate using an access token with the `admin:org` scope to use this endpoint. + operationId: actions/remove-self-hosted-runner-from-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/actions/self-hosted-runner-groups/#remove-a-self-hosted-runner-from-a-group-for-an-organization + parameters: + - name: org + in: path + required: true + schema: + type: string + - name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + - name: runner_id + description: Unique identifier of the self-hosted runner. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + previews: [] + category: actions + subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runners": get: summary: List self-hosted runners for an organization description: |- - **Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change. + Lists all self-hosted runners configured in an organization. - Lists all self-hosted runners for an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/list-self-hosted-runners-for-org @@ -27853,24 +32389,71 @@ paths: description: The status of the runner. type: string example: online + busy: + type: boolean + labels: + type: array + items: + type: object + properties: + id: + type: integer + description: Unique identifier of the label. + name: + type: string + description: Name of the label. + type: + type: string + description: The type of label. Read-only labels are + applied automatically when the runner is configured. + enum: + - read-only + - custom required: - id - name - os - status + - busy + - labels examples: default: value: total_count: 2 runners: - id: 23 - name: MBP - os: macos + name: linux_runner + os: linux status: online + busy: true + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 11 + name: Linux + type: read-only - id: 24 - name: iMac + name: mac_runner os: macos status: offline + busy: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom headers: Link: example: <https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; @@ -27887,9 +32470,9 @@ paths: get: summary: List runner applications for an organization description: |- - **Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change. + Lists binaries for the runner application that you can download and run. - Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/list-runner-applications-for-org @@ -27955,11 +32538,9 @@ paths: post: summary: Create a registration token for an organization description: |- - **Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change. - + Returns a token that you can pass to the `config` script. The token expires after one hour. - Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate - using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope to use this endpoint. #### Example using registration token @@ -28738,7 +33319,7 @@ paths: - updated_at single_file: type: string - example: config.yml + example: config.yaml nullable: true repository_selection: description: Describe whether all repositories have been selected @@ -28765,12 +33346,9 @@ paths: post: summary: Create a remove token for an organization description: |- - **Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change. + Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. - - Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The - token expires after one hour. You must authenticate using an access token with the `admin:org` scope to use this - endpoint. + You must authenticate using an access token with the `admin:org` scope to use this endpoint. #### Example using remove token @@ -29550,7 +34128,7 @@ paths: - updated_at single_file: type: string - example: config.yml + example: config.yaml nullable: true repository_selection: description: Describe whether all repositories have been selected @@ -29577,9 +34155,9 @@ paths: get: summary: Get a self-hosted runner for an organization description: |- - **Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change. + Gets a specific self-hosted runner configured in an organization. - Gets a specific self-hosted runner for an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/get-self-hosted-runner-for-org @@ -29593,7 +34171,7 @@ paths: schema: type: string - name: runner_id - description: runner_id parameter + description: Unique identifier of the self-hosted runner. in: path required: true schema: @@ -29624,11 +34202,33 @@ paths: description: The status of the runner. type: string example: online + busy: + type: boolean + labels: + type: array + items: + type: object + properties: + id: + type: integer + description: Unique identifier of the label. + name: + type: string + description: Name of the label. + type: + type: string + description: The type of label. Read-only labels are applied + automatically when the runner is configured. + enum: + - read-only + - custom required: - id - name - os - status + - busy + - labels examples: default: value: @@ -29636,6 +34236,20 @@ paths: name: MBP os: macos status: online + busy: true + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29645,9 +34259,9 @@ paths: delete: summary: Delete a self-hosted runner from an organization description: |- - **Warning:** The self-hosted runners API for organizations is currently in public beta and subject to change. + Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/delete-self-hosted-runner-from-org @@ -29661,7 +34275,7 @@ paths: schema: type: string - name: runner_id - description: runner_id parameter + description: Unique identifier of the self-hosted runner. in: path required: true schema: @@ -34336,7 +38950,7 @@ paths: format: date-time single_file_name: type: string - example: config.yml + example: config.yaml nullable: true app_slug: type: string @@ -34501,13 +39115,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: false - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: "/orgs/{org}/installations": @@ -34772,7 +39380,7 @@ paths: format: date-time single_file_name: type: string - example: config.yml + example: config.yaml nullable: true app_slug: type: string @@ -34946,13 +39554,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: orgs subcategory: "/orgs/{org}/interaction-limits": @@ -37896,12 +42498,6 @@ paths: enabledForGitHubApps: false previews: - required: false - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` - - required: false name: squirrel-girl note: |- An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details. @@ -58431,6 +63027,20 @@ paths: - limit - remaining - reset + code_scanning_upload: + title: Rate Limit + type: object + properties: + limit: + type: integer + remaining: + type: integer + reset: + type: integer + required: + - limit + - remaining + - reset required: - core - search @@ -58471,6 +63081,10 @@ paths: limit: 5000 remaining: 4999 reset: 1551806725 + code_scanning_upload: + limit: 500 + remaining: 499 + reset: 1551806725 rate: limit: 5000 remaining: 4999 @@ -65444,6 +70058,7 @@ paths: nullable: true expires_at: type: string + format: date-time updated_at: type: string format: date-time @@ -65565,6 +70180,7 @@ paths: nullable: true expires_at: type: string + format: date-time updated_at: type: string format: date-time @@ -65972,11 +70588,64 @@ paths: previews: [] category: actions subcategory: workflow-jobs + "/repos/{owner}/{repo}/actions/permissions": + get: + summary: Get a repository's Actions permissions + description: Gets the repository's permissions for running GitHub Actions. You + must authenticate using an access token with the `admin:org` scope to use + this endpoint. GitHub Apps must have the full `repo` permission to use this + endpoint. + tags: + - actions + operationId: actions/get-repo-permissions + parameters: + - name: owner + in: path + required: true + schema: + type: string + - name: repo + in: path + required: true + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether GitHub Actions are allowed to run on this + repo. + allowed_actions: + type: string + description: Which GitHub Actions are allowed to run on this repo + when enabled is true. Either 'all', 'local_only' or 'selected'. + selected_actions_url: + type: string + description: The URL of the selected GitHub Actions that can run. + Only when allowed_actions is selected. + examples: + default: + value: + - enabled: 'true' + - allowed_actions: selected + - selected_actions_url: https://api.github.com/repos/octo-org/octo-repo/actions/permissions/selected-actions + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: secrets "/repos/{owner}/{repo}/actions/runners": get: summary: List self-hosted runners for a repository - description: Lists all self-hosted runners for a repository. You must authenticate - using an access token with the `repo` scope to use this endpoint. + description: Lists all self-hosted runners configured in a repository. You must + authenticate using an access token with the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-self-hosted-runners-for-repo @@ -66039,24 +70708,71 @@ paths: description: The status of the runner. type: string example: online + busy: + type: boolean + labels: + type: array + items: + type: object + properties: + id: + type: integer + description: Unique identifier of the label. + name: + type: string + description: Name of the label. + type: + type: string + description: The type of label. Read-only labels are + applied automatically when the runner is configured. + enum: + - read-only + - custom required: - id - name - os - status + - busy + - labels examples: default: value: total_count: 2 runners: - id: 23 - name: MBP - os: macos + name: linux_runner + os: linux status: online + busy: true + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 11 + name: Linux + type: read-only - id: 24 - name: iMac + name: mac_runner os: macos status: offline + busy: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom headers: Link: example: <https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; @@ -66072,9 +70788,10 @@ paths: "/repos/{owner}/{repo}/actions/runners/downloads": get: summary: List runner applications for a repository - description: Lists binaries for the runner application that you can download - and run. You must authenticate using an access token with the `repo` scope - to use this endpoint. + description: |- + Lists binaries for the runner application that you can download and run. + + You must authenticate using an access token with the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-runner-applications-for-repo @@ -66925,7 +71642,7 @@ paths: - updated_at single_file: type: string - example: config.yml + example: config.yaml nullable: true repository_selection: description: Describe whether all repositories have been selected @@ -67732,7 +72449,7 @@ paths: - updated_at single_file: type: string - example: config.yml + example: config.yaml nullable: true repository_selection: description: Describe whether all repositories have been selected @@ -67758,8 +72475,10 @@ paths: "/repos/{owner}/{repo}/actions/runners/{runner_id}": get: summary: Get a self-hosted runner for a repository - description: Gets a specific self-hosted runner. You must authenticate using - an access token with the `repo` scope to use this endpoint. + description: |- + Gets a specific self-hosted runner configured in a repository. + + You must authenticate using an access token with the `repo` scope to use this tags: - actions operationId: actions/get-self-hosted-runner-for-repo @@ -67778,7 +72497,7 @@ paths: schema: type: string - name: runner_id - description: runner_id parameter + description: Unique identifier of the self-hosted runner. in: path required: true schema: @@ -67809,11 +72528,33 @@ paths: description: The status of the runner. type: string example: online + busy: + type: boolean + labels: + type: array + items: + type: object + properties: + id: + type: integer + description: Unique identifier of the label. + name: + type: string + description: Name of the label. + type: + type: string + description: The type of label. Read-only labels are applied + automatically when the runner is configured. + enum: + - read-only + - custom required: - id - name - os - status + - busy + - labels examples: default: value: @@ -67821,6 +72562,20 @@ paths: name: MBP os: macos status: online + busy: true + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67829,10 +72584,10 @@ paths: subcategory: self-hosted-runners delete: summary: Delete a self-hosted runner from a repository - description: Forces the removal of a self-hosted runner from a repository. You - can use this endpoint to completely remove the runner when the machine you - were using no longer exists. You must authenticate using an access token with - the `repo` scope to use this endpoint. + description: |- + Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + + You must authenticate using an access token with the `repo` tags: - actions operationId: actions/delete-self-hosted-runner-from-repo @@ -67851,7 +72606,7 @@ paths: schema: type: string - name: runner_id - description: runner_id parameter + description: Unique identifier of the self-hosted runner. in: path required: true schema: @@ -68099,7 +72854,7 @@ paths: workflow_url: description: The URL to the workflow. type: string - example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yml + example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml head_commit: title: Simple Commit description: Simple Commit @@ -69002,7 +73757,7 @@ paths: head_commit: id: acb5820ced9479c074f688cc328bf03f341a511d tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 - message: Create linter.yml + message: Create linter.yaml timestamp: '2020-01-22T19:33:05Z' author: name: Octo Cat @@ -69338,7 +74093,7 @@ paths: workflow_url: description: The URL to the workflow. type: string - example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yml + example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml head_commit: title: Simple Commit description: Simple Commit @@ -70239,7 +74994,7 @@ paths: head_commit: id: acb5820ced9479c074f688cc328bf03f341a511d tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 - message: Create linter.yml + message: Create linter.yaml timestamp: '2020-01-22T19:33:05Z' author: name: Octo Cat @@ -70509,6 +75264,7 @@ paths: nullable: true expires_at: type: string + format: date-time updated_at: type: string format: date-time @@ -71540,7 +76296,7 @@ paths: example: CI path: type: string - example: ruby.yml + example: ruby.yaml state: type: string example: active @@ -71560,7 +76316,7 @@ paths: example: https://api.github.com/repos/actions/setup-ruby/workflows/5 html_url: type: string - example: https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yml + example: https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml badge_url: type: string example: https://github.com/actions/setup-ruby/workflows/CI/badge.svg @@ -71587,7 +76343,7 @@ paths: - id: 161335 node_id: MDg6V29ya2Zsb3cxNjEzMzU= name: CI - path: ".github/workflows/blank.yml" + path: ".github/workflows/blank.yaml" state: active created_at: '2020-01-08T23:48:37.000-08:00' updated_at: '2020-01-08T23:50:21.000-08:00' @@ -71597,7 +76353,7 @@ paths: - id: 269289 node_id: MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ== name: Linter - path: ".github/workflows/linter.yml" + path: ".github/workflows/linter.yaml" state: active created_at: '2020-01-08T23:48:37.000-08:00' updated_at: '2020-01-08T23:50:21.000-08:00' @@ -71620,7 +76376,7 @@ paths: 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.yml`. Anyone 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. @@ -71667,7 +76423,7 @@ paths: example: CI path: type: string - example: ruby.yml + example: ruby.yaml state: type: string example: active @@ -71687,7 +76443,7 @@ paths: example: https://api.github.com/repos/actions/setup-ruby/workflows/5 html_url: type: string - example: https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yml + example: https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml badge_url: type: string example: https://github.com/actions/setup-ruby/workflows/CI/badge.svg @@ -71712,7 +76468,7 @@ paths: id: 161335 node_id: MDg6V29ya2Zsb3cxNjEzMzU= name: CI - path: ".github/workflows/blank.yml" + path: ".github/workflows/blank.yaml" state: active created_at: '2020-01-08T23:48:37.000-08:00' updated_at: '2020-01-08T23:50:21.000-08:00' @@ -71729,7 +76485,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.yml`. + 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 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)." @@ -71795,7 +76551,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.yml`. 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 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). 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: @@ -72030,7 +76786,7 @@ paths: workflow_url: description: The URL to the workflow. type: string - example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yml + example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml head_commit: title: Simple Commit description: Simple Commit @@ -72933,7 +77689,7 @@ paths: head_commit: id: acb5820ced9479c074f688cc328bf03f341a511d tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 - message: Create linter.yml + message: Create linter.yaml timestamp: '2020-01-22T19:33:05Z' author: name: Octo Cat @@ -73093,7 +77849,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.yml`. 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 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. tags: - actions operationId: actions/get-workflow-usage @@ -87565,9 +92321,10 @@ paths: get: summary: List code scanning alerts for a repository description: Lists all open code scanning alerts for the default branch (usually - `master`) and protected branches in a repository. You must use an access token - with the `security_events` scope to use this endpoint. GitHub Apps must have - the `security_events` read permission to use this endpoint. + `master`) and protected branches in a repository. For private repos, you must + use an access token with the `repo` scope. For public repos, you must use + an access token with `public_repo` and `repo:security_events` scopes. GitHub + Apps must have the `security_events` read permission to use this endpoint. tags: - code-scanning operationId: code-scanning/list-alerts-for-repo @@ -87586,19 +92343,25 @@ paths: schema: type: string - name: state - description: Set to `closed` to list only closed code scanning alerts. + description: Set to `open`, `fixed`, or `dismissed` to list code scanning + alerts in a specific state. in: query required: false schema: type: string - default: open + description: State of a code scanning alert. + enum: + - open + - dismissed + - fixed - name: ref - description: Returns a list of code scanning alerts for a specific brach reference. - The `ref` must be formatted as `heads/<branch name>`. in: query + description: Set a full Git reference to list alerts for a specific branch. + The `ref` must be formatted as `refs/heads/<branch name>`. required: false schema: type: string + description: The full Git reference, formatted as `refs/heads/<branch name>`. responses: '200': description: response @@ -87607,47 +92370,42 @@ paths: schema: type: array items: - title: Code Scanning Alert - description: Code Scanning Alert type: object properties: number: type: integer - rule_id: - description: A unique identifier for the rule used to detect - the alert. - example: py/unused-import - type: string - rule_severity: - description: The severity of the alert. - example: warning + description: The code scanning alert number. + readOnly: true + nullable: false + created_at: type: string - enum: - - none - - note - - warning - - error - rule_description: - description: A short description of the rule used to detect - the alert. - example: Unused import + description: 'The time that the alert was created in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: false + url: type: string - tool: - description: The name of the tool used to detect the alert. - example: CodeQL + description: The REST API URL of the alert resource. + format: uri + readOnly: true + nullable: false + html_url: type: string - nullable: true - created_at: + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + nullable: false + state: type: string - format: date-time - example: '2011-01-26T19:01:12Z' - open: - description: Whether or not the alert is open. - example: true - type: boolean - closed_by: + description: State of a code scanning alert. + enum: + - open + - dismissed + - fixed + dismissed_by: nullable: true - allOf: + oneOf: - title: Simple User description: Simple User type: object @@ -87737,50 +92495,130 @@ paths: - type - url nullable: true - closed_at: + - enum: + - + dismissed_at: type: string + description: 'The time that the alert was dismissed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time - example: '2011-01-26T19:01:12Z' + readOnly: true nullable: true - url: - example: https://api.github.com/repos/github/hello-world/code-scanning/alerts/5 - type: string - html_url: - example: https://github.com/github/hello-world/security/code-scanning/5 + dismissed_reason: type: string - closed_reason: - type: string - example: false positive - enum: - - false positive - - won't fix - - used in tests + description: "**Required when the state is dismissed.** The + reason for dismissing or closing the alert. Can be one of: + `false positive`, `won't fix`, and `used in tests`." nullable: true + oneOf: + - enum: + - false positive + - won't fix + - used in tests + - enum: + - + rule: + type: object + properties: + id: + nullable: true + type: string + description: A unique identifier for the rule used to detect + the alert. + severity: + nullable: true + type: string + description: The severity of the alert. + enum: + - none + - note + - warning + - error + description: + type: string + description: A short description of the rule used to detect + the alert. + tool: + type: object + properties: + name: + type: string + description: The name of the tool used to generate the code + scanning analysis alert. + version: + nullable: true + type: string + description: The version of the tool used to detect the + alert. examples: default: value: - - number: 42 - rule_id: js/trivial-conditional - rule_severity: warning - rule_description: Useless conditional - tool: CodeQL - created_at: '2020-05-06T12:00:00Z' - open: true - closed_by: - closed_at: - url: https://api.github.com/repos/Octo-org/octo-repo/code-scanning/alerts/25 - html_url: https://github.com/Octo-org/octo-repo/security/code-scanning/25 - - number: 43 - rule_id: js/useless-expression - rule_severity: warning - rule_description: Expression has no effect - tool: CodeQL - created_at: '2020-05-06T12:00:00Z' - open: true - closed_by: - closed_at: - url: https://api.github.com/repos/Octo-org/octo-repo/code-scanning/alerts/88 - html_url: https://github.com/Octo-org/octo-repo/security/code-scanning/88 + - number: 4 + created_at: '2020-02-13T12:29:18Z' + url: https://api.github.com/repos/github/hello-world/code-scanning/alerts/4 + html_url: https://github.com/github/hello-world/code-scanning/4 + state: open + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-02-14T12:29:18Z' + dismissed_reason: false positive + rule: + id: js/zipslip + severity: error + description: Arbitrary file write during zip extraction + tool: + name: CodeQL command-line toolchain + version: + - number: 3 + created_at: '2020-02-13T12:29:18Z' + url: https://api.github.com/repos/github/hello-world/code-scanning/alerts/3 + html_url: https://github.com/dsp-testing/github/hello-world/code-scanning/3 + state: open + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-02-14T12:29:18Z' + dismissed_reason: false positive + rule: + id: js/zipslip + severity: error + description: Arbitrary file write during zip extraction + tool: + name: CodeQL command-line toolchain + version: '404': description: Response if the ref doesn't match an existing ref '503': @@ -87802,13 +92640,13 @@ paths: previews: [] category: code-scanning subcategory: - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_id}": + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": get: summary: Get a code scanning alert description: |- Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. - The security `alert_id` is found at the end of the security alert's URL. For example, the security alert ID for `https://github.com/Octo-org/octo-repo/security/code-scanning/88` is `88`. + The security `alert_number` is found at the end of the security alert's URL. For example, the security alert ID for `https://github.com/Octo-org/octo-repo/security/code-scanning/88` is `88`. tags: - code-scanning operationId: code-scanning/get-alert @@ -87826,8 +92664,8 @@ paths: required: true schema: type: string - - name: alert_id - description: alert_id parameter + - name: alert_number + description: alert_number parameter in: path required: true schema: @@ -87838,47 +92676,71 @@ paths: content: application/json: schema: - title: Code Scanning Alert - description: Code Scanning Alert type: object properties: number: type: integer - rule_id: - description: A unique identifier for the rule used to detect the - alert. - example: py/unused-import - type: string - rule_severity: - description: The severity of the alert. - example: warning + description: The code scanning alert number. + readOnly: true + nullable: false + created_at: type: string - enum: - - none - - note - - warning - - error - rule_description: - description: A short description of the rule used to detect the - alert. - example: Unused import + description: 'The time that the alert was created in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: false + url: type: string - tool: - description: The name of the tool used to detect the alert. - example: CodeQL + description: The REST API URL of the alert resource. + format: uri + readOnly: true + nullable: false + html_url: type: string + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + nullable: false + instances: nullable: true - created_at: + type: array + properties: + ref: + type: string + description: The full Git reference, formatted as `refs/heads/<branch + name>`. + analysis_key: + type: string + description: Identifies the configuration under which the + analysis was executed. For example, in GitHub Actions this + includes the workflow filename and job name. + environment: + type: string + description: Identifies the variable values associated with + the environment in which the analysis that generated this + alert instance was performed, such as the language that + was analyzed. + matrix_vars: + nullable: true + type: string + state: + type: string + description: State of a code scanning alert. + enum: + - open + - dismissed + - fixed + state: type: string - format: date-time - example: '2011-01-26T19:01:12Z' - open: - description: Whether or not the alert is open. - example: true - type: boolean - closed_by: + description: State of a code scanning alert. + enum: + - open + - dismissed + - fixed + dismissed_by: nullable: true - allOf: + oneOf: - title: Simple User description: Simple User type: object @@ -87968,38 +92830,106 @@ paths: - type - url nullable: true - closed_at: + - enum: + - + dismissed_at: type: string + description: 'The time that the alert was dismissed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time - example: '2011-01-26T19:01:12Z' + readOnly: true nullable: true - url: - example: https://api.github.com/repos/github/hello-world/code-scanning/alerts/5 - type: string - html_url: - example: https://github.com/github/hello-world/security/code-scanning/5 + dismissed_reason: type: string - closed_reason: - type: string - example: false positive - enum: - - false positive - - won't fix - - used in tests + description: "**Required when the state is dismissed.** The reason + for dismissing or closing the alert. Can be one of: `false positive`, + `won't fix`, and `used in tests`." nullable: true + oneOf: + - enum: + - false positive + - won't fix + - used in tests + - enum: + - + rule: + type: object + properties: + id: + nullable: true + type: string + description: A unique identifier for the rule used to detect + the alert. + severity: + nullable: true + type: string + description: The severity of the alert. + enum: + - none + - note + - warning + - error + description: + type: string + description: A short description of the rule used to detect + the alert. + tool: + type: object + properties: + name: + type: string + description: The name of the tool used to generate the code + scanning analysis alert. + version: + nullable: true + type: string + description: The version of the tool used to detect the alert. examples: default: value: - rule_id: js/useless-expression - rule_severity: warning - rule_description: Expression has no effect - tool: CodeQL - created_at: '2020-05-06T12:00:00Z' - open: true - closed_by: - closed_at: - url: https://api.github.com/repos/Octo-org/octo-repo/code-scanning/alerts/88 - html_url: https://github.com/Octo-org/octo-repo/security/code-scanning/88 + number: 22 + created_at: '2020-06-19T11:21:34Z' + url: https://api.github.com/repos/github/hello-world/code-scanning/alerts/22 + html_url: https://github.com/github/hello-world/code-scanning/22 + instances: + - ref: refs/heads/codeql-analysis-yml + analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" + environment: {} + state: fixed + - ref: refs/pull/3740/head + analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" + environment: {} + state: fixed + state: fixed + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-02-14T12:29:18Z' + dismissed_reason: false positive + rule: + id: js/polynomial-redos + severity: warning + description: Polynomial regular expression used on uncontrolled + data + tool: + name: CodeQL command-line toolchain + version: '404': description: Resource Not Found content: @@ -88032,6 +92962,526 @@ paths: previews: [] category: code-scanning subcategory: + patch: + summary: Update a code scanning alert + description: |- + Updates the status of a single code scanning alert. For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. + GitHub Apps must have the `security_events` write permission to use this endpoint. + operationId: code-scanning/update-alert + tags: + - code-scanning + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/code-scanning/#upload-a-code-scanning-alert + parameters: + - name: owner + in: path + required: true + schema: + type: string + - name: repo + in: path + required: true + schema: + type: string + - name: alert_number + in: path + description: The code scanning alert number. + required: true + schema: + type: integer + description: The code scanning alert number. + readOnly: true + nullable: false + requestBody: + content: + application/json: + schema: + type: object + properties: + state: + description: Sets the state of the code scanning alert. Can be one + of `open` or `dismissed`. You must provide `dismissed_reason` + when you set the state to `dismissed`. + type: string + enum: + - open + - dismissed + dismissed_reason: + type: string + description: "**Required when the state is dismissed.** The reason + for dismissing or closing the alert. Can be one of: `false positive`, + `won't fix`, and `used in tests`." + nullable: true + oneOf: + - enum: + - false positive + - won't fix + - used in tests + - enum: + - + required: + - state + example: + state: dismissed + dismissed_reason: false positive + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + number: + type: integer + description: The code scanning alert number. + readOnly: true + nullable: false + created_at: + type: string + description: 'The time that the alert was created in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: false + url: + type: string + description: The REST API URL of the alert resource. + format: uri + readOnly: true + nullable: false + html_url: + type: string + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + nullable: false + instances: + nullable: true + type: array + properties: + ref: + type: string + description: The full Git reference, formatted as `refs/heads/<branch + name>`. + analysis_key: + type: string + description: Identifies the configuration under which the + analysis was executed. For example, in GitHub Actions this + includes the workflow filename and job name. + environment: + type: string + description: Identifies the variable values associated with + the environment in which the analysis that generated this + alert instance was performed, such as the language that + was analyzed. + matrix_vars: + nullable: true + type: string + state: + type: string + description: State of a code scanning alert. + enum: + - open + - dismissed + - fixed + state: + type: string + description: State of a code scanning alert. + enum: + - open + - dismissed + - fixed + dismissed_by: + nullable: true + oneOf: + - title: Simple User + description: Simple User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: '' + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + - enum: + - + dismissed_at: + type: string + description: 'The time that the alert was dismissed in ISO 8601 + format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + dismissed_reason: + type: string + description: "**Required when the state is dismissed.** The reason + for dismissing or closing the alert. Can be one of: `false positive`, + `won't fix`, and `used in tests`." + nullable: true + oneOf: + - enum: + - false positive + - won't fix + - used in tests + - enum: + - + rule: + type: object + properties: + id: + nullable: true + type: string + description: A unique identifier for the rule used to detect + the alert. + severity: + nullable: true + type: string + description: The severity of the alert. + enum: + - none + - note + - warning + - error + description: + type: string + description: A short description of the rule used to detect + the alert. + tool: + type: object + properties: + name: + type: string + description: The name of the tool used to generate the code + scanning analysis alert. + version: + nullable: true + type: string + description: The version of the tool used to detect the alert. + examples: + default: + value: + number: 22 + created_at: '2020-08-25T21:28:36Z' + url: https://api.github.com/repos/github/hello-world/code-scanning/alerts/22 + html_url: https://github.com/github/hello-world/code-scanning/22 + instances: + - ref: refs/heads/codeql-analysis-yml + analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" + environment: {} + state: dismissed + - ref: refs/pull/3740/head + analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" + environment: {} + state: dismissed + state: dismissed + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-09-02T22:34:56Z' + dismissed_reason: false positive + rule: + id: js/polynomial-redos + severity: warning + description: Polynomial regular expression used on uncontrolled + data + tool: + name: CodeQL command-line toolchain + version: + '503': + description: When code scanning isn't available you can try again at a later + time + x-github: + enabledForApps: true + githubCloudOnly: false + previews: [] + category: code-scanning + "/repos/{owner}/{repo}/code-scanning/analyses": + get: + summary: List recent code scanning analyses for a repository + description: List the details of recent code scanning analyses for a repository. + For private repos, you must use an access token with the `repo` scope. For + public repos, you must use an access token with `public_repo` and `repo:security_events` + scopes. GitHub Apps must have the `security_events` read permission to use + this endpoint. + operationId: code-scanning/list-recent-analyses + tags: + - code-scanning + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/code-scanning/#list-recent-analyses + parameters: + - name: owner + in: path + required: true + schema: + type: string + - name: repo + in: path + required: true + schema: + type: string + - name: ref + in: query + description: Set a full Git reference to list alerts for a specific branch. + The `ref` must be formatted as `refs/heads/<branch name>`. + required: false + schema: + type: string + description: The full Git reference of the code scanning analysis file, + formatted as `refs/heads/<branch name>`. + - name: tool_name + in: query + description: Set a single code scanning tool name to filter alerts by tool. + required: false + schema: + type: string + description: The name of the tool used to generate the code scanning analysis + alert. + responses: + '200': + description: response + content: + application/json: + schema: + type: array + items: + type: object + properties: + commit_sha: + description: The commit SHA of the code scanning analysis file. + type: string + minLength: 40 + maxLength: 40 + pattern: "^[0-9a-fA-F]+$" + ref: + type: string + description: The full Git reference of the code scanning analysis + file, formatted as `refs/heads/<branch name>`. + analysis_key: + type: string + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes + the workflow filename and job name. + created_at: + type: string + description: 'The time that the analysis was created in ISO + 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: false + tool_name: + type: string + description: The name of the tool used to generate the code + scanning analysis alert. + error: + type: string + example: error reading field xyz + environment: + type: string + description: Identifies the variable values associated with + the environment in which this analysis was performed. + examples: + default: + value: + - ref: refs/heads/master + commit_sha: d99612c3e1f2970085cfbaeadf8f010ef69bad83 + analysis_key: ".github/workflows/codeql-analysis.yml:analyze" + tool_name: CodeQL command-line toolchain + environment: "{}" + error: '' + created_at: '2020-08-27T15:05:21Z' + - ref: refs/heads/my-branch + commit_sha: c8cff6510d4d084fb1b4aa13b64b97ca12b07321 + analysis_key: ".github/workflows/shiftleft.yml:build" + tool_name: Python Security Analysis + environment: "{}" + error: '' + created_at: '2020-08-31T22:46:44Z' + x-github: + enabledForApps: true + githubCloudOnly: false + previews: [] + category: code-scanning + "/repos/{owner}/{repo}/code-scanning/sarifs": + post: + summary: Upload a SARIF file + description: |- + Upload a SARIF file containing the results of a code scanning analysis to make the results available in a repository. + For private repos, you must use an access token with the `repo` scope. For public repos, you must use an access token with `public_repo` and `repo:security_events` scopes. GitHub Apps must have the `security_events` write permission to use this endpoint. + operationId: code-scanning/upload-sarif + tags: + - code-scanning + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/code-scanning/#upload-a-sarif-analysis + parameters: + - name: owner + in: path + required: true + schema: + type: string + - name: repo + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + commit_sha: + description: The commit SHA of the code scanning analysis file. + type: string + minLength: 40 + maxLength: 40 + pattern: "^[0-9a-fA-F]+$" + ref: + type: string + description: The full Git reference of the code scanning analysis + file, formatted as `refs/heads/<branch name>`. + sarif: + description: A Base64 string representing the SARIF file to upload. + You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) + and then translate the contents of the file into a Base64 encoding + string. + type: string + checkout_uri: + description: |- + The base directory used in the analysis, as it appears in the SARIF file. + This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + example: file:///github/workspace/ + type: string + format: uri + started_at: + description: 'The time that the analysis run began. This is a timestamp + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date + type: string + tool_name: + type: string + description: The name of the tool used to generate the code scanning + analysis alert. + required: + - commit_sha + - ref + - sarif + - tool_name + example: + commit_sha: 9a450a043b9038ba86722926570d2312cff6aba8 + ref: refs/heads/main + sarif: REPLACE_ME + tool_name: codeql + responses: + '202': + description: response + '404': + description: Response if `commit_sha` or `ref` cannot be found + x-github: + enabledForApps: true + githubCloudOnly: false + previews: [] + category: code-scanning. "/repos/{owner}/{repo}/collaborators": get: summary: List repository collaborators @@ -90997,26 +96447,29 @@ paths: summary: List commits description: |- **Signature verification object** - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - repos operationId: repos/list-commits @@ -95089,32 +100542,33 @@ paths: summary: Get a commit description: |- Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - - You can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. - + **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + You can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. - **Signature verification object** - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - repos operationId: repos/get-commit @@ -98500,38 +103954,36 @@ paths: summary: Compare two commits description: |- Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `<USERNAME>:branch`. - The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. - The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. - **Working with large comparisons** - The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://developer.github.com/v3/repos/commits/#list-commits) to enumerate all commits in the range. - - For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range. - + For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long + to generate. You can typically resolve this error by using a smaller commit range. **Signature verification object** - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - repos operationId: repos/compare-commits @@ -103176,12 +108628,6 @@ paths: enabledForGitHubApps: true previews: - required: false - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` - - required: false name: ant-man note: |- The `inactive` state and the `log_url`, `environment_url`, and `auto_inactive` parameters are currently available for developers to preview. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details. @@ -104842,12 +110288,6 @@ paths: enabledForGitHubApps: true previews: - required: false - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` - - required: false name: flash note: |- New features in the Deployments API on GitHub are currently available during a public beta. Please see the [blog post](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/) for full details. @@ -108955,32 +114395,30 @@ paths: summary: Create a commit description: |- Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). - - In this example, the payload of the signature would be: - - - **Signature verification object** - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - git operationId: git/create-commit @@ -109294,28 +114732,30 @@ paths: summary: Get a commit description: |- Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). - **Signature verification object** - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - git operationId: git/get-commit @@ -110047,28 +115487,30 @@ paths: summary: Create a tag object description: |- Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://developer.github.com/v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com/v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary. - **Signature verification object** - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - git operationId: git/create-tag @@ -110303,26 +115745,29 @@ paths: summary: Get a tag description: |- **Signature verification object** - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | tags: - git operationId: git/get-tag @@ -113536,7 +118981,7 @@ paths: format: date-time single_file_name: type: string - example: config.yml + example: config.yaml nullable: true app_slug: type: string @@ -113716,13 +119161,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: false - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: "/repos/{owner}/{repo}/interaction-limits": @@ -117389,12 +122828,6 @@ paths: enabledForGitHubApps: true previews: - required: false - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` - - required: false name: squirrel-girl note: |- An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details. @@ -120421,12 +125854,6 @@ paths: enabledForGitHubApps: true previews: - required: false - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` - - required: false name: squirrel-girl note: |- An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details. @@ -124214,13 +129641,6 @@ paths: ```shell application/vnd.github.starfox-preview+json ``` - - required: false - name: sailor-v - note: |- - You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: - ```shell - application/vnd.github.sailor-v-preview+json - ``` category: issues subcategory: events "/repos/{owner}/{repo}/issues/events/{event_id}": @@ -126683,19 +132103,6 @@ paths: ```shell application/vnd.github.starfox-preview+json ``` - - required: false - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` - - required: false - name: sailor-v - note: |- - You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: - ```shell - application/vnd.github.sailor-v-preview+json - ``` category: issues subcategory: events "/repos/{owner}/{repo}/issues/{issue_number}": @@ -135415,13 +140822,6 @@ paths: ```shell application/vnd.github.starfox-preview+json ``` - - required: false - name: sailor-v - note: |- - You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: - ```shell - application/vnd.github.sailor-v-preview+json - ``` category: issues subcategory: events "/repos/{owner}/{repo}/issues/{issue_number}/labels": @@ -136201,14 +141601,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: false - name: sailor-v - note: |- - You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: - ```shell - application/vnd.github.sailor-v-preview+json - ``` + previews: [] category: issues subcategory: delete: @@ -140974,7 +146367,8 @@ paths: subcategory: pages post: summary: Create a GitHub Pages site - description: '' + description: Configures a GitHub Pages site. For more information, see "[About + GitHub Pages](/github/working-with-github-pages/about-github-pages)." tags: - repos operationId: repos/create-pages-site @@ -140997,27 +146391,32 @@ paths: application/json: schema: type: object + description: The source branch and directory used to publish your Pages + site. properties: source: type: object properties: branch: type: string - description: The repository branch used to publish your [site's - source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). - Can be either `master` or `gh-pages`. - enum: - - master - - gh-pages + description: The repository branch used to publish your site's + source files. path: type: string - description: The repository directory that includes the source - files for the Pages site. When `branch` is `master`, you can - change `path` to `/docs`. When `branch` is `gh-pages`, you - are unable to specify a `path` other than `/`. + description: 'The repository directory that includes the source + files for the Pages site. Allowed paths are `/` or `/docs`. + Default: `/`' + enum: + - "/" + - "/docs" + default: "/" + required: + - branch + required: + - source example: source: - branch: master + branch: main path: "/docs" responses: '201': @@ -141170,7 +146569,8 @@ paths: subcategory: pages put: summary: Update information about a GitHub Pages site - description: '' + description: Updates information for a GitHub Pages site. For more information, + see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). tags: - repos operationId: repos/update-information-about-pages-site @@ -141212,14 +146612,30 @@ paths: - master - master /docs - type: object + description: Update the source for the repository. Must include + the branch name and path. properties: branch: type: string + description: The repository branch used to publish your site's + source files. path: type: string + description: The repository directory that includes the source + files for the Pages site. Allowed paths are `/` or `/docs`. + enum: + - "/" + - "/docs" + required: + - branch + - path + required: + - source example: cname: octocatblog.com - source: master /docs + source: + branch: main + path: "/" responses: '204': description: Empty response @@ -145938,14 +151354,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: false - name: sailor-v - note: |- - You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: - ```shell - application/vnd.github.sailor-v-preview+json - ``` + previews: [] category: pulls subcategory: post: @@ -148476,14 +153885,7 @@ paths: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: false - name: sailor-v - note: |- - You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: - ```shell - application/vnd.github.sailor-v-preview+json - ``` + previews: [] category: pulls subcategory: "/repos/{owner}/{repo}/pulls/comments": @@ -148606,7 +154008,7 @@ paths: path: description: The relative path of the file to which the comment applies. - example: config/database.yml + example: config/database.yaml type: string position: description: The line index in the diff to which the comment @@ -149047,7 +154449,7 @@ paths: path: description: The relative path of the file to which the comment applies. - example: config/database.yml + example: config/database.yaml type: string position: description: The line index in the diff to which the comment applies. @@ -149503,7 +154905,7 @@ paths: path: description: The relative path of the file to which the comment applies. - example: config/database.yml + example: config/database.yaml type: string position: description: The line index in the diff to which the comment applies. @@ -153113,14 +158515,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: false - name: sailor-v - note: |- - You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: - ```shell - application/vnd.github.sailor-v-preview+json - ``` + previews: [] category: pulls subcategory: patch: @@ -155636,14 +161031,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - previews: - - required: false - name: sailor-v - note: |- - You can now use the REST API to add a reason when you lock an issue, and you will see lock reasons in responses that include issues or pull requests. You will also see lock reasons in `locked` events. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: - ```shell - application/vnd.github.sailor-v-preview+json - ``` + previews: [] category: pulls subcategory: "/repos/{owner}/{repo}/pulls/{pull_number}/comments": @@ -155771,7 +161159,7 @@ paths: path: description: The relative path of the file to which the comment applies. - example: config/database.yml + example: config/database.yaml type: string position: description: The line index in the diff to which the comment @@ -156303,7 +161691,7 @@ paths: path: description: The relative path of the file to which the comment applies. - example: config/database.yml + example: config/database.yaml type: string position: description: The line index in the diff to which the comment applies. @@ -156788,7 +162176,7 @@ paths: path: description: The relative path of the file to which the comment applies. - example: config/database.yml + example: config/database.yaml type: string position: description: The line index in the diff to which the comment applies. @@ -172622,6 +178010,1460 @@ paths: previews: [] category: repos subcategory: + "/scim/v2/enterprises/{enterprise}/Groups": + get: + summary: List provisioned SCIM groups for an enterprise + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/list-provisioned-groups-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#list-provisioned-scim + groups-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: startIndex + description: 'Used for pagination: the index of the first result to return.' + in: query + required: false + schema: + type: integer + - name: count + description: 'Used for pagination: the number of results to return.' + in: query + required: false + schema: + type: integer + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + totalResults: + type: number + itemsPerPage: + type: number + startIndex: + type: number + Resources: + type: array + items: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + nullable: true + displayName: + type: string + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + examples: + default: + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 2 + itemsPerPage: 2 + startIndex: 1 + Resources: + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + display: hubot@example.com + meta: + resourceType: Group + created: '2020-06-09T03:10:17.000+10:00' + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: 5e75bbbb-aa1a-11ea-8644-75ff655cdddd + externalId: + displayName: octo-docs-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + meta: + resourceType: Group + created: '2020-06-09T16:28:01.000+10:00' + lastModified: '2020-06-09T16:28:01.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + post: + summary: Provision a SCIM enterprise group and invite users + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. + operationId: enterprise-admin/provision-and-invite-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#provision-a-scim-enterprise-group-and-invite-users + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + displayName: + type: string + description: The name of the SCIM group. This must match the GitHub + organization that the group maps to. + members: + type: array + items: + type: object + properties: + value: + type: string + description: The SCIM user ID for a user. + required: + - value + required: + - schemas + - displayName + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + responses: + '201': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + nullable: true + displayName: + type: string + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + examples: + default: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + display: hubot@example.com + meta: + resourceType: Group + created: 2020-06-09T03:10:17.000+10:0 + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": + get: + summary: Get SCIM provisioning information for an enterprise group + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/get-provisioning-information-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#get-scim-provisioning-information-for-an-enterprise + group + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: scim_group_id + description: Identifier generated by the GitHub SCIM endpoint. + in: path + required: true + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + nullable: true + displayName: + type: string + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + examples: + default: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + display: hubot@example.com + meta: + resourceType: Group + created: 2020-06-09T03:10:17.000+10:0 + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + put: + summary: Set SCIM information for a provisioned enterprise group + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#set-scim-information-for-a-provisioned-enterprise-group + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: scim_group_id + description: Identifier generated by the GitHub SCIM endpoint. + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + displayName: + type: string + description: The name of the SCIM group. This must match the GitHub + organization that the group maps to. + members: + type: array + items: + type: object + properties: + value: + type: string + description: The SCIM user ID for a user. + required: + - value + required: + - schemas + - displayName + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + nullable: true + displayName: + type: string + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + examples: + default: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + display: hubot@example.com + meta: + resourceType: Group + created: 2020-06-09T03:10:17.000+10:0 + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + patch: + summary: Update an attribute for a SCIM enterprise group + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + operationId: enterprise-admin/update-attribute-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#update-an-attribute-for-a-scim-enterprise-group + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: scim_group_id + description: Identifier generated by the GitHub SCIM endpoint. + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + Operations: + type: array + description: Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). + items: + type: object + required: + - schemas + - Operations + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: remove + path: members + value: + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + nullable: true + displayName: + type: string + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + examples: + default: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + meta: + resourceType: Group + created: '2020-06-09T03:10:17.000+10:00' + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + delete: + summary: Delete a SCIM group from an enterprise + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/delete-scim-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#delete-a-scim-group-from-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: scim_group_id + description: Identifier generated by the GitHub SCIM endpoint. + in: path + required: true + schema: + type: string + responses: + '204': + description: Empty response + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Users": + get: + summary: List SCIM provisioned identities for an enterprise + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Retrieves a paginated list of all provisioned enterprise members, including pending invitations. + + When a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member: + - When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future. + - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). + - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. + + The returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO: + + 1. The user is granted access by the IdP and is not a member of the GitHub enterprise. + + 1. The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account. + + 1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub account: + - If the user signs in, their GitHub account is linked to this entry. + - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity `null` entry remains in place. + operationId: enterprise-admin/list-provisioned-identities-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#list-scim-provisioned-identities-for-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: startIndex + description: 'Used for pagination: the index of the first result to return.' + in: query + required: false + schema: + type: integer + - name: count + description: 'Used for pagination: the number of results to return.' + in: query + required: false + schema: + type: integer + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + totalResults: + type: number + itemsPerPage: + type: number + startIndex: + type: number + Resources: + type: array + items: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + userName: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + emails: + type: array + items: + type: object + properties: + value: + type: string + primary: + type: boolean + type: + type: string + groups: + type: array + items: + type: object + properties: + value: + type: string + active: + type: boolean + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + examples: + default: + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 2 + itemsPerPage: 2 + startIndex: 1 + Resources: + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + externalId: 00dowz5dr9oSfDFRA0h7 + userName: octocat@github.com + name: + givenName: Mona + familyName: Octocat + emails: + - value: octocat@github.com + primary: true + type: work + groups: + - value: 468dd3fa-a1d6-11ea-9031-15a1f0d7811d + active: true + meta: + resourceType: User + created: '2020-05-30T04:02:34.000+10:00' + lastModified: '2020-05-30T04:05:04.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5 + externalId: sdfoiausdofiua + userName: hubot@example.com + name: + givenName: hu + familyName: bot + emails: + - value: hubot@example.com + type: work + primary: true + groups: [] + active: true + meta: + resourceType: User + created: '2020-06-05T08:29:40.000+10:00' + lastModified: '2020-06-05T08:30:19.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Users/e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5 + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + post: + summary: Provision and invite a SCIM enterprise user + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Provision enterprise membership for a user, and send organization invitation emails to the email address. + + You can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent. + operationId: enterprise-admin/provision-and-invite-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#provision-and-invite-a-scim-enterprise-user + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + userName: + type: string + description: The username for the user. + name: + type: object + properties: + givenName: + type: string + description: The first name of the user. + familyName: + type: string + description: The last name of the user. + required: + - givenName + - familyName + emails: + type: array + description: List of user emails. + items: + type: object + properties: + value: + type: string + description: The email address. + type: + type: string + description: The type of email address. + primary: + type: boolean + description: Whether this email address is the primary address. + required: + - value + - type + - primary + groups: + type: array + description: List of SCIM group IDs the user is a member of. + items: + type: object + properties: + value: + type: string + required: + - schemas + - userName + - name + - emails + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + userName: mona.octocat@okta.example.com + name: + familyName: Octocat + givenName: Mona + emails: + - value: mona.octocat@okta.example.com + type: work + primary: true + groups: + - value: 468dd3fa-a1d6-11ea-9031-15a1f0d7811d + responses: + '201': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + userName: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + emails: + type: array + items: + type: object + properties: + value: + type: string + type: + type: string + primary: + type: boolean + groups: + type: array + items: + type: object + properties: + value: + type: string + active: + type: boolean + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + examples: + default: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + externalId: 00dowz5dr9oSfDFRA0h7 + userName: mona.octocat@okta.example.com + name: + givenName: Mona + familyName: Octocat + emails: + - value: mona.octocat@okta.example.com + type: work + primary: true + groups: + - value: 468dd3fa-a1d6-11ea-9031-15a1f0d7811d + active: true + meta: + resourceType: User + created: '2017-03-09T16:11:13-05:00' + lastModified: '2017-03-09T16:11:13-05:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": + get: + summary: Get SCIM provisioning information for an enterprise user + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/get-provisioning-information-for-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#get-scim-provisioning-information-for-an-enterprise-user + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: scim_user_id + description: scim_user_id parameter + in: path + required: true + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + userName: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + emails: + type: array + items: + type: object + properties: + value: + type: string + type: + type: string + primary: + type: boolean + groups: + type: array + items: + type: object + properties: + value: + type: string + active: + type: boolean + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + examples: + default: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + externalId: 00dowz5dr9oSfDFRA0h7 + userName: mona.octocat@okta.example.com + name: + givenName: Mona + familyName: Octocat + emails: + - value: mona.octocat@okta.example.com + type: work + primary: true + groups: + - value: 468dd3fa-a1d6-11ea-9031-15a1f0d7811d + active: true + meta: + resourceType: User + created: '2017-03-09T16:11:13-05:00' + lastModified: '2017-03-09T16:11:13-05:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + put: + summary: Set SCIM information for a provisioned enterprise user + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-an-enterprise-scim-user) endpoint instead. + + You must at least provide the required values for the user: `userName`, `name`, and `emails`. + + **Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#set-scim-information-for-a-provisioned-enterprise-user + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: scim_user_id + description: scim_user_id parameter + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + userName: + type: string + description: The username for the user. + name: + type: object + properties: + givenName: + type: string + description: The first name of the user. + familyName: + type: string + description: The last name of the user. + required: + - givenName + - familyName + emails: + type: array + description: List of user emails. + items: + type: object + properties: + value: + type: string + description: The email address. + type: + type: string + description: The type of email address. + primary: + type: boolean + description: Whether this email address is the primary address. + required: + - value + - type + - primary + groups: + type: array + description: List of SCIM group IDs the user is a member of. + items: + type: object + properties: + value: + type: string + required: + - schemas + - userName + - name + - emails + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + userName: mona.octocat@okta.example.com + name: + familyName: Octocat + givenName: Mona + emails: + - value: mona.octocat@okta.example.com + type: work + primary: true + groups: + - value: 468dd3fa-a1d6-11ea-9031-15a1f0d7811d + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + userName: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + emails: + type: array + items: + type: object + properties: + value: + type: string + type: + type: string + primary: + type: boolean + groups: + type: array + items: + type: object + properties: + value: + type: string + active: + type: boolean + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + examples: + default: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + externalId: 00dowz5dr9oSfDFRA0h7 + userName: mona.octocat@okta.example.com + name: + givenName: Mona + familyName: Octocat + emails: + - value: mona.octocat@okta.example.com + type: work + primary: true + groups: + - value: 468dd3fa-a1d6-11ea-9031-15a1f0d7811d + active: true + meta: + resourceType: User + created: '2017-03-09T16:11:13-05:00' + lastModified: '2017-03-09T16:11:13-05:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + patch: + summary: Update an attribute for a SCIM enterprise user + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + + **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + + **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated `:scim_user_id`. + + ``` + { + "Operations":[{ + "op":"replace", + "value":{ + "active":false + } + }] + } + ``` + operationId: enterprise-admin/update-attribute-for-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#update-an-attribute-for-a-scim-enterprise-user + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: scim_user_id + description: scim_user_id parameter + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + Operations: + type: array + description: Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). + items: + type: object + required: + - schemas + - Operations + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: emails + value: + - value: monalisa@octocat.github.com + type: home + - op: replace + path: name.givenName + value: Monalisa + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + userName: + type: string + name: + type: object + properties: + givenName: + type: string + familyName: + type: string + emails: + type: array + items: + type: object + properties: + value: + type: string + type: + type: string + primary: + type: boolean + groups: + type: array + items: + type: object + properties: + value: + type: string + active: + type: boolean + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + examples: + default: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + externalId: 00dowz5dr9oSfDFRA0h7 + userName: mona.octocat@okta.example.com + name: + givenName: Monalisa + familyName: Octocat + emails: + - value: mona.octocat@okta.example.com + type: work + primary: true + - value: monalisa@octocat.github.com + type: home + groups: + - value: 468dd3fa-a1d6-11ea-9031-15a1f0d7811d + active: true + meta: + resourceType: User + created: '2017-03-09T16:11:13-05:00' + lastModified: '2017-03-09T16:11:13-05:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + delete: + summary: Delete a SCIM user from an enterprise + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/delete-user-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://developer.github.com/v3/enterprise-admin/scim/#delete-a-scim-user-from-an-enterprise + parameters: + - name: enterprise + description: Unique identifier of the GitHub Enterprise Cloud instance. + in: path + required: true + schema: + type: string + - name: scim_user_id + description: scim_user_id parameter + in: path + required: true + schema: + type: string + responses: + '204': + description: Empty response + x-github: + enabledForApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim "/scim/v2/organizations/{org}/Users": get: summary: List SCIM provisioned identities @@ -191547,7 +198389,7 @@ paths: format: date-time single_file_name: type: string - example: config.yml + example: config.yaml nullable: true app_slug: type: string @@ -191706,7 +198548,7 @@ paths: events: - push - pull_request - single_file_name: config.yml + single_file_name: config.yaml repository_selection: all created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' @@ -191744,7 +198586,7 @@ paths: events: - push - pull_request - single_file_name: config.yml + single_file_name: config.yaml repository_selection: all created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' @@ -191800,13 +198642,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: false - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: installations "/user/installations/{installation_id}/repositories": @@ -192748,12 +199584,6 @@ paths: githubCloudOnly: false enabledForGitHubApps: false previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` - required: false name: mercy note: |- @@ -192823,13 +199653,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: false - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: installations delete: @@ -192891,13 +199715,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: false - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: installations "/user/issues": @@ -194935,12 +201753,6 @@ paths: enabledForGitHubApps: false previews: - required: false - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` - - required: false name: squirrel-girl note: |- An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details. @@ -215929,7 +222741,7 @@ paths: format: date-time single_file_name: type: string - example: config.yml + example: config.yaml nullable: true app_slug: type: string @@ -216094,13 +222906,7 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: false - previews: - - required: true - name: machine-man - note: To access the API with your GitHub App, you must provide a custom - [media type](https://developer.github.com/v3/media) in the `Accept` Header - for your requests. ```shell application/vnd.github.machine-man-preview+json - ``` + previews: [] category: apps subcategory: "/users/{username}/keys": |