Skip to content

Commit 5558d99

Browse files
mattpagemattpage
authored
Merge pull request #1616 from github/openapi-update-573c589dff307d0c437c6f61496237a4f099dda43f2e0ab210a5bd570c6a5b84
Update OpenAPI 3.1 Descriptions
2 parents 7f43788 + f081daf commit 5558d99

8 files changed

Lines changed: 1110 additions & 262 deletions

File tree

‎descriptions-next/api.github.com/api.github.com.json‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10074,6 +10074,94 @@
1007410074
}
1007510075
}
1007610076
},
10077+
"/orgs/{org}/codespaces/billing": {
10078+
"put": {
10079+
"summary": "Set the visibility of organization codespaces",
10080+
"description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
10081+
"tags": [
10082+
"codespaces"
10083+
],
10084+
"operationId": "codespaces/set-codespaces-billing",
10085+
"externalDocs": {
10086+
"description": "API method documentation",
10087+
"url": "https://docs.github.com/rest/reference/codespaces#set-codespaces-billing"
10088+
},
10089+
"parameters": [
10090+
{
10091+
"$ref": "#/components/parameters/org"
10092+
}
10093+
],
10094+
"requestBody": {
10095+
"required": true,
10096+
"content": {
10097+
"application/json": {
10098+
"schema": {
10099+
"type": "object",
10100+
"properties": {
10101+
"visibility": {
10102+
"type": "string",
10103+
"description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.",
10104+
"enum": [
10105+
"disabled",
10106+
"selected_members",
10107+
"all_members",
10108+
"all_members_and_outside_collaborators"
10109+
]
10110+
},
10111+
"selected_usernames": {
10112+
"type": "array",
10113+
"description": "The usernames of the organization members who should be granted access to codespaces in the organization. Required when `visibility` is `selected_members`.",
10114+
"items": {
10115+
"type": "string"
10116+
}
10117+
}
10118+
},
10119+
"required": [
10120+
"visibility"
10121+
]
10122+
},
10123+
"examples": {
10124+
"default": {
10125+
"value": {
10126+
"visibility": "selected_members",
10127+
"selected_usernames": [
10128+
"johnDoe",
10129+
"atomIO"
10130+
]
10131+
}
10132+
}
10133+
}
10134+
}
10135+
}
10136+
},
10137+
"responses": {
10138+
"204": {
10139+
"description": "Response when successfully modifying permissions."
10140+
},
10141+
"304": {
10142+
"$ref": "#/components/responses/not_modified"
10143+
},
10144+
"400": {
10145+
"description": "Users are neither members nor collaborators of this organization."
10146+
},
10147+
"404": {
10148+
"$ref": "#/components/responses/not_found"
10149+
},
10150+
"422": {
10151+
"$ref": "#/components/responses/validation_failed"
10152+
},
10153+
"500": {
10154+
"$ref": "#/components/responses/internal_error"
10155+
}
10156+
},
10157+
"x-github": {
10158+
"githubCloudOnly": false,
10159+
"enabledForGitHubApps": false,
10160+
"category": "codespaces",
10161+
"subcategory": "organizations"
10162+
}
10163+
}
10164+
},
1007710165
"/orgs/{org}/custom_roles": {
1007810166
"post": {
1007910167
"summary": "Create a custom role",

‎descriptions-next/api.github.com/api.github.com.yaml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7287,6 +7287,70 @@ paths:
72877287
enabledForGitHubApps: false
72887288
category: codespaces
72897289
subcategory: organizations
7290+
"/orgs/{org}/codespaces/billing":
7291+
put:
7292+
summary: Set the visibility of organization codespaces
7293+
description: |-
7294+
Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility.
7295+
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
7296+
tags:
7297+
- codespaces
7298+
operationId: codespaces/set-codespaces-billing
7299+
externalDocs:
7300+
description: API method documentation
7301+
url: https://docs.github.com/rest/reference/codespaces#set-codespaces-billing
7302+
parameters:
7303+
- "$ref": "#/components/parameters/org"
7304+
requestBody:
7305+
required: true
7306+
content:
7307+
application/json:
7308+
schema:
7309+
type: object
7310+
properties:
7311+
visibility:
7312+
type: string
7313+
description: Which users can access codespaces in the organization.
7314+
`disabled` means that no users can access codespaces in the organization.
7315+
enum:
7316+
- disabled
7317+
- selected_members
7318+
- all_members
7319+
- all_members_and_outside_collaborators
7320+
selected_usernames:
7321+
type: array
7322+
description: The usernames of the organization members who should
7323+
be granted access to codespaces in the organization. Required
7324+
when `visibility` is `selected_members`.
7325+
items:
7326+
type: string
7327+
required:
7328+
- visibility
7329+
examples:
7330+
default:
7331+
value:
7332+
visibility: selected_members
7333+
selected_usernames:
7334+
- johnDoe
7335+
- atomIO
7336+
responses:
7337+
'204':
7338+
description: Response when successfully modifying permissions.
7339+
'304':
7340+
"$ref": "#/components/responses/not_modified"
7341+
'400':
7342+
description: Users are neither members nor collaborators of this organization.
7343+
'404':
7344+
"$ref": "#/components/responses/not_found"
7345+
'422':
7346+
"$ref": "#/components/responses/validation_failed"
7347+
'500':
7348+
"$ref": "#/components/responses/internal_error"
7349+
x-github:
7350+
githubCloudOnly: false
7351+
enabledForGitHubApps: false
7352+
category: codespaces
7353+
subcategory: organizations
72907354
"/orgs/{org}/custom_roles":
72917355
post:
72927356
summary: Create a custom role

‎descriptions-next/api.github.com/dereferenced/api.github.com.deref.json‎

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83433,6 +83433,218 @@
8343383433
}
8343483434
}
8343583435
},
83436+
"/orgs/{org}/codespaces/billing": {
83437+
"put": {
83438+
"summary": "Set the visibility of organization codespaces",
83439+
"description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
83440+
"tags": [
83441+
"codespaces"
83442+
],
83443+
"operationId": "codespaces/set-codespaces-billing",
83444+
"externalDocs": {
83445+
"description": "API method documentation",
83446+
"url": "https://docs.github.com/rest/reference/codespaces#set-codespaces-billing"
83447+
},
83448+
"parameters": [
83449+
{
83450+
"name": "org",
83451+
"description": "The organization name. The name is not case sensitive.",
83452+
"in": "path",
83453+
"required": true,
83454+
"schema": {
83455+
"type": "string"
83456+
}
83457+
}
83458+
],
83459+
"requestBody": {
83460+
"required": true,
83461+
"content": {
83462+
"application/json": {
83463+
"schema": {
83464+
"type": "object",
83465+
"properties": {
83466+
"visibility": {
83467+
"type": "string",
83468+
"description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.",
83469+
"enum": [
83470+
"disabled",
83471+
"selected_members",
83472+
"all_members",
83473+
"all_members_and_outside_collaborators"
83474+
]
83475+
},
83476+
"selected_usernames": {
83477+
"type": "array",
83478+
"description": "The usernames of the organization members who should be granted access to codespaces in the organization. Required when `visibility` is `selected_members`.",
83479+
"items": {
83480+
"type": "string"
83481+
}
83482+
}
83483+
},
83484+
"required": [
83485+
"visibility"
83486+
]
83487+
},
83488+
"examples": {
83489+
"default": {
83490+
"value": {
83491+
"visibility": "selected_members",
83492+
"selected_usernames": [
83493+
"johnDoe",
83494+
"atomIO"
83495+
]
83496+
}
83497+
}
83498+
}
83499+
}
83500+
}
83501+
},
83502+
"responses": {
83503+
"204": {
83504+
"description": "Response when successfully modifying permissions."
83505+
},
83506+
"304": {
83507+
"description": "Not modified"
83508+
},
83509+
"400": {
83510+
"description": "Users are neither members nor collaborators of this organization."
83511+
},
83512+
"404": {
83513+
"description": "Resource not found",
83514+
"content": {
83515+
"application/json": {
83516+
"schema": {
83517+
"title": "Basic Error",
83518+
"description": "Basic Error",
83519+
"type": "object",
83520+
"properties": {
83521+
"message": {
83522+
"type": "string"
83523+
},
83524+
"documentation_url": {
83525+
"type": "string"
83526+
},
83527+
"url": {
83528+
"type": "string"
83529+
},
83530+
"status": {
83531+
"type": "string"
83532+
}
83533+
}
83534+
}
83535+
}
83536+
}
83537+
},
83538+
"422": {
83539+
"description": "Validation failed, or the endpoint has been spammed.",
83540+
"content": {
83541+
"application/json": {
83542+
"schema": {
83543+
"title": "Validation Error",
83544+
"description": "Validation Error",
83545+
"type": "object",
83546+
"required": [
83547+
"message",
83548+
"documentation_url"
83549+
],
83550+
"properties": {
83551+
"message": {
83552+
"type": "string"
83553+
},
83554+
"documentation_url": {
83555+
"type": "string"
83556+
},
83557+
"errors": {
83558+
"type": "array",
83559+
"items": {
83560+
"type": "object",
83561+
"required": [
83562+
"code"
83563+
],
83564+
"properties": {
83565+
"resource": {
83566+
"type": "string"
83567+
},
83568+
"field": {
83569+
"type": "string"
83570+
},
83571+
"message": {
83572+
"type": "string"
83573+
},
83574+
"code": {
83575+
"type": "string"
83576+
},
83577+
"index": {
83578+
"type": "integer"
83579+
},
83580+
"value": {
83581+
"oneOf": [
83582+
{
83583+
"type": [
83584+
"string",
83585+
"null"
83586+
]
83587+
},
83588+
{
83589+
"type": [
83590+
"integer",
83591+
"null"
83592+
]
83593+
},
83594+
{
83595+
"type": [
83596+
"array",
83597+
"null"
83598+
],
83599+
"items": {
83600+
"type": "string"
83601+
}
83602+
}
83603+
]
83604+
}
83605+
}
83606+
}
83607+
}
83608+
}
83609+
}
83610+
}
83611+
}
83612+
},
83613+
"500": {
83614+
"description": "Internal Error",
83615+
"content": {
83616+
"application/json": {
83617+
"schema": {
83618+
"title": "Basic Error",
83619+
"description": "Basic Error",
83620+
"type": "object",
83621+
"properties": {
83622+
"message": {
83623+
"type": "string"
83624+
},
83625+
"documentation_url": {
83626+
"type": "string"
83627+
},
83628+
"url": {
83629+
"type": "string"
83630+
},
83631+
"status": {
83632+
"type": "string"
83633+
}
83634+
}
83635+
}
83636+
}
83637+
}
83638+
}
83639+
},
83640+
"x-github": {
83641+
"githubCloudOnly": false,
83642+
"enabledForGitHubApps": false,
83643+
"category": "codespaces",
83644+
"subcategory": "organizations"
83645+
}
83646+
}
83647+
},
8343683648
"/orgs/{org}/custom_roles": {
8343783649
"post": {
8343883650
"summary": "Create a custom role",

0 commit comments

Comments
 (0)