Skip to content

Update OpenAPI 3.0 Descriptions #1615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattpage merged 1 commit into from
Sep 27, 2022
Merged

Update OpenAPI 3.0 Descriptions #1615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions descriptions/api.github.com/api.github.com.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10024,6 +10024,94 @@
}
}
},
"/orgs/{org}/codespaces/billing": {
"put": {
"summary": "Set the visibility of organization codespaces",
"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.",
"tags": [
"codespaces"
],
"operationId": "codespaces/set-codespaces-billing",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/codespaces#set-codespaces-billing"
},
"parameters": [
{
"$ref": "#/components/parameters/org"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"visibility": {
"type": "string",
"description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.",
"enum": [
"disabled",
"selected_members",
"all_members",
"all_members_and_outside_collaborators"
]
},
"selected_usernames": {
"type": "array",
"description": "The usernames of the organization members who should be granted access to codespaces in the organization. Required when `visibility` is `selected_members`.",
"items": {
"type": "string"
}
}
},
"required": [
"visibility"
]
},
"examples": {
"default": {
"value": {
"visibility": "selected_members",
"selected_usernames": [
"johnDoe",
"atomIO"
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "Response when successfully modifying permissions."
},
"304": {
"$ref": "#/components/responses/not_modified"
},
"400": {
"description": "Users are neither members nor collaborators of this organization."
},
"404": {
"$ref": "#/components/responses/not_found"
},
"422": {
"$ref": "#/components/responses/validation_failed"
},
"500": {
"$ref": "#/components/responses/internal_error"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "codespaces",
"subcategory": "organizations"
}
}
},
"/orgs/{org}/custom_roles": {
"post": {
"summary": "Create a custom role",
Expand Down
64 changes: 64 additions & 0 deletions descriptions/api.github.com/api.github.com.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7264,6 +7264,70 @@ paths:
enabledForGitHubApps: false
category: codespaces
subcategory: organizations
"/orgs/{org}/codespaces/billing":
put:
summary: Set the visibility of organization codespaces
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.
You must authenticate using an access token with the `admin:org` scope to use this endpoint.
tags:
- codespaces
operationId: codespaces/set-codespaces-billing
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/reference/codespaces#set-codespaces-billing
parameters:
- "$ref": "#/components/parameters/org"
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
visibility:
type: string
description: Which users can access codespaces in the organization.
`disabled` means that no users can access codespaces in the organization.
enum:
- disabled
- selected_members
- all_members
- all_members_and_outside_collaborators
selected_usernames:
type: array
description: The usernames of the organization members who should
be granted access to codespaces in the organization. Required
when `visibility` is `selected_members`.
items:
type: string
required:
- visibility
examples:
default:
value:
visibility: selected_members
selected_usernames:
- johnDoe
- atomIO
responses:
'204':
description: Response when successfully modifying permissions.
'304':
"$ref": "#/components/responses/not_modified"
'400':
description: Users are neither members nor collaborators of this organization.
'404':
"$ref": "#/components/responses/not_found"
'422':
"$ref": "#/components/responses/validation_failed"
'500':
"$ref": "#/components/responses/internal_error"
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
category: codespaces
subcategory: organizations
"/orgs/{org}/custom_roles":
post:
summary: Create a custom role
Expand Down
206 changes: 206 additions & 0 deletions descriptions/api.github.com/dereferenced/api.github.com.deref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71807,6 +71807,212 @@
}
}
},
"/orgs/{org}/codespaces/billing": {
"put": {
"summary": "Set the visibility of organization codespaces",
"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.",
"tags": [
"codespaces"
],
"operationId": "codespaces/set-codespaces-billing",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/codespaces#set-codespaces-billing"
},
"parameters": [
{
"name": "org",
"description": "The organization name. The name is not case sensitive.",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"visibility": {
"type": "string",
"description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.",
"enum": [
"disabled",
"selected_members",
"all_members",
"all_members_and_outside_collaborators"
]
},
"selected_usernames": {
"type": "array",
"description": "The usernames of the organization members who should be granted access to codespaces in the organization. Required when `visibility` is `selected_members`.",
"items": {
"type": "string"
}
}
},
"required": [
"visibility"
]
},
"examples": {
"default": {
"value": {
"visibility": "selected_members",
"selected_usernames": [
"johnDoe",
"atomIO"
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "Response when successfully modifying permissions."
},
"304": {
"description": "Not modified"
},
"400": {
"description": "Users are neither members nor collaborators of this organization."
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
},
"422": {
"description": "Validation failed, or the endpoint has been spammed.",
"content": {
"application/json": {
"schema": {
"title": "Validation Error",
"description": "Validation Error",
"type": "object",
"required": [
"message",
"documentation_url"
],
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"code"
],
"properties": {
"resource": {
"type": "string"
},
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"code": {
"type": "string"
},
"index": {
"type": "integer"
},
"value": {
"oneOf": [
{
"type": "string",
"nullable": true
},
{
"type": "integer",
"nullable": true
},
{
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
}
]
}
}
}
}
}
}
}
}
},
"500": {
"description": "Internal Error",
"content": {
"application/json": {
"schema": {
"title": "Basic Error",
"description": "Basic Error",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"documentation_url": {
"type": "string"
},
"url": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
}
}
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": false,
"category": "codespaces",
"subcategory": "organizations"
}
}
},
"/orgs/{org}/custom_roles": {
"post": {
"summary": "Create a custom role",
Expand Down
Loading