Skip to content

Commit 5c75267

Browse files
mattpagemattpage
authored
Merge pull request #1615 from github/openapi-update-e2764866f8c8de8a3ae98e87f6886a31165a9ac592eb6975ed8e63ce4eab67f5
Update OpenAPI 3.0 Descriptions
2 parents 5558d99 + e344bfb commit 5c75267

8 files changed

Lines changed: 1098 additions & 262 deletions

File tree

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

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10024,6 +10024,94 @@
1002410024
}
1002510025
}
1002610026
},
10027+
"/orgs/{org}/codespaces/billing": {
10028+
"put": {
10029+
"summary": "Set the visibility of organization codespaces",
10030+
"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.",
10031+
"tags": [
10032+
"codespaces"
10033+
],
10034+
"operationId": "codespaces/set-codespaces-billing",
10035+
"externalDocs": {
10036+
"description": "API method documentation",
10037+
"url": "https://docs.github.com/rest/reference/codespaces#set-codespaces-billing"
10038+
},
10039+
"parameters": [
10040+
{
10041+
"$ref": "#/components/parameters/org"
10042+
}
10043+
],
10044+
"requestBody": {
10045+
"required": true,
10046+
"content": {
10047+
"application/json": {
10048+
"schema": {
10049+
"type": "object",
10050+
"properties": {
10051+
"visibility": {
10052+
"type": "string",
10053+
"description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.",
10054+
"enum": [
10055+
"disabled",
10056+
"selected_members",
10057+
"all_members",
10058+
"all_members_and_outside_collaborators"
10059+
]
10060+
},
10061+
"selected_usernames": {
10062+
"type": "array",
10063+
"description": "The usernames of the organization members who should be granted access to codespaces in the organization. Required when `visibility` is `selected_members`.",
10064+
"items": {
10065+
"type": "string"
10066+
}
10067+
}
10068+
},
10069+
"required": [
10070+
"visibility"
10071+
]
10072+
},
10073+
"examples": {
10074+
"default": {
10075+
"value": {
10076+
"visibility": "selected_members",
10077+
"selected_usernames": [
10078+
"johnDoe",
10079+
"atomIO"
10080+
]
10081+
}
10082+
}
10083+
}
10084+
}
10085+
}
10086+
},
10087+
"responses": {
10088+
"204": {
10089+
"description": "Response when successfully modifying permissions."
10090+
},
10091+
"304": {
10092+
"$ref": "#/components/responses/not_modified"
10093+
},
10094+
"400": {
10095+
"description": "Users are neither members nor collaborators of this organization."
10096+
},
10097+
"404": {
10098+
"$ref": "#/components/responses/not_found"
10099+
},
10100+
"422": {
10101+
"$ref": "#/components/responses/validation_failed"
10102+
},
10103+
"500": {
10104+
"$ref": "#/components/responses/internal_error"
10105+
}
10106+
},
10107+
"x-github": {
10108+
"githubCloudOnly": false,
10109+
"enabledForGitHubApps": false,
10110+
"category": "codespaces",
10111+
"subcategory": "organizations"
10112+
}
10113+
}
10114+
},
1002710115
"/orgs/{org}/custom_roles": {
1002810116
"post": {
1002910117
"summary": "Create a custom role",

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

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7264,6 +7264,70 @@ paths:
72647264
enabledForGitHubApps: false
72657265
category: codespaces
72667266
subcategory: organizations
7267+
"/orgs/{org}/codespaces/billing":
7268+
put:
7269+
summary: Set the visibility of organization codespaces
7270+
description: |-
7271+
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.
7272+
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
7273+
tags:
7274+
- codespaces
7275+
operationId: codespaces/set-codespaces-billing
7276+
externalDocs:
7277+
description: API method documentation
7278+
url: https://docs.github.com/rest/reference/codespaces#set-codespaces-billing
7279+
parameters:
7280+
- "$ref": "#/components/parameters/org"
7281+
requestBody:
7282+
required: true
7283+
content:
7284+
application/json:
7285+
schema:
7286+
type: object
7287+
properties:
7288+
visibility:
7289+
type: string
7290+
description: Which users can access codespaces in the organization.
7291+
`disabled` means that no users can access codespaces in the organization.
7292+
enum:
7293+
- disabled
7294+
- selected_members
7295+
- all_members
7296+
- all_members_and_outside_collaborators
7297+
selected_usernames:
7298+
type: array
7299+
description: The usernames of the organization members who should
7300+
be granted access to codespaces in the organization. Required
7301+
when `visibility` is `selected_members`.
7302+
items:
7303+
type: string
7304+
required:
7305+
- visibility
7306+
examples:
7307+
default:
7308+
value:
7309+
visibility: selected_members
7310+
selected_usernames:
7311+
- johnDoe
7312+
- atomIO
7313+
responses:
7314+
'204':
7315+
description: Response when successfully modifying permissions.
7316+
'304':
7317+
"$ref": "#/components/responses/not_modified"
7318+
'400':
7319+
description: Users are neither members nor collaborators of this organization.
7320+
'404':
7321+
"$ref": "#/components/responses/not_found"
7322+
'422':
7323+
"$ref": "#/components/responses/validation_failed"
7324+
'500':
7325+
"$ref": "#/components/responses/internal_error"
7326+
x-github:
7327+
githubCloudOnly: false
7328+
enabledForGitHubApps: false
7329+
category: codespaces
7330+
subcategory: organizations
72677331
"/orgs/{org}/custom_roles":
72687332
post:
72697333
summary: Create a custom role

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

Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71807,6 +71807,212 @@
7180771807
}
7180871808
}
7180971809
},
71810+
"/orgs/{org}/codespaces/billing": {
71811+
"put": {
71812+
"summary": "Set the visibility of organization codespaces",
71813+
"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.",
71814+
"tags": [
71815+
"codespaces"
71816+
],
71817+
"operationId": "codespaces/set-codespaces-billing",
71818+
"externalDocs": {
71819+
"description": "API method documentation",
71820+
"url": "https://docs.github.com/rest/reference/codespaces#set-codespaces-billing"
71821+
},
71822+
"parameters": [
71823+
{
71824+
"name": "org",
71825+
"description": "The organization name. The name is not case sensitive.",
71826+
"in": "path",
71827+
"required": true,
71828+
"schema": {
71829+
"type": "string"
71830+
}
71831+
}
71832+
],
71833+
"requestBody": {
71834+
"required": true,
71835+
"content": {
71836+
"application/json": {
71837+
"schema": {
71838+
"type": "object",
71839+
"properties": {
71840+
"visibility": {
71841+
"type": "string",
71842+
"description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.",
71843+
"enum": [
71844+
"disabled",
71845+
"selected_members",
71846+
"all_members",
71847+
"all_members_and_outside_collaborators"
71848+
]
71849+
},
71850+
"selected_usernames": {
71851+
"type": "array",
71852+
"description": "The usernames of the organization members who should be granted access to codespaces in the organization. Required when `visibility` is `selected_members`.",
71853+
"items": {
71854+
"type": "string"
71855+
}
71856+
}
71857+
},
71858+
"required": [
71859+
"visibility"
71860+
]
71861+
},
71862+
"examples": {
71863+
"default": {
71864+
"value": {
71865+
"visibility": "selected_members",
71866+
"selected_usernames": [
71867+
"johnDoe",
71868+
"atomIO"
71869+
]
71870+
}
71871+
}
71872+
}
71873+
}
71874+
}
71875+
},
71876+
"responses": {
71877+
"204": {
71878+
"description": "Response when successfully modifying permissions."
71879+
},
71880+
"304": {
71881+
"description": "Not modified"
71882+
},
71883+
"400": {
71884+
"description": "Users are neither members nor collaborators of this organization."
71885+
},
71886+
"404": {
71887+
"description": "Resource not found",
71888+
"content": {
71889+
"application/json": {
71890+
"schema": {
71891+
"title": "Basic Error",
71892+
"description": "Basic Error",
71893+
"type": "object",
71894+
"properties": {
71895+
"message": {
71896+
"type": "string"
71897+
},
71898+
"documentation_url": {
71899+
"type": "string"
71900+
},
71901+
"url": {
71902+
"type": "string"
71903+
},
71904+
"status": {
71905+
"type": "string"
71906+
}
71907+
}
71908+
}
71909+
}
71910+
}
71911+
},
71912+
"422": {
71913+
"description": "Validation failed, or the endpoint has been spammed.",
71914+
"content": {
71915+
"application/json": {
71916+
"schema": {
71917+
"title": "Validation Error",
71918+
"description": "Validation Error",
71919+
"type": "object",
71920+
"required": [
71921+
"message",
71922+
"documentation_url"
71923+
],
71924+
"properties": {
71925+
"message": {
71926+
"type": "string"
71927+
},
71928+
"documentation_url": {
71929+
"type": "string"
71930+
},
71931+
"errors": {
71932+
"type": "array",
71933+
"items": {
71934+
"type": "object",
71935+
"required": [
71936+
"code"
71937+
],
71938+
"properties": {
71939+
"resource": {
71940+
"type": "string"
71941+
},
71942+
"field": {
71943+
"type": "string"
71944+
},
71945+
"message": {
71946+
"type": "string"
71947+
},
71948+
"code": {
71949+
"type": "string"
71950+
},
71951+
"index": {
71952+
"type": "integer"
71953+
},
71954+
"value": {
71955+
"oneOf": [
71956+
{
71957+
"type": "string",
71958+
"nullable": true
71959+
},
71960+
{
71961+
"type": "integer",
71962+
"nullable": true
71963+
},
71964+
{
71965+
"type": "array",
71966+
"nullable": true,
71967+
"items": {
71968+
"type": "string"
71969+
}
71970+
}
71971+
]
71972+
}
71973+
}
71974+
}
71975+
}
71976+
}
71977+
}
71978+
}
71979+
}
71980+
},
71981+
"500": {
71982+
"description": "Internal Error",
71983+
"content": {
71984+
"application/json": {
71985+
"schema": {
71986+
"title": "Basic Error",
71987+
"description": "Basic Error",
71988+
"type": "object",
71989+
"properties": {
71990+
"message": {
71991+
"type": "string"
71992+
},
71993+
"documentation_url": {
71994+
"type": "string"
71995+
},
71996+
"url": {
71997+
"type": "string"
71998+
},
71999+
"status": {
72000+
"type": "string"
72001+
}
72002+
}
72003+
}
72004+
}
72005+
}
72006+
}
72007+
},
72008+
"x-github": {
72009+
"githubCloudOnly": false,
72010+
"enabledForGitHubApps": false,
72011+
"category": "codespaces",
72012+
"subcategory": "organizations"
72013+
}
72014+
}
72015+
},
7181072016
"/orgs/{org}/custom_roles": {
7181172017
"post": {
7181272018
"summary": "Create a custom role",

0 commit comments

Comments
 (0)