From 519c7da3d852f298cc821e31e4bdaed96f7b59cb Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Wed, 19 Oct 2022 23:53:20 -0700 Subject: [PATCH] Update OpenAPI Descriptions (#31888) Co-authored-by: github-openapi-bot --- lib/rest/static/decorated/api.github.com.json | 107 +++++++++-- lib/rest/static/decorated/ghec.json | 107 +++++++++-- lib/rest/static/decorated/ghes-3.2.json | 61 ++++++- lib/rest/static/decorated/ghes-3.3.json | 72 +++++++- lib/rest/static/decorated/ghes-3.4.json | 72 +++++++- lib/rest/static/decorated/ghes-3.5.json | 72 +++++++- lib/rest/static/decorated/ghes-3.6.json | 72 +++++++- lib/rest/static/decorated/github.ae.json | 61 ++++++- .../dereferenced/api.github.com.deref.json | 168 +++++++++++++++++- lib/rest/static/dereferenced/ghec.deref.json | 168 +++++++++++++++++- .../static/dereferenced/ghes-3.2.deref.json | 88 ++++++++- .../static/dereferenced/ghes-3.3.deref.json | 95 +++++++++- .../static/dereferenced/ghes-3.4.deref.json | 95 +++++++++- .../static/dereferenced/ghes-3.5.deref.json | 95 +++++++++- .../static/dereferenced/ghes-3.6.deref.json | 95 +++++++++- .../static/dereferenced/github.ae.deref.json | 81 ++++++++- 16 files changed, 1387 insertions(+), 122 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index f20c395201..6c1c540924 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -130069,6 +130069,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -130520,6 +130525,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -130971,6 +130981,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "my-app" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -139176,7 +139191,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -148134,7 +148158,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -161895,6 +161928,10 @@ { "httpStatusCode": "404", "description": "

Resource not found

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "codespaces" @@ -165666,6 +165703,10 @@ { "httpStatusCode": "404", "description": "

Resource not found

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "codespaces" @@ -170977,6 +171018,10 @@ { "httpStatusCode": "404", "description": "

Resource not found

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "codespaces" @@ -186264,7 +186309,7 @@ "enabledForGitHubApps": true, "codeExamples": [ { - "key": "201", + "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", @@ -186281,7 +186326,16 @@ }, "response": { "statusCode": "201", - "description": "

Response when creating a secret

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

Response when creating a secret

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } }, { @@ -186723,7 +186777,7 @@ "enabledForGitHubApps": false, "codeExamples": [ { - "key": "201", + "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", @@ -186742,7 +186796,16 @@ }, "response": { "statusCode": "201", - "description": "

Response after successfully creaing a secret

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

Response after successfully creating a secret

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } }, { @@ -186773,7 +186836,7 @@ "statusCodes": [ { "httpStatusCode": "201", - "description": "

Response after successfully creaing a secret

" + "description": "

Response after successfully creating a secret

" }, { "httpStatusCode": "204", @@ -243911,7 +243974,11 @@ "request": { "contentType": "application/json", "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "limit": "collaborators_only", + "expiry": "one_month" + } }, "response": { "statusCode": "200", @@ -480845,8 +480912,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to read", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "read" + }, "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" @@ -484594,8 +484664,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to pull", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "push" + }, "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", @@ -496707,8 +496780,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Example of updating blog and name", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } }, "response": { "statusCode": "200", @@ -503487,8 +503564,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating content type and URL", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "content_type": "json", + "url": "https://example.com/webhook" + }, "parameters": { "owner": "OWNER", "repo": "REPO", diff --git a/lib/rest/static/decorated/ghec.json b/lib/rest/static/decorated/ghec.json index bea98858a0..2ddeb77762 100644 --- a/lib/rest/static/decorated/ghec.json +++ b/lib/rest/static/decorated/ghec.json @@ -130519,6 +130519,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -130970,6 +130975,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -131421,6 +131431,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "my-app" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -139626,7 +139641,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -148584,7 +148608,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -162345,6 +162378,10 @@ { "httpStatusCode": "404", "description": "

Resource not found

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "codespaces" @@ -166116,6 +166153,10 @@ { "httpStatusCode": "404", "description": "

Resource not found

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "codespaces" @@ -171427,6 +171468,10 @@ { "httpStatusCode": "404", "description": "

Resource not found

" + }, + { + "httpStatusCode": "503", + "description": "

Service unavailable

" } ], "subcategory": "codespaces" @@ -186714,7 +186759,7 @@ "enabledForGitHubApps": true, "codeExamples": [ { - "key": "201", + "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", @@ -186731,7 +186776,16 @@ }, "response": { "statusCode": "201", - "description": "

Response when creating a secret

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

Response when creating a secret

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } }, { @@ -187173,7 +187227,7 @@ "enabledForGitHubApps": false, "codeExamples": [ { - "key": "201", + "key": "default", "request": { "contentType": "application/json", "description": "Example 1: Status Code 201", @@ -187192,7 +187246,16 @@ }, "response": { "statusCode": "201", - "description": "

Response after successfully creaing a secret

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

Response after successfully creating a secret

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } }, { @@ -187223,7 +187286,7 @@ "statusCodes": [ { "httpStatusCode": "201", - "description": "

Response after successfully creaing a secret

" + "description": "

Response after successfully creating a secret

" }, { "httpStatusCode": "204", @@ -245296,7 +245359,11 @@ "request": { "contentType": "application/json", "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "limit": "collaborators_only", + "expiry": "one_month" + } }, "response": { "statusCode": "200", @@ -485163,8 +485230,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to read", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "read" + }, "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" @@ -488912,8 +488982,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to pull", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "push" + }, "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", @@ -502593,8 +502666,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Example of updating blog and name", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } }, "response": { "statusCode": "200", @@ -509373,8 +509450,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating content type and URL", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "content_type": "json", + "url": "https://example.com/webhook" + }, "parameters": { "owner": "OWNER", "repo": "REPO", diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 4fa449aced..0a9f41409a 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -111907,6 +111907,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -112358,6 +112363,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -112809,6 +112819,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "my-app" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -129847,7 +129862,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -273510,8 +273534,17 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating scopes and note", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "add_scopes": [ + "public_repo" + ], + "remove_scopes": [ + "user" + ], + "note": "optional note" + }, "parameters": { "authorization_id": "AUTHORIZATION_ID" } @@ -402227,8 +402260,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to read", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "read" + }, "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" @@ -405857,8 +405893,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to pull", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "push" + }, "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", @@ -417318,8 +417357,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Example of updating blog and name", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } }, "response": { "statusCode": "200", @@ -422954,8 +422997,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating content type and URL", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "content_type": "json", + "url": "https://example.com/webhook" + }, "parameters": { "owner": "OWNER", "repo": "REPO", diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index b68ee86685..16dbd3d40b 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -112383,6 +112383,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -112834,6 +112839,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -113285,6 +113295,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "my-app" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -121490,7 +121505,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -130402,7 +130426,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -274468,8 +274501,17 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating scopes and note", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "add_scopes": [ + "public_repo" + ], + "remove_scopes": [ + "user" + ], + "note": "optional note" + }, "parameters": { "authorization_id": "AUTHORIZATION_ID" } @@ -399955,8 +399997,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to read", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "read" + }, "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" @@ -403594,8 +403639,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to pull", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "push" + }, "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", @@ -415023,8 +415071,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Example of updating blog and name", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } }, "response": { "statusCode": "200", @@ -420659,8 +420711,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating content type and URL", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "content_type": "json", + "url": "https://example.com/webhook" + }, "parameters": { "owner": "OWNER", "repo": "REPO", diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index b461c61715..afc10b03ac 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -117679,6 +117679,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -118130,6 +118135,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -118581,6 +118591,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "my-app" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -126786,7 +126801,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -135696,7 +135720,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -292558,8 +292591,17 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating scopes and note", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "add_scopes": [ + "public_repo" + ], + "remove_scopes": [ + "user" + ], + "note": "optional note" + }, "parameters": { "authorization_id": "AUTHORIZATION_ID" } @@ -419496,8 +419538,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to read", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "read" + }, "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" @@ -423135,8 +423180,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to pull", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "push" + }, "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", @@ -434573,8 +434621,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Example of updating blog and name", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } }, "response": { "statusCode": "200", @@ -440209,8 +440261,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating content type and URL", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "content_type": "json", + "url": "https://example.com/webhook" + }, "parameters": { "owner": "OWNER", "repo": "REPO", diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index d6b681c238..5224abaa3d 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -123351,6 +123351,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -123802,6 +123807,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -124253,6 +124263,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "my-app" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -132458,7 +132473,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -141392,7 +141416,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -299720,8 +299753,17 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating scopes and note", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "add_scopes": [ + "public_repo" + ], + "remove_scopes": [ + "user" + ], + "note": "optional note" + }, "parameters": { "authorization_id": "AUTHORIZATION_ID" } @@ -427150,8 +427192,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to read", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "read" + }, "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" @@ -430803,8 +430848,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to pull", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "push" + }, "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", @@ -442241,8 +442289,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Example of updating blog and name", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } }, "response": { "statusCode": "200", @@ -447877,8 +447929,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating content type and URL", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "content_type": "json", + "url": "https://example.com/webhook" + }, "parameters": { "owner": "OWNER", "repo": "REPO", diff --git a/lib/rest/static/decorated/ghes-3.6.json b/lib/rest/static/decorated/ghes-3.6.json index 3580cd39ce..c8fedd33d7 100644 --- a/lib/rest/static/decorated/ghes-3.6.json +++ b/lib/rest/static/decorated/ghes-3.6.json @@ -125868,6 +125868,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -126319,6 +126324,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -126770,6 +126780,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "my-app" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -134975,7 +134990,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -143933,7 +143957,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -309051,8 +309084,17 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating scopes and note", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "add_scopes": [ + "public_repo" + ], + "remove_scopes": [ + "user" + ], + "note": "optional note" + }, "parameters": { "authorization_id": "AUTHORIZATION_ID" } @@ -439531,8 +439573,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to read", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "read" + }, "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" @@ -443280,8 +443325,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to pull", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "push" + }, "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", @@ -455482,8 +455530,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Example of updating blog and name", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } }, "response": { "statusCode": "200", @@ -461216,8 +461268,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating content type and URL", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "content_type": "json", + "url": "https://example.com/webhook" + }, "parameters": { "owner": "OWNER", "repo": "REPO", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index aa955193cc..dcfebd265b 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -89279,6 +89279,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -89730,6 +89735,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "octoapp" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -90181,6 +90191,11 @@ "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "apps": [ + "my-app" + ] + }, "parameters": { "owner": "OWNER", "repo": "REPO", @@ -98386,7 +98401,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -107344,7 +107368,16 @@ }, "response": { "statusCode": "201", - "description": "

Response

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

Response

", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } } } ], @@ -372689,8 +372722,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to read", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "read" + }, "parameters": { "team_id": "TEAM_ID", "project_id": "PROJECT_ID" @@ -376361,8 +376397,11 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of setting permission to pull", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "permission": "push" + }, "parameters": { "team_id": "TEAM_ID", "owner": "OWNER", @@ -388442,8 +388481,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json" + "description": "Example of updating blog and name", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } }, "response": { "statusCode": "200", @@ -393637,8 +393680,12 @@ "key": "default", "request": { "contentType": "application/json", - "description": "Example", + "description": "Example of updating content type and URL", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "content_type": "json", + "url": "https://example.com/webhook" + }, "parameters": { "owner": "OWNER", "repo": "REPO", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index f1ca4930a9..56282ff24d 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -191066,6 +191066,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -191611,6 +191620,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -192155,6 +192173,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "my-app" + ] + } + } } } } @@ -203022,10 +203049,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -210762,10 +210796,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -220868,6 +220909,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -222221,10 +222283,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -274869,12 +274938,15 @@ } ] } - }, - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } } } } @@ -381538,6 +381610,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -437893,6 +437986,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to read", + "value": { + "permission": "read" + } + } } } } @@ -441868,6 +441969,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to pull", + "value": { + "permission": "push" + } + } } } } @@ -443305,6 +443414,15 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating blog and name", + "value": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } + } } } } @@ -450091,6 +450209,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -450469,14 +450608,21 @@ }, "responses": { "201": { - "description": "Response after successfully creaing a secret", + "description": "Response after successfully creating a secret", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -466740,6 +466886,14 @@ "required": [ "limit" ] + }, + "examples": { + "default": { + "value": { + "limit": "collaborators_only", + "expiry": "one_month" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghec.deref.json b/lib/rest/static/dereferenced/ghec.deref.json index ce4a219953..a4a3516956 100644 --- a/lib/rest/static/dereferenced/ghec.deref.json +++ b/lib/rest/static/dereferenced/ghec.deref.json @@ -194559,6 +194559,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -195104,6 +195113,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -195648,6 +195666,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "my-app" + ] + } + } } } } @@ -206515,10 +206542,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -214255,10 +214289,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -224361,6 +224402,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -225714,10 +225776,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -278362,12 +278431,15 @@ } ] } - }, - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } } } } @@ -385031,6 +385103,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -445074,6 +445167,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to read", + "value": { + "permission": "read" + } + } } } } @@ -449049,6 +449150,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to pull", + "value": { + "permission": "push" + } + } } } } @@ -450975,6 +451084,15 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating blog and name", + "value": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } + } } } } @@ -457761,6 +457879,27 @@ } } } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -458139,14 +458278,21 @@ }, "responses": { "201": { - "description": "Response after successfully creaing a secret", + "description": "Response after successfully creating a secret", "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -474410,6 +474556,14 @@ "required": [ "limit" ] + }, + "examples": { + "default": { + "value": { + "limit": "collaborators_only", + "expiry": "one_month" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index d9cf4deeba..0974d86d54 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -26777,6 +26777,20 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating scopes and note", + "value": { + "add_scopes": [ + "public_repo" + ], + "remove_scopes": [ + "user" + ], + "note": "optional note" + } + } } } } @@ -156354,6 +156368,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -156899,6 +156922,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -157443,6 +157475,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "my-app" + ] + } + } } } } @@ -175134,10 +175175,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -226295,12 +226343,15 @@ } ] } - }, - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } } } } @@ -380592,6 +380643,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to read", + "value": { + "permission": "read" + } + } } } } @@ -384451,6 +384510,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to pull", + "value": { + "permission": "push" + } + } } } } @@ -385886,6 +385953,15 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating blog and name", + "value": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 2edf42a85e..88ae26b1ba 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -26642,6 +26642,20 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating scopes and note", + "value": { + "add_scopes": [ + "public_repo" + ], + "remove_scopes": [ + "user" + ], + "note": "optional note" + } + } } } } @@ -158227,6 +158241,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -158772,6 +158795,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -159316,6 +159348,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "my-app" + ] + } + } } } } @@ -169457,10 +169498,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -177155,10 +177203,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -228266,12 +228321,15 @@ } ] } - }, - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } } } } @@ -382953,6 +383011,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to read", + "value": { + "permission": "read" + } + } } } } @@ -386818,6 +386884,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to pull", + "value": { + "permission": "push" + } + } } } } @@ -388253,6 +388327,15 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating blog and name", + "value": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index fc3ba1aa69..01d73d0bd7 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -24645,6 +24645,20 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating scopes and note", + "value": { + "add_scopes": [ + "public_repo" + ], + "remove_scopes": [ + "user" + ], + "note": "optional note" + } + } } } } @@ -172480,6 +172494,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -173025,6 +173048,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -173569,6 +173601,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "my-app" + ] + } + } } } } @@ -184436,10 +184477,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -192128,10 +192176,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -243493,12 +243548,15 @@ } ] } - }, - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } } } } @@ -398398,6 +398456,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to read", + "value": { + "permission": "read" + } + } } } } @@ -402263,6 +402329,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to pull", + "value": { + "permission": "push" + } + } } } } @@ -403698,6 +403772,15 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating blog and name", + "value": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index 09c00fae11..899696fbc0 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -24645,6 +24645,20 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating scopes and note", + "value": { + "add_scopes": [ + "public_repo" + ], + "remove_scopes": [ + "user" + ], + "note": "optional note" + } + } } } } @@ -179605,6 +179619,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -180150,6 +180173,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -180694,6 +180726,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "my-app" + ] + } + } } } } @@ -191561,10 +191602,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -199277,10 +199325,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -250856,12 +250911,15 @@ } ] } - }, - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } } } } @@ -406249,6 +406307,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to read", + "value": { + "permission": "read" + } + } } } } @@ -410128,6 +410194,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to pull", + "value": { + "permission": "push" + } + } } } } @@ -411563,6 +411637,15 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating blog and name", + "value": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.6.deref.json b/lib/rest/static/dereferenced/ghes-3.6.deref.json index d8d8858326..a9bb30beb6 100644 --- a/lib/rest/static/dereferenced/ghes-3.6.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.6.deref.json @@ -24727,6 +24727,20 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating scopes and note", + "value": { + "add_scopes": [ + "public_repo" + ], + "remove_scopes": [ + "user" + ], + "note": "optional note" + } + } } } } @@ -183639,6 +183653,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -184184,6 +184207,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -184728,6 +184760,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "my-app" + ] + } + } } } } @@ -195595,10 +195636,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -203335,10 +203383,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -255821,12 +255876,15 @@ } ] } - }, - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } } } } @@ -420541,6 +420599,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to read", + "value": { + "permission": "read" + } + } } } } @@ -424516,6 +424582,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to pull", + "value": { + "permission": "push" + } + } } } } @@ -425951,6 +426025,15 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating blog and name", + "value": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } + } } } } diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 61cc5c5b23..795b95727b 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -144141,6 +144141,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -144686,6 +144695,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } } } } @@ -145230,6 +145248,15 @@ } } ] + }, + "examples": { + "default": { + "value": { + "apps": [ + "my-app" + ] + } + } } } } @@ -153115,10 +153142,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -160855,10 +160889,17 @@ "content": { "application/json": { "schema": { + "title": "Empty Object", + "description": "An object without any properties.", "type": "object", "properties": { }, "additionalProperties": false + }, + "examples": { + "default": { + "value": null + } } } } @@ -212001,12 +212042,15 @@ } ] } - }, - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } } } } @@ -361879,6 +361923,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to read", + "value": { + "permission": "read" + } + } } } } @@ -365777,6 +365829,14 @@ ] } } + }, + "examples": { + "default": { + "summary": "Example of setting permission to pull", + "value": { + "permission": "push" + } + } } } } @@ -367214,6 +367274,15 @@ "type": "string" } } + }, + "examples": { + "default": { + "summary": "Example of updating blog and name", + "value": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } + } } } }