From 67879245d64258c030ade55df66a4b19cde3ce43 Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Mon, 6 Jun 2022 19:01:40 +0000 Subject: [PATCH] Add decorated OpenAPI schema files --- lib/rest/static/decorated/api.github.com.json | 35 ++++++++++++++++--- lib/rest/static/decorated/ghes-3.1.json | 33 ++++++++++++++--- lib/rest/static/decorated/ghes-3.2.json | 33 ++++++++++++++--- lib/rest/static/decorated/ghes-3.3.json | 33 ++++++++++++++--- lib/rest/static/decorated/ghes-3.4.json | 33 ++++++++++++++--- lib/rest/static/decorated/ghes-3.5.json | 33 ++++++++++++++--- lib/rest/static/decorated/github.ae.json | 33 ++++++++++++++--- 7 files changed, 204 insertions(+), 29 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index aba2a66f09..1cb133edc2 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -357249,14 +357249,30 @@ } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "boolean", + "description": "

When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

", + "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": "

User is getting converted asynchronously

" + "contentType": "application/json", + "description": "

User is getting converted asynchronously

", + "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": "

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 repo scope or security_events scope.

\n

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

", + "descriptionHTML": "

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 repo scope or security_events scope.\nFor public repositories, you may instead use the public_repo scope.

\n

GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index b7151b7639..c759240d7e 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -269452,14 +269452,30 @@ } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "boolean", + "description": "

When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

", + "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" @@ -269467,14 +269483,23 @@ }, "response": { "statusCode": "202", - "description": "

User is getting converted asynchronously

" + "contentType": "application/json", + "description": "

User is getting converted asynchronously

", + "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" diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 6c4714b585..7fbbe39915 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -275393,14 +275393,30 @@ } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "boolean", + "description": "

When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

", + "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" @@ -275408,14 +275424,23 @@ }, "response": { "statusCode": "202", - "description": "

User is getting converted asynchronously

" + "contentType": "application/json", + "description": "

User is getting converted asynchronously

", + "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" diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 8ddb53c9f6..9ecbee339b 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -276339,14 +276339,30 @@ } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "boolean", + "description": "

When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

", + "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" @@ -276354,14 +276370,23 @@ }, "response": { "statusCode": "202", - "description": "

User is getting converted asynchronously

" + "contentType": "application/json", + "description": "

User is getting converted asynchronously

", + "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" diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index d9ea932109..dffa30e1e1 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -296224,14 +296224,30 @@ } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "boolean", + "description": "

When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

", + "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" @@ -296239,14 +296255,23 @@ }, "response": { "statusCode": "202", - "description": "

User is getting converted asynchronously

" + "contentType": "application/json", + "description": "

User is getting converted asynchronously

", + "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" diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index b892352fa1..465aeb0c8a 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -308069,14 +308069,30 @@ } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "boolean", + "description": "

When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

", + "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" @@ -308084,14 +308100,23 @@ }, "response": { "statusCode": "202", - "description": "

User is getting converted asynchronously

" + "contentType": "application/json", + "description": "

User is getting converted asynchronously

", + "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" diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index dbfbf20af3..7a72a870c8 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -276929,14 +276929,30 @@ } } ], - "bodyParameters": [], + "bodyParameters": [ + { + "type": "boolean", + "description": "

When set to true, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.

", + "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" @@ -276944,14 +276960,23 @@ }, "response": { "statusCode": "202", - "description": "

User is getting converted asynchronously

" + "contentType": "application/json", + "description": "

User is getting converted asynchronously

", + "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"