diff options
author | github-openapi-bot <security+github-openapi-bot@github.com> | 2025-01-16 16:16:41 -0800 |
---|---|---|
committer | github-openapi-bot <security+github-openapi-bot@github.com> | 2025-01-16 16:16:41 -0800 |
commit | b106bc70dbd913f192e3d19aad00b75f4e6823c7 (patch) | |
tree | 02c963c14bb1c012ddeea21701a380eb3733e917 /descriptions/api.github.com/api.github.com.2022-11-28.yaml | |
parent | 780e4964a55558c28e9bf35256510c3ad3882948 (diff) | |
download | rest-api-description-b106bc70dbd913f192e3d19aad00b75f4e6823c7.tar.gz rest-api-description-b106bc70dbd913f192e3d19aad00b75f4e6823c7.zip |
Update OpenAPI 3.0 Descriptions
Diffstat (limited to 'descriptions/api.github.com/api.github.com.2022-11-28.yaml')
-rw-r--r-- | descriptions/api.github.com/api.github.com.2022-11-28.yaml | 1079 |
1 files changed, 941 insertions, 138 deletions
diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 9a3d7ef96..8fbfce71e 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -4763,6 +4763,457 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/orgs/{org}/actions/hosted-runners": + get: + summary: List GitHub-hosted runners for an organization + description: |- + Lists all GitHub-hosted runners configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-hosted-runners-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: integer + runners: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + post: + summary: Create a GitHub-hosted runner for an organization + description: |- + Creates a GitHub-hosted runner for an organization. + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + operationId: actions/create-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner. Must be between 1 and 64 characters + and may only contain upper and lowercase letters a-z, numbers + 0-9, '.', '-', and '_'. + type: string + image: + description: The image of runner. To list all available images, + use `GET /actions/hosted-runners/images/github-owned` or `GET + /actions/hosted-runners/images/partner`. + type: object + properties: + id: + description: The unique identifier of the runner image. + type: string + source: + description: The source of the runner image. + type: string + enum: + - github + - partner + - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true + size: + description: The machine size of the runner. To list available sizes, + use `GET actions/hosted-runners/machine-sizes` + type: string + runner_group_id: + description: The existing runner group to add this runner to. + type: integer + maximum_runners: + description: The maximum amount of runners to scale up to. Runners + will not auto-scale above this number. Use this setting to limit + your cost. + type: integer + enable_static_ip: + description: Whether this runner should be created with a static + public IP. Note limit on account. To list limits on account, use + `GET actions/hosted-runners/limits` + type: boolean + required: + - name + - image + - size + - runner_group_id + examples: + default: + value: + name: My Hosted runner + image: + id: ubuntu-latest + source: github + version: latest + runner_group_id: 1 + size: 4-core + maximum_runners: 50 + enable_static_ip: false + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/github-owned": + get: + summary: Get GitHub-owned images for GitHub-hosted runners in an organization + description: Get the list of GitHub-owned images available for GitHub-hosted + runners for an organization. + operationId: actions/get-hosted-runners-github-owned-images-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/partner": + get: + summary: Get partner images for GitHub-hosted runners in an organization + description: Get the list of partner images available for GitHub-hosted runners + for an organization. + operationId: actions/get-hosted-runners-partner-images-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/limits": + get: + summary: Get limits on GitHub-hosted runners for an organization + description: Get the GitHub-hosted runners limits for an organization. + operationId: actions/get-hosted-runners-limits-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-limits" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-limits-default" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/machine-sizes": + get: + summary: Get GitHub-hosted runners machine specs for an organization + description: Get the list of machine specs available for GitHub-hosted runners + for an organization. + operationId: actions/get-hosted-runners-machine-specs-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - machine_specs + properties: + total_count: + type: integer + machine_specs: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-machine-spec" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/platforms": + get: + summary: Get platforms for GitHub-hosted runners in an organization + description: Get the list of platforms available for GitHub-hosted runners for + an organization. + operationId: actions/get-hosted-runners-platforms-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - platforms + properties: + total_count: + type: integer + platforms: + type: array + items: + type: string + examples: + default: + value: + total_count: 1 + platforms: + - linux-x64 + - win-x64 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": + get: + summary: Get a GitHub-hosted runner for an organization + description: |- + Gets a GitHub-hosted runner configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-hosted-runner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/hosted-runner-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + patch: + summary: Update a GitHub-hosted runner for an organization + description: |- + Updates a GitHub-hosted runner for an organization. + OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + operationId: actions/update-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/hosted-runner-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner. Must be between 1 and 64 characters + and may only contain upper and lowercase letters a-z, numbers + 0-9, '.', '-', and '_'. + type: string + runner_group_id: + description: The existing runner group to add this runner to. + type: integer + maximum_runners: + description: The maximum amount of runners to scale up to. Runners + will not auto-scale above this number. Use this setting to limit + your cost. + type: integer + enable_static_ip: + description: Whether this runner should be updated with a static + public IP. Note limit on account. To list limits on account, use + `GET actions/hosted-runners/limits` + type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true + examples: + default: + value: + name: My larger runner + runner_group_id: 1 + maximum_runners: 50 + enable_static_ip: false + image_version: 1.0.0 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete a GitHub-hosted runner for an organization + description: Deletes a GitHub-hosted runner for an organization. + operationId: actions/delete-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/hosted-runner-id" + responses: + '202': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/oidc/customization/sub": get: summary: Get the customization template for an OIDC subject claim for an organization @@ -5270,6 +5721,9 @@ paths: description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string required: - name examples: @@ -5381,6 +5835,10 @@ paths: description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string + nullable: true required: - name examples: @@ -5426,6 +5884,52 @@ paths: githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": + get: + summary: List GitHub-hosted runners in a group for an organization + description: |- + Lists the GitHub-hosted runners in an organization group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-github-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: number + runners: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + 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 @@ -67190,106 +67694,61 @@ components: type: array items: type: string - nullable-simple-user: - title: Simple User - description: A GitHub user. + enterprise: + title: Enterprise + description: An enterprise on GitHub. type: object properties: - name: - nullable: true - type: string - email: - nullable: true - type: string - login: - type: string - example: octocat - id: - type: integer - format: int64 - 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: + description: + description: A short description of the enterprise. type: string - example: 41d064eb2195891e12d0413f63227ea7 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: + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. type: string + nullable: true 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: + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: type: string - example: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. type: string - format: uri - example: https://api.github.com/users/octocat/subscriptions - organizations_url: + example: Octo Business + slug: + description: The slug url identifier for the enterprise. type: string - format: uri - example: https://api.github.com/users/octocat/orgs - repos_url: + example: octo-business + created_at: type: string - format: uri - example: https://api.github.com/users/octocat/repos - events_url: + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: type: string - example: https://api.github.com/users/octocat/events{/privacy} - received_events_url: + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_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"' - user_view_type: - type: string - example: public 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 + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url integration: title: GitHub app description: GitHub apps are a new way to extend GitHub. They can be installed @@ -67314,7 +67773,9 @@ components: type: string example: '"Iv1.25b5d1e65ffc4022"' owner: - "$ref": "#/components/schemas/nullable-simple-user" + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/enterprise" name: description: The name of the GitHub app example: Probot Owners @@ -67677,61 +68138,6 @@ components: - repository_id - request - response - enterprise: - title: Enterprise - description: An enterprise on GitHub. - type: object - properties: - description: - description: A short description of the enterprise. - type: string - nullable: true - html_url: - type: string - format: uri - example: https://github.com/enterprises/octo-business - website_url: - description: The enterprise's website URL. - type: string - nullable: true - format: uri - id: - description: Unique identifier of the enterprise - example: 42 - type: integer - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the enterprise. - type: string - example: Octo Business - slug: - description: The slug url identifier for the enterprise. - type: string - example: octo-business - created_at: - type: string - nullable: true - format: date-time - example: '2019-01-26T19:01:12Z' - updated_at: - type: string - nullable: true - format: date-time - example: '2019-01-26T19:14:43Z' - avatar_url: - type: string - format: uri - required: - - id - - node_id - - name - - slug - - html_url - - created_at - - updated_at - - avatar_url integration-installation-request: title: Integration Installation Request description: Request to install an integration on a target @@ -68106,6 +68512,106 @@ components: issues: read deployments: write single_file: read + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + 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: 41d064eb2195891e12d0413f63227ea7 + 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"' + user_view_type: + type: string + example: public + 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 installation: title: Installation description: Installation @@ -70476,7 +70982,9 @@ components: type: string example: '"Iv1.25b5d1e65ffc4022"' owner: - "$ref": "#/components/schemas/nullable-simple-user" + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/enterprise" name: description: The name of the GitHub app example: Probot Owners @@ -72919,6 +73427,210 @@ components: - full_name - active_caches_size_in_bytes - active_caches_count + nullable-actions-hosted-runner-pool-image: + title: GitHub-hosted runner image details. + description: Provides details of a hosted runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: string + example: ubuntu-20.04 + size_gb: + description: Image size in GB. + type: integer + example: 86 + display_name: + description: Display name for this image. + type: string + example: 20.04 + source: + description: The image provider. + type: string + enum: + - github + - partner + - custom + version: + description: The image version of the hosted runner pool. + type: string + example: latest + required: + - id + - size_gb + - display_name + - source + - version + nullable: true + actions-hosted-runner-machine-spec: + title: Github-owned VM details. + description: Provides details of a particular machine spec. + type: object + properties: + id: + description: The ID used for the `size` parameter when creating a new runner. + type: string + example: 8-core + cpu_cores: + description: The number of cores. + type: integer + example: 8 + memory_gb: + description: The available RAM for the machine spec. + type: integer + example: 32 + storage_gb: + description: The available SSD storage for the machine spec. + type: integer + example: 300 + required: + - id + - cpu_cores + - memory_gb + - storage_gb + public-ip: + title: Public IP for a GitHub-hosted larger runners. + description: Provides details of Public IP for a GitHub-hosted larger runners + type: object + properties: + enabled: + description: Whether public IP is enabled. + type: boolean + example: true + prefix: + description: The prefix for the public IP. + type: string + example: 20.80.208.150 + length: + description: The length of the IP prefix. + type: integer + example: 28 + actions-hosted-runner: + title: GitHub-hosted hosted runner + description: A Github-hosted hosted runner. + type: object + properties: + id: + description: The unique identifier of the hosted runner. + type: integer + example: 5 + name: + description: The name of the hosted runner. + type: string + example: my-github-hosted-runner + runner_group_id: + description: The unique identifier of the group that the hosted runner belongs + to. + type: integer + example: 2 + image_details: + "$ref": "#/components/schemas/nullable-actions-hosted-runner-pool-image" + machine_size_details: + "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" + status: + description: The status of the runner. + type: string + example: Ready + enum: + - Ready + - Provisioning + - Shutdown + - Deleting + - Stuck + platform: + description: The operating system of the image. + type: string + example: linux-x64 + maximum_runners: + description: The maximum amount of hosted runners. Runners will not scale + automatically above this number. Use this setting to limit your cost. + type: integer + default: 10 + example: 5 + public_ip_enabled: + description: Whether public IP is enabled for the hosted runners. + type: boolean + example: true + public_ips: + description: The public IP ranges when public IP is enabled for the hosted + runners. + type: array + items: + "$ref": "#/components/schemas/public-ip" + last_active_on: + description: The time at which the runner was last used, in ISO 8601 format. + type: string + format: date-time + example: '2022-10-09T23:39:01Z' + nullable: true + required: + - id + - name + - image_details + - machine_size_details + - status + - public_ip_enabled + - platform + actions-hosted-runner-image: + title: GitHub-hosted runner image details. + description: Provides details of a hosted runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: string + example: ubuntu-20.04 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + size_gb: + description: Image size in GB. + type: integer + example: 86 + display_name: + description: Display name for this image. + type: string + example: 20.04 + source: + description: The image provider. + type: string + enum: + - github + - partner + - custom + required: + - id + - platform + - size_gb + - display_name + - source + actions-hosted-runner-limits: + type: object + properties: + public_ips: + title: Static public IP Limits for GitHub-hosted Hosted Runners. + description: Provides details of static public IP limits for GitHub-hosted + Hosted Runners + type: object + properties: + maximum: + type: integer + description: The maximum number of static public IP addresses that can + be used for Hosted Runners. + example: 50 + current_usage: + type: integer + description: The current number of static public IP addresses in use + by Hosted Runners. + example: 17 + required: + - maximum + - current_usage + required: + - public_ips oidc-custom-sub: title: Actions OIDC Subject customization description: Actions OIDC Subject customization @@ -73042,6 +73754,9 @@ components: type: string hosted_runners_url: type: string + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string inherited: type: boolean inherited_allows_public_repositories: @@ -202319,6 +203034,87 @@ components: - full_name: octo-org/server active_caches_size_in_bytes: 1022142 active_caches_count: 2 + actions-hosted-runner-paginated: + value: + total_count: 2 + runners: + - id: 5 + name: My hosted ubuntu runner + runner_group_id: 2 + platform: linux-x64 + image: + id: ubuntu-20.04 + size: 86 + machine_size_details: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + status: Ready + maximum_runners: 10 + public_ip_enabled: true + public_ips: + - enabled: true + prefix: 20.80.208.150 + length: 31 + last_active_on: '2022-10-09T23:39:01Z' + - id: 7 + name: My hosted Windows runner + runner_group_id: 2 + platform: win-x64 + image: + id: windows-latest + size: 256 + machine_size_details: + id: 8-core + cpu_cores: 8 + memory_gb: 32 + storage_gb: 300 + status: Ready + maximum_runners: 20 + public_ip_enabled: false + public_ips: [] + last_active_on: '2023-04-26T15:23:37Z' + actions-hosted-runner: + value: + id: 5 + name: My hosted ubuntu runner + runner_group_id: 2 + platform: linux-x64 + image: + id: ubuntu-20.04 + size: 86 + machine_size_details: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + status: Ready + maximum_runners: 10 + public_ip_enabled: true + public_ips: + - enabled: true + prefix: 20.80.208.150 + length: 31 + last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-image: + value: + id: ubuntu-20.04 + platform: linux-x64 + size_gb: 86 + display_name: '20.04' + source: github + actions-hosted-runner-limits-default: + value: + public_ips: + current_usage: 17 + maximum: 50 + actions-hosted-runner-machine-spec: + value: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 oidc-custom-sub: value: include_claim_keys: @@ -224778,6 +225574,13 @@ components: required: false schema: type: integer + hosted-runner-id: + name: hosted_runner_id + description: Unique identifier of the GitHub-hosted runner. + in: path + required: true + schema: + type: integer repository-id: name: repository_id description: The unique identifier of the repository. |