Skip to content

Commit

Permalink
Update OpenAPI Descriptions (github#22553)
Browse files Browse the repository at this point in the history 
* Update OpenAPI Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <[email protected]>
Co-authored-by: jmarlena <[email protected]>
  • Loading branch information
@github-openapi-bot @jmarlena
3 people authored Nov 3, 2021
1 parent 0fa2184 commit 63f5ce4
Show file tree
Hide file tree
Showing 7 changed files with 243 additions and 176 deletions.
85 changes: 27 additions & 58 deletions lib/rest/static/decorated/api.github.com.json
View file

Large diffs are not rendered by default.

72 changes: 16 additions & 56 deletions lib/rest/static/decorated/github.ae.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67003,13 +67003,13 @@
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"value\"}]}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"value\"}]}'</code></pre>"
"source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"any\"}]}'",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"any\"}]}'</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id',\n schemas: [\n 'schemas'\n ],\n Operations: [\n {\n op: 'op',\n path: 'path',\n value: 'value'\n }\n ]\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}'</span>, {\n <span class=\"hljs-attr\">enterprise</span>: <span class=\"hljs-string\">'enterprise'</span>,\n <span class=\"hljs-attr\">scim_group_id</span>: <span class=\"hljs-string\">'scim_group_id'</span>,\n <span class=\"hljs-attr\">schemas</span>: [\n <span class=\"hljs-string\">'schemas'</span>\n ],\n <span class=\"hljs-title hljs-class\">Operations</span>: [\n {\n <span class=\"hljs-attr\">op</span>: <span class=\"hljs-string\">'op'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>,\n <span class=\"hljs-attr\">value</span>: <span class=\"hljs-string\">'value'</span>\n }\n ]\n})\n</code></pre>"
"source": "await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id',\n schemas: [\n 'schemas'\n ],\n Operations: [\n {\n op: 'op',\n path: 'path',\n value: 'any'\n }\n ]\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.<span class=\"hljs-title hljs-function\">request</span>(<span class=\"hljs-string\">'PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}'</span>, {\n <span class=\"hljs-attr\">enterprise</span>: <span class=\"hljs-string\">'enterprise'</span>,\n <span class=\"hljs-attr\">scim_group_id</span>: <span class=\"hljs-string\">'scim_group_id'</span>,\n <span class=\"hljs-attr\">schemas</span>: [\n <span class=\"hljs-string\">'schemas'</span>\n ],\n <span class=\"hljs-title hljs-class\">Operations</span>: [\n {\n <span class=\"hljs-attr\">op</span>: <span class=\"hljs-string\">'op'</span>,\n <span class=\"hljs-attr\">path</span>: <span class=\"hljs-string\">'path'</span>,\n <span class=\"hljs-attr\">value</span>: <span class=\"hljs-string\">'any'</span>\n }\n ]\n})\n</code></pre>"
}
],
"summary": "Update an attribute for a SCIM enterprise group",
Expand Down Expand Up @@ -67073,21 +67073,11 @@
"childParamsGroups": []
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array"
}
],
"description": "<p>Can be any value - string, number, array or object.</p>",
"name": "value",
"in": "body",
"type": "string or object or array",
"description": "",
"rawDescription": "Can be any value - string, number, array or object.",
"type": "",
"childParamsGroups": []
}
},
Expand Down Expand Up @@ -67130,21 +67120,11 @@
"childParamsGroups": []
},
{
"oneOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array"
}
],
"description": "<p>Can be any value - string, number, array or object.</p>",
"name": "value",
"in": "body",
"type": "string or object or array",
"description": "",
"rawDescription": "Can be any value - string, number, array or object.",
"type": "",
"childParamsGroups": []
}
]
Expand Down Expand Up @@ -67243,21 +67223,11 @@
"childParamsGroups": []
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array"
}
],
"description": "<p>Can be any value - string, number, array or object.</p>",
"name": "value",
"in": "body",
"type": "string or object or array",
"description": "",
"rawDescription": "Can be any value - string, number, array or object.",
"type": "",
"childParamsGroups": []
}
},
Expand Down Expand Up @@ -67300,21 +67270,11 @@
"childParamsGroups": []
},
{
"oneOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array"
}
],
"description": "<p>Can be any value - string, number, array or object.</p>",
"name": "value",
"in": "body",
"type": "string or object or array",
"description": "",
"rawDescription": "Can be any value - string, number, array or object.",
"type": "",
"childParamsGroups": []
}
]
Expand Down
Loading

0 comments on commit 63f5ce4

Please sign in to comment.