jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-05 21:04:17 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Descriptions (#17642)

Browse Source 
* Update OpenAPI Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: Sarah Edwards <skedwards88@github.com>
This commit is contained in:
github-openapi-bot
2021-02-02 17:05:24 -05:00
committed by GitHub
parent 8f133cbf54
commit e1ac41b80b
14 changed files with 617 additions and 715 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
lib/rest/static/decorated/api.github.com.json
View File

@@ -8552,7 +8552,7 @@
}
],
"summary": "Set self-hosted runners in a group for an enterprise",
"description": "Replaces the list of self-hosted runners that that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
"tags": [
"enterprise-admin"
@@ -8614,7 +8614,7 @@
"description": "Default Response"
}
],
"descriptionHTML": "<p>Replaces the list of self-hosted runners that that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</p>\n<p>You must authenticate using an access token with the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. List of runner IDs to add to the runner group.</p>",
@@ -75025,13 +75025,13 @@
},
{
"name": "filter",
"description": "Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query:\n\n`?filter=userName%20eq%20\\\"Octocat\\\"`.\n\nTo filter results for for the identity with the email `octocat@github.com`, you would use this query:\n\n`?filter=emails%20eq%20\\\"octocat@github.com\\\"`.",
"description": "Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `external_id`. For example, to search for an identity with the `userName` Octocat, you would use this query:\n\n`?filter=userName%20eq%20\\\"Octocat\\\"`.\n\nTo filter results for the identity with the email `octocat@github.com`, you would use this query:\n\n`?filter=emails%20eq%20\\\"octocat@github.com\\\"`.",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>Filters results using the equals query parameter operator (<code>eq</code>). You can filter results that are equal to <code>id</code>, <code>userName</code>, <code>emails</code>, and <code>external_id</code>. For example, to search for an identity with the <code>userName</code> Octocat, you would use this query:</p>\n<p><code>?filter=userName%20eq%20\\\"Octocat\\\"</code>.</p>\n<p>To filter results for for the identity with the email <code>octocat@github.com</code>, you would use this query:</p>\n<p><code>?filter=emails%20eq%20\\\"octocat@github.com\\\"</code>.</p>"
"descriptionHTML": "<p>Filters results using the equals query parameter operator (<code>eq</code>). You can filter results that are equal to <code>id</code>, <code>userName</code>, <code>emails</code>, and <code>external_id</code>. For example, to search for an identity with the <code>userName</code> Octocat, you would use this query:</p>\n<p><code>?filter=userName%20eq%20\\\"Octocat\\\"</code>.</p>\n<p>To filter results for the identity with the email <code>octocat@github.com</code>, you would use this query:</p>\n<p><code>?filter=emails%20eq%20\\\"octocat@github.com\\\"</code>.</p>"
}
],
"x-codeSamples": [
@@ -83961,7 +83961,7 @@
"tags": [
"interactions"
],
"operationId": "interactions/get-restrictions-for-your-public-repos",
"operationId": "interactions/get-restrictions-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories"
@@ -84012,7 +84012,7 @@
"tags": [
"interactions"
],
"operationId": "interactions/set-restrictions-for-your-public-repos",
"operationId": "interactions/set-restrictions-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories"
@@ -84149,7 +84149,7 @@
"tags": [
"interactions"
],
"operationId": "interactions/remove-restrictions-for-your-public-repos",
"operationId": "interactions/remove-restrictions-for-authenticated-user",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories"