diff options
author | github-openapi-bot <security+github-openapi-bot@github.com> | 2022-09-12 16:22:51 -0700 |
---|---|---|
committer | github-openapi-bot <security+github-openapi-bot@github.com> | 2022-09-12 16:22:51 -0700 |
commit | ff2ae503b5f13dd37f4bf5c270476e0881df50f7 (patch) | |
tree | 5f80621bebfd7d8c153b5205e9f26e40a7ef592c /descriptions-next/api.github.com | |
parent | baae8844aa4ca49dd5efd417d9dca040dee68fae (diff) | |
download | rest-api-description-ff2ae503b5f13dd37f4bf5c270476e0881df50f7.tar.gz rest-api-description-ff2ae503b5f13dd37f4bf5c270476e0881df50f7.zip |
Update OpenAPI 3.1 Descriptions
Diffstat (limited to 'descriptions-next/api.github.com')
4 files changed, 70 insertions, 10 deletions
diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 986b86f3b..0433fabe5 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -3531,7 +3531,7 @@ "/enterprises/{enterprise}/consumed-licenses": { "get": { "summary": "List enterprise consumed licenses", - "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.", + "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.\n\n**Note:** The license consumption API endpoints for enterprise accounts are currently\nin Beta and are subject to change.", "tags": [ "enterprise-admin" ], @@ -30906,7 +30906,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository.", + "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.", "tags": [ "repos" ], @@ -34314,7 +34314,7 @@ "/repos/{owner}/{repo}/hooks": { "get": { "summary": "List repository webhooks", - "description": "", + "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.", "tags": [ "repos" ], @@ -63673,7 +63673,15 @@ "type": [ "string", "null" - ] + ], + "description": "Deprecated: The most permissive enterprise role for a user." + }, + "github_com_enterprise_roles": { + "type": "array", + "description": "All enterprise roles for a user.", + "items": { + "type": "string" + } }, "visual_studio_subscription_user": { "type": "boolean" @@ -92606,6 +92614,9 @@ "org2:Owner" ], "github_com_enterprise_role": "owner", + "github_com_enterprise_roles": [ + "owner" + ], "visual_studio_subscription_user": false, "github_com_verified_domain_emails": [ "monalisa@github.com" @@ -92636,6 +92647,9 @@ ], "github_com_enterprise_role": "", + "github_com_enterprise_roles": [ + + ], "visual_studio_subscription_user": false, "github_com_verified_domain_emails": [ diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 69ba1e3b2..827485bc4 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -2493,6 +2493,9 @@ paths: Lists the license consumption information for all users, including those from connected servers, associated with an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `read:enterprise` scope. + + **Note:** The license consumption API endpoints for enterprise accounts are currently + in Beta and are subject to change. tags: - enterprise-admin operationId: enterprise-admin/get-consumed-licenses @@ -22350,6 +22353,8 @@ paths: put: summary: Create or update file contents description: Creates a new file or replaces an existing file in a repository. + You must authenticate using an access token with the `workflow` scope to use + this endpoint. tags: - repos operationId: repos/create-or-update-file-contents @@ -25002,7 +25007,8 @@ paths: "/repos/{owner}/{repo}/hooks": get: summary: List repository webhooks - description: '' + description: Lists webhooks for a repository. `last response` may return null + if there have not been any deliveries within 30 days. tags: - repos operationId: repos/list-webhooks @@ -45880,6 +45886,13 @@ components: type: - string - 'null' + description: 'Deprecated: The most permissive enterprise role for + a user.' + github_com_enterprise_roles: + type: array + description: All enterprise roles for a user. + items: + type: string visual_studio_subscription_user: type: boolean github_com_verified_domain_emails: @@ -67197,6 +67210,8 @@ components: - org1:Owner - org2:Owner github_com_enterprise_role: owner + github_com_enterprise_roles: + - owner visual_studio_subscription_user: false github_com_verified_domain_emails: - monalisa@github.com @@ -67219,6 +67234,7 @@ components: license_type: enterprise github_com_member_roles: [] github_com_enterprise_role: '' + github_com_enterprise_roles: [] visual_studio_subscription_user: false github_com_verified_domain_emails: [] github_com_saml_name_id: '' diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index c489a0b4a..aba6388c1 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -22270,7 +22270,7 @@ "/enterprises/{enterprise}/consumed-licenses": { "get": { "summary": "List enterprise consumed licenses", - "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.", + "description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.\n\n**Note:** The license consumption API endpoints for enterprise accounts are currently\nin Beta and are subject to change.", "tags": [ "enterprise-admin" ], @@ -22356,7 +22356,15 @@ "type": [ "string", "null" - ] + ], + "description": "Deprecated: The most permissive enterprise role for a user." + }, + "github_com_enterprise_roles": { + "type": "array", + "description": "All enterprise roles for a user.", + "items": { + "type": "string" + } }, "visual_studio_subscription_user": { "type": "boolean" @@ -22433,6 +22441,9 @@ "org2:Owner" ], "github_com_enterprise_role": "owner", + "github_com_enterprise_roles": [ + "owner" + ], "visual_studio_subscription_user": false, "github_com_verified_domain_emails": [ "monalisa@github.com" @@ -22463,6 +22474,9 @@ ], "github_com_enterprise_role": "", + "github_com_enterprise_roles": [ + + ], "visual_studio_subscription_user": false, "github_com_verified_domain_emails": [ @@ -283626,7 +283640,7 @@ }, "put": { "summary": "Create or update file contents", - "description": "Creates a new file or replaces an existing file in a repository.", + "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.", "tags": [ "repos" ], @@ -310635,7 +310649,7 @@ "/repos/{owner}/{repo}/hooks": { "get": { "summary": "List repository webhooks", - "description": "", + "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.", "tags": [ "repos" ], diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 587c5988e..e43a9be46 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -8938,6 +8938,9 @@ paths: Lists the license consumption information for all users, including those from connected servers, associated with an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `read:enterprise` scope. + + **Note:** The license consumption API endpoints for enterprise accounts are currently + in Beta and are subject to change. tags: - enterprise-admin operationId: enterprise-admin/get-consumed-licenses @@ -8986,6 +8989,13 @@ paths: type: - string - 'null' + description: 'Deprecated: The most permissive enterprise + role for a user.' + github_com_enterprise_roles: + type: array + description: All enterprise roles for a user. + items: + type: string visual_studio_subscription_user: type: boolean github_com_verified_domain_emails: @@ -9036,6 +9046,8 @@ paths: - org1:Owner - org2:Owner github_com_enterprise_role: owner + github_com_enterprise_roles: + - owner visual_studio_subscription_user: false github_com_verified_domain_emails: - monalisa@github.com @@ -9058,6 +9070,7 @@ paths: license_type: enterprise github_com_member_roles: [] github_com_enterprise_role: '' + github_com_enterprise_roles: [] visual_studio_subscription_user: false github_com_verified_domain_emails: [] github_com_saml_name_id: '' @@ -48764,6 +48777,8 @@ paths: put: summary: Create or update file contents description: Creates a new file or replaces an existing file in a repository. + You must authenticate using an access token with the `workflow` scope to use + this endpoint. tags: - repos operationId: repos/create-or-update-file-contents @@ -53167,7 +53182,8 @@ paths: "/repos/{owner}/{repo}/hooks": get: summary: List repository webhooks - description: '' + description: Lists webhooks for a repository. `last response` may return null + if there have not been any deliveries within 30 days. tags: - repos operationId: repos/list-webhooks |