From 58d5ea4b66936fa48e3a554c0b3decdbaae5d5a6 Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Sun, 14 Aug 2022 16:01:09 -0700 Subject: [PATCH] Update OpenAPI Descriptions (#29925) * Update OpenAPI Descriptions * Add decorated OpenAPI schema files Co-authored-by: github-openapi-bot Co-authored-by: Vanessa --- lib/rest/static/decorated/api.github.com.json | 7 ++++++- lib/rest/static/decorated/ghes-3.2.json | 7 ++++++- lib/rest/static/decorated/ghes-3.3.json | 7 ++++++- lib/rest/static/decorated/ghes-3.4.json | 7 ++++++- lib/rest/static/decorated/ghes-3.5.json | 7 ++++++- lib/rest/static/decorated/ghes-3.6.json | 7 ++++++- lib/rest/static/decorated/github.ae.json | 7 ++++++- lib/rest/static/dereferenced/api.github.com.deref.json | 6 ++++++ lib/rest/static/dereferenced/ghes-3.2.deref.json | 6 ++++++ lib/rest/static/dereferenced/ghes-3.3.deref.json | 6 ++++++ lib/rest/static/dereferenced/ghes-3.4.deref.json | 6 ++++++ lib/rest/static/dereferenced/ghes-3.5.deref.json | 6 ++++++ lib/rest/static/dereferenced/ghes-3.6.deref.json | 6 ++++++ lib/rest/static/dereferenced/github.ae.deref.json | 6 ++++++ 14 files changed, 84 insertions(+), 7 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 61623e0f66..672f0a203a 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -363442,7 +363442,12 @@ }, "response": { "statusCode": "200", - "description": "

Response

" + "contentType": "text/plain", + "description": "

Example response

", + "example": "Responsive is better than fast", + "schema": { + "type": "string" + } } } ], diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 999e849ed3..70d2ddf2d2 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -293867,7 +293867,12 @@ }, "response": { "statusCode": "200", - "description": "

Response

" + "contentType": "text/plain", + "description": "

Example response

", + "example": "Responsive is better than fast", + "schema": { + "type": "string" + } } } ], diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index c886072cd9..c208b12275 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -295078,7 +295078,12 @@ }, "response": { "statusCode": "200", - "description": "

Response

" + "contentType": "text/plain", + "description": "

Example response

", + "example": "Responsive is better than fast", + "schema": { + "type": "string" + } } } ], diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index b6b8b121b1..57002ad83c 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -302876,7 +302876,12 @@ }, "response": { "statusCode": "200", - "description": "

Response

" + "contentType": "text/plain", + "description": "

Example response

", + "example": "Responsive is better than fast", + "schema": { + "type": "string" + } } } ], diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index 827f914494..5ae4ac3940 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -312797,7 +312797,12 @@ }, "response": { "statusCode": "200", - "description": "

Response

" + "contentType": "text/plain", + "description": "

Example response

", + "example": "Responsive is better than fast", + "schema": { + "type": "string" + } } } ], diff --git a/lib/rest/static/decorated/ghes-3.6.json b/lib/rest/static/decorated/ghes-3.6.json index 209b3cb082..5fdd971a33 100644 --- a/lib/rest/static/decorated/ghes-3.6.json +++ b/lib/rest/static/decorated/ghes-3.6.json @@ -314144,7 +314144,12 @@ }, "response": { "statusCode": "200", - "description": "

Response

" + "contentType": "text/plain", + "description": "

Example response

", + "example": "Responsive is better than fast", + "schema": { + "type": "string" + } } } ], diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 5c40d15af2..9aa7782444 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -268632,7 +268632,12 @@ }, "response": { "statusCode": "200", - "description": "

Response

" + "contentType": "text/plain", + "description": "

Example response

", + "example": "Responsive is better than fast", + "schema": { + "type": "string" + } } } ], diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index da22090c33..d5e5bac8b4 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -599141,6 +599141,12 @@ "text/plain": { "schema": { "type": "string" + }, + "examples": { + "default": { + "summary": "Example response", + "value": "Responsive is better than fast" + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index f16bd77766..5e6f683751 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -480112,6 +480112,12 @@ "text/plain": { "schema": { "type": "string" + }, + "examples": { + "default": { + "summary": "Example response", + "value": "Responsive is better than fast" + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 66bd2087a7..ce0bc4ac9a 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -482908,6 +482908,12 @@ "text/plain": { "schema": { "type": "string" + }, + "examples": { + "default": { + "summary": "Example response", + "value": "Responsive is better than fast" + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 5283711ef7..8ccec668b8 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -506082,6 +506082,12 @@ "text/plain": { "schema": { "type": "string" + }, + "examples": { + "default": { + "summary": "Example response", + "value": "Responsive is better than fast" + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index dc533563d1..712d7456c4 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -516735,6 +516735,12 @@ "text/plain": { "schema": { "type": "string" + }, + "examples": { + "default": { + "summary": "Example response", + "value": "Responsive is better than fast" + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.6.deref.json b/lib/rest/static/dereferenced/ghes-3.6.deref.json index 6a4d37d299..617949767c 100644 --- a/lib/rest/static/dereferenced/ghes-3.6.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.6.deref.json @@ -519608,6 +519608,12 @@ "text/plain": { "schema": { "type": "string" + }, + "examples": { + "default": { + "summary": "Example response", + "value": "Responsive is better than fast" + } } } } diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 67b3e2dc4d..6cff848e45 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -455822,6 +455822,12 @@ "text/plain": { "schema": { "type": "string" + }, + "examples": { + "default": { + "summary": "Example response", + "value": "Responsive is better than fast" + } } } }