jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-06 06:02:35 -05:00
Code Issues Projects Releases Wiki Activity

Add decorated OpenAPI schema files

Browse Source
This commit is contained in:
github-openapi-bot
2022-06-06 19:01:40 +00:00
parent 1045a15ff1
commit 67879245d6
7 changed files with 204 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -357249,14 +357249,30 @@
}
}
],
"bodyParameters": [],
"bodyParameters": [
{
"type": "boolean",
"description": "<p>When set to <code>true</code>, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.</p>",
"default": false,
"name": "async",
"in": "body",
"rawType": "boolean",
"rawDescription": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.",
"isRequired": false,
"childParamsGroups": []
}
],
"enabledForGitHubApps": true,
"codeExamples": [
{
"key": "202",
"request": {
"description": "Example 1: Status Code 202",
"contentType": "application/json",
"description": "Status code 202, asynchronous request",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": {
"async": true
},
"parameters": {
"org": "ORG",
"username": "USERNAME"
@@ -357264,14 +357280,23 @@
},
"response": {
"statusCode": "202",
"description": "<p>User is getting converted asynchronously</p>"
"contentType": "application/json",
"description": "<p>User is getting converted asynchronously</p>",
"example": null,
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
},
{
"key": "204",
"request": {
"description": "Example 2: Status Code 204",
"contentType": "application/json",
"description": "Status code 204, synchronous request",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": null,
"parameters": {
"org": "ORG",
"username": "USERNAME"
@@ -494919,7 +494944,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
"descriptionHTML": "<p>Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.\nFor public repositories, you may instead use the <code>public_repo</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",