Skip to content

Commit 248f348

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.1 Descriptions
1 parent 1b11ba7 commit 248f348

8 files changed

Lines changed: 1058 additions & 14 deletions

File tree

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

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10295,6 +10295,82 @@
1029510295
}
1029610296
},
1029710297
"/orgs/{org}/custom_roles/{role_id}": {
10298+
"get": {
10299+
"summary": "Get a custom role",
10300+
"description": "**Note**: This operation is in beta and is subject to change.\n\nGets a custom repository role that is available to all repositories owned by the organization.\n\nTo use this operation, the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",
10301+
"tags": [
10302+
"orgs"
10303+
],
10304+
"operationId": "orgs/get-custom-role",
10305+
"externalDocs": {
10306+
"description": "API method documentation",
10307+
"url": "https://docs.github.com/rest/reference/orgs/#get-a-custom-role"
10308+
},
10309+
"parameters": [
10310+
{
10311+
"$ref": "#/components/parameters/org"
10312+
},
10313+
{
10314+
"$ref": "#/components/parameters/role-id"
10315+
}
10316+
],
10317+
"responses": {
10318+
"200": {
10319+
"description": "Response",
10320+
"content": {
10321+
"application/json": {
10322+
"schema": {
10323+
"$ref": "#/components/schemas/organization-custom-repository-role"
10324+
},
10325+
"examples": {
10326+
"default": {
10327+
"value": {
10328+
"id": 8030,
10329+
"name": "Labeler",
10330+
"description": "A role for who can label issues and PRs",
10331+
"base_role": "read",
10332+
"permissions": [
10333+
"add_label"
10334+
],
10335+
"organization": {
10336+
"login": "github",
10337+
"id": 9919,
10338+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
10339+
"avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
10340+
"gravatar_id": "",
10341+
"url": "https://api.github.com/users/github",
10342+
"html_url": "https://github.com/github",
10343+
"followers_url": "https://api.github.com/users/github/followers",
10344+
"following_url": "https://api.github.com/users/github/following{/other_user}",
10345+
"gists_url": "https://api.github.com/users/github/gists{/gist_id}",
10346+
"starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
10347+
"subscriptions_url": "https://api.github.com/users/github/subscriptions",
10348+
"organizations_url": "https://api.github.com/users/github/orgs",
10349+
"repos_url": "https://api.github.com/users/github/repos",
10350+
"events_url": "https://api.github.com/users/github/events{/privacy}",
10351+
"received_events_url": "https://api.github.com/users/github/received_events",
10352+
"type": "Organization",
10353+
"site_admin": false
10354+
},
10355+
"created_at": "2022-07-04T22:19:11Z",
10356+
"updated_at": "2022-07-04T22:19:11Z"
10357+
}
10358+
}
10359+
}
10360+
}
10361+
}
10362+
},
10363+
"404": {
10364+
"$ref": "#/components/responses/not_found"
10365+
}
10366+
},
10367+
"x-github": {
10368+
"githubCloudOnly": false,
10369+
"enabledForGitHubApps": true,
10370+
"category": "orgs",
10371+
"subcategory": "custom-roles"
10372+
}
10373+
},
1029810374
"patch": {
1029910375
"summary": "Update a custom role",
1030010376
"description": "**Note**: This operation is in beta and subject to change.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization.\n\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.\n\nFor more information about custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",

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

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7455,6 +7455,70 @@ paths:
74557455
category: orgs
74567456
subcategory: custom-roles
74577457
"/orgs/{org}/custom_roles/{role_id}":
7458+
get:
7459+
summary: Get a custom role
7460+
description: |-
7461+
**Note**: This operation is in beta and is subject to change.
7462+
7463+
Gets a custom repository role that is available to all repositories owned by the organization.
7464+
7465+
To use this operation, the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
7466+
GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
7467+
7468+
For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
7469+
tags:
7470+
- orgs
7471+
operationId: orgs/get-custom-role
7472+
externalDocs:
7473+
description: API method documentation
7474+
url: https://docs.github.com/rest/reference/orgs/#get-a-custom-role
7475+
parameters:
7476+
- "$ref": "#/components/parameters/org"
7477+
- "$ref": "#/components/parameters/role-id"
7478+
responses:
7479+
'200':
7480+
description: Response
7481+
content:
7482+
application/json:
7483+
schema:
7484+
"$ref": "#/components/schemas/organization-custom-repository-role"
7485+
examples:
7486+
default:
7487+
value:
7488+
id: 8030
7489+
name: Labeler
7490+
description: A role for who can label issues and PRs
7491+
base_role: read
7492+
permissions:
7493+
- add_label
7494+
organization:
7495+
login: github
7496+
id: 9919
7497+
node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk=
7498+
avatar_url: https://avatars.githubusercontent.com/u/9919?v=4
7499+
gravatar_id: ''
7500+
url: https://api.github.com/users/github
7501+
html_url: https://github.com/github
7502+
followers_url: https://api.github.com/users/github/followers
7503+
following_url: https://api.github.com/users/github/following{/other_user}
7504+
gists_url: https://api.github.com/users/github/gists{/gist_id}
7505+
starred_url: https://api.github.com/users/github/starred{/owner}{/repo}
7506+
subscriptions_url: https://api.github.com/users/github/subscriptions
7507+
organizations_url: https://api.github.com/users/github/orgs
7508+
repos_url: https://api.github.com/users/github/repos
7509+
events_url: https://api.github.com/users/github/events{/privacy}
7510+
received_events_url: https://api.github.com/users/github/received_events
7511+
type: Organization
7512+
site_admin: false
7513+
created_at: '2022-07-04T22:19:11Z'
7514+
updated_at: '2022-07-04T22:19:11Z'
7515+
'404':
7516+
"$ref": "#/components/responses/not_found"
7517+
x-github:
7518+
githubCloudOnly: false
7519+
enabledForGitHubApps: true
7520+
category: orgs
7521+
subcategory: custom-roles
74587522
patch:
74597523
summary: Update a custom role
74607524
description: |-

0 commit comments

Comments
 (0)