The client ID of the GitHub app.
", + "description": "The client ID of the OAuth app.
", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } } @@ -386495,10 +386504,18 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 200", + "description": "Create an authorization for an app 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" + "client_id": "abcde12345fghij67890" } }, "response": { @@ -387282,10 +387299,18 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Create an authorization for an app 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" + "client_id": "abcde12345fghij67890" } }, "response": { @@ -388107,13 +388132,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.
", + "description": "The client ID of the OAuth app.
", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } }, @@ -388189,10 +388214,18 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 200", + "description": "Create an authorization for an app and fingerprint 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766", + "client_id": "abcde12345fghij67890", "fingerprint": "FINGERPRINT" } }, @@ -388977,10 +389010,18 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Create an authorization for an app and fingerprint 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766", + "client_id": "abcde12345fghij67890", "fingerprint": "FINGERPRINT" } }, diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index bb106dd1f3..77fcd94389 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -298013,8 +298013,17 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Create an authorization", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url", + "client_id": "abcde12345fghij67890", + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f" + } }, "response": { "statusCode": "201", @@ -298843,13 +298852,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.
", + "description": "The client ID of the OAuth app.
", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } } @@ -298926,10 +298935,18 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 200", + "description": "Create an authorization for an app 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" + "client_id": "abcde12345fghij67890" } }, "response": { @@ -299721,10 +299738,18 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Create an authorization for an app 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" + "client_id": "abcde12345fghij67890" } }, "response": { @@ -300554,13 +300579,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.
", + "description": "The client ID of the OAuth app.
", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } }, @@ -300636,10 +300661,18 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 200", + "description": "Create an authorization for an app and fingerprint 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766", + "client_id": "abcde12345fghij67890", "fingerprint": "FINGERPRINT" } }, @@ -301432,10 +301465,18 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Create an authorization for an app and fingerprint 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766", + "client_id": "abcde12345fghij67890", "fingerprint": "FINGERPRINT" } }, diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 87f9f8aea4..a97507c45d 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -299227,8 +299227,17 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Create an authorization", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url", + "client_id": "abcde12345fghij67890", + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f" + } }, "response": { "statusCode": "201", @@ -300057,13 +300066,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.
", + "description": "The client ID of the OAuth app.
", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } } @@ -300140,10 +300149,18 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 200", + "description": "Create an authorization for an app 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" + "client_id": "abcde12345fghij67890" } }, "response": { @@ -300935,10 +300952,18 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Create an authorization for an app 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" + "client_id": "abcde12345fghij67890" } }, "response": { @@ -301768,13 +301793,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.
", + "description": "The client ID of the OAuth app.
", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } }, @@ -301850,10 +301875,18 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 200", + "description": "Create an authorization for an app and fingerprint 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766", + "client_id": "abcde12345fghij67890", "fingerprint": "FINGERPRINT" } }, @@ -302646,10 +302679,18 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Create an authorization for an app and fingerprint 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766", + "client_id": "abcde12345fghij67890", "fingerprint": "FINGERPRINT" } }, diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 21c1084ab1..cc2015b8bb 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -319123,8 +319123,17 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Create an authorization", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url", + "client_id": "abcde12345fghij67890", + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f" + } }, "response": { "statusCode": "201", @@ -319945,13 +319954,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.
", + "description": "The client ID of the OAuth app.
", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } } @@ -320028,10 +320037,18 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 200", + "description": "Create an authorization for an app 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" + "client_id": "abcde12345fghij67890" } }, "response": { @@ -320815,10 +320832,18 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Create an authorization for an app 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" + "client_id": "abcde12345fghij67890" } }, "response": { @@ -321640,13 +321665,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.
", + "description": "The client ID of the OAuth app.
", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } }, @@ -321722,10 +321747,18 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 200", + "description": "Create an authorization for an app and fingerprint 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766", + "client_id": "abcde12345fghij67890", "fingerprint": "FINGERPRINT" } }, @@ -322510,10 +322543,18 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Create an authorization for an app and fingerprint 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766", + "client_id": "abcde12345fghij67890", "fingerprint": "FINGERPRINT" } }, diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index 7404024937..7794eabc79 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -329120,8 +329120,17 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Create an authorization", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url", + "client_id": "abcde12345fghij67890", + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f" + } }, "response": { "statusCode": "201", @@ -329942,13 +329951,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.
", + "description": "The client ID of the OAuth app.
", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } } @@ -330025,10 +330034,18 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 200", + "description": "Create an authorization for an app 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" + "client_id": "abcde12345fghij67890" } }, "response": { @@ -330812,10 +330829,18 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Create an authorization for an app 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766" + "client_id": "abcde12345fghij67890" } }, "response": { @@ -331637,13 +331662,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.
", + "description": "The client ID of the OAuth app.
", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } }, @@ -331719,10 +331744,18 @@ "key": "response-if-returning-an-existing-token", "request": { "contentType": "application/json", - "description": "Example 1: Status Code 200", + "description": "Create an authorization for an app and fingerprint 1: Status Code 200", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766", + "client_id": "abcde12345fghij67890", "fingerprint": "FINGERPRINT" } }, @@ -332507,10 +332540,18 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example 2: Status Code 201", + "description": "Create an authorization for an app and fingerprint 2: Status Code 201", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + }, "parameters": { - "client_id": "Iv1.8a61f9b3a7aba766", + "client_id": "abcde12345fghij67890", "fingerprint": "FINGERPRINT" } }, diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index b90ef19add..bd1b5d2994 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -12703,6 +12703,20 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Create an authorization", + "value": { + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url", + "client_id": "abcde12345fghij67890", + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f" + } + } } } } @@ -13683,13 +13697,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.", + "description": "The client ID of the OAuth app.", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } } @@ -13739,6 +13753,19 @@ "client_secret" ], "type": "object" + }, + "examples": { + "default": { + "summary": "Create an authorization for an app", + "value": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + } + } } } } @@ -15483,13 +15510,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.", + "description": "The client ID of the OAuth app.", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } }, @@ -15543,6 +15570,19 @@ "client_secret" ], "type": "object" + }, + "examples": { + "default": { + "summary": "Create an authorization for an app and fingerprint", + "value": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 7ca0a984c1..1b6055907b 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -21242,6 +21242,20 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Create an authorization", + "value": { + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url", + "client_id": "abcde12345fghij67890", + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f" + } + } } } } @@ -22230,13 +22244,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.", + "description": "The client ID of the OAuth app.", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } } @@ -22286,6 +22300,19 @@ "client_secret" ], "type": "object" + }, + "examples": { + "default": { + "summary": "Create an authorization for an app", + "value": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + } + } } } } @@ -24046,13 +24073,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.", + "description": "The client ID of the OAuth app.", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } }, @@ -24106,6 +24133,19 @@ "client_secret" ], "type": "object" + }, + "examples": { + "default": { + "summary": "Create an authorization for an app and fingerprint", + "value": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index fb374b2da9..35e7b53f9b 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -21107,6 +21107,20 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Create an authorization", + "value": { + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url", + "client_id": "abcde12345fghij67890", + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f" + } + } } } } @@ -22095,13 +22109,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.", + "description": "The client ID of the OAuth app.", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } } @@ -22151,6 +22165,19 @@ "client_secret" ], "type": "object" + }, + "examples": { + "default": { + "summary": "Create an authorization for an app", + "value": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + } + } } } } @@ -23911,13 +23938,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.", + "description": "The client ID of the OAuth app.", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } }, @@ -23971,6 +23998,19 @@ "client_secret" ], "type": "object" + }, + "examples": { + "default": { + "summary": "Create an authorization for an app and fingerprint", + "value": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index e1f3c6f2c2..ae2d548af5 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -19158,6 +19158,20 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Create an authorization", + "value": { + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url", + "client_id": "abcde12345fghij67890", + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f" + } + } } } } @@ -20138,13 +20152,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.", + "description": "The client ID of the OAuth app.", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } } @@ -20194,6 +20208,19 @@ "client_secret" ], "type": "object" + }, + "examples": { + "default": { + "summary": "Create an authorization for an app", + "value": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + } + } } } } @@ -21938,13 +21965,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.", + "description": "The client ID of the OAuth app.", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } }, @@ -21998,6 +22025,19 @@ "client_secret" ], "type": "object" + }, + "examples": { + "default": { + "summary": "Create an authorization for an app and fingerprint", + "value": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index eea4d7183c..2e27099a49 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -19158,6 +19158,20 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Create an authorization", + "value": { + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url", + "client_id": "abcde12345fghij67890", + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f" + } + } } } } @@ -20138,13 +20152,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.", + "description": "The client ID of the OAuth app.", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } } @@ -20194,6 +20208,19 @@ "client_secret" ], "type": "object" + }, + "examples": { + "default": { + "summary": "Create an authorization for an app", + "value": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + } + } } } } @@ -21938,13 +21965,13 @@ "name": "client_id", "in": "path", "required": true, - "description": "The client ID of the GitHub app.", + "description": "The client ID of the OAuth app.", "schema": { "type": "string" }, "examples": { "default": { - "value": "Iv1.8a61f9b3a7aba766" + "value": "abcde12345fghij67890" } } }, @@ -21998,6 +22025,19 @@ "client_secret" ], "type": "object" + }, + "examples": { + "default": { + "summary": "Create an authorization for an app and fingerprint", + "value": { + "client_secret": "3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f", + "scopes": [ + "public_repo" + ], + "note": "optional note", + "note_url": "http://optional/note/url" + } + } } } }