fix: adapt title, description and support URL (#5)

gr2m · web-flow · commit 15e151f69bc9 · 2020-11-27T17:05:44.000-08:00
diff --git a/generated/api.github.com.deref.json b/generated/api.github.com.deref.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/api.github.com.json b/generated/api.github.com.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/ghes-2.18.deref.json b/generated/ghes-2.18.deref.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/ghes-2.18.json b/generated/ghes-2.18.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/ghes-2.19.deref.json b/generated/ghes-2.19.deref.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/ghes-2.19.json b/generated/ghes-2.19.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/ghes-2.20.deref.json b/generated/ghes-2.20.deref.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/ghes-2.20.json b/generated/ghes-2.20.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/ghes-2.21.deref.json b/generated/ghes-2.21.deref.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/ghes-2.21.json b/generated/ghes-2.21.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/ghes-2.22.deref.json b/generated/ghes-2.22.deref.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/ghes-2.22.json b/generated/ghes-2.22.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/github.ae.deref.json b/generated/github.ae.deref.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/generated/github.ae.json b/generated/github.ae.json
@@ -2,11 +2,14 @@
   "openapi": "3.0.3",
   "info": {
     "version": "0.0.0-development",
-    "title": "GitHub v3 REST API",
-    "description": "GitHub's v3 REST API.",
+    "title": "GitHub's official OpenAPI spec + Octokit extension",
+    "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
     "termsOfService": "https://docs.github.com/articles/github-terms-of-service",
-    "contact": { "name": "Support", "url": "https://support.github.com" }
+    "contact": {
+      "name": "Support",
+      "url": "https://github.com/octokit/openapi"
+    }
   },
   "tags": [
     {
diff --git a/scripts/build.js b/scripts/build.js
@@ -31,6 +31,10 @@ for (const file of schemaFileNames) {
   // overwrite version to "0.0.0-development", will be updated
   // right before publish via semantic-release
   schema.info.version = "0.0.0-development";
+  schema.info.title = "GitHub's official OpenAPI spec + Octokit extension";
+  schema.info.description =
+    "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs";
+  schema.info.contact.url = "https://github.com/octokit/openapi";
 
   writeFileSync(
     `generated/${file}`,
