diff --git a/package-lock.json b/package-lock.json index 4418385fd..7a1256474 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1458,6 +1458,7 @@ "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" @@ -1470,6 +1471,7 @@ "version": "2.0.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, "engines": { "node": ">= 8" } @@ -1478,6 +1480,7 @@ "version": "1.2.8", "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" @@ -2357,14 +2360,6 @@ "resolved": "packages/cloudflare-worker", "link": true }, - "node_modules/@readme/data-urls": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@readme/data-urls/-/data-urls-1.0.1.tgz", - "integrity": "sha512-FNP4ntG5rCgmrvQGoNH/Ljivc6jSWaaVeMuXneOyQ6oLuhm/NkysXJN3DnBrIsJUJbSae7qIs2QfPYnaropoHw==", - "engines": { - "node": ">=14" - } - }, "node_modules/@readme/eslint-config": { "version": "14.0.0", "resolved": "https://registry.npmjs.org/@readme/eslint-config/-/eslint-config-14.0.0.tgz", @@ -2502,33 +2497,6 @@ "resolved": "packages/sdk-snippets", "link": true }, - "node_modules/@readme/oas-extensions": { - "version": "17.0.1", - "resolved": "https://registry.npmjs.org/@readme/oas-extensions/-/oas-extensions-17.0.1.tgz", - "integrity": "sha512-PCU7WLz8TkbdxsiE4eQGvJYDYZQPiyLhXme3SvLboSmH+8G6AJPJ5OymzSAdlf5sXpSSoD2q3dTIou3Cb2DirQ==", - "deprecated": "The functionality for this library has been moved into `oas`.", - "engines": { - "node": ">=14" - }, - "peerDependencies": { - "oas": "^20.0.0" - } - }, - "node_modules/@readme/oas-to-har": { - "version": "20.1.1", - "resolved": "https://registry.npmjs.org/@readme/oas-to-har/-/oas-to-har-20.1.1.tgz", - "integrity": "sha512-rz8YpdZw+Jqrd8VQhQaYrzctkCAYdBldoQ5qDQyF9vGvq2lpA1yMvQPgKCJXfPGXH8Cm+NjLbunxnYabKQeKeA==", - "dependencies": { - "@readme/data-urls": "^1.0.1", - "@readme/oas-extensions": "^17.0.1", - "oas": "^20.5.0", - "qs": "^6.10.5", - "remove-undefined-objects": "^2.0.2" - }, - "engines": { - "node": ">=14" - } - }, "node_modules/@readme/openapi-parser": { "version": "2.5.0", "resolved": "https://registry.npmjs.org/@readme/openapi-parser/-/openapi-parser-2.5.0.tgz", @@ -3125,39 +3093,6 @@ "node": ">= 10" } }, - "node_modules/@ts-morph/common": { - "version": "0.18.1", - "resolved": "https://registry.npmjs.org/@ts-morph/common/-/common-0.18.1.tgz", - "integrity": "sha512-RVE+zSRICWRsfrkAw5qCAK+4ZH9kwEFv5h0+/YeHTLieWP7F4wWq4JsKFuNWG+fYh/KF+8rAtgdj5zb2mm+DVA==", - "dependencies": { - "fast-glob": "^3.2.12", - "minimatch": "^5.1.0", - "mkdirp": "^1.0.4", - "path-browserify": "^1.0.1" - } - }, - "node_modules/@ts-morph/common/node_modules/minimatch": { - "version": "5.1.6", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", - "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/@ts-morph/common/node_modules/mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "bin": { - "mkdirp": "bin/cmd.js" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/@tsconfig/node18": { "version": "18.2.4", "resolved": "https://registry.npmjs.org/@tsconfig/node18/-/node18-18.2.4.tgz", @@ -3351,7 +3286,8 @@ "node_modules/@types/har-format": { "version": "1.2.15", "resolved": "https://registry.npmjs.org/@types/har-format/-/har-format-1.2.15.tgz", - "integrity": "sha512-RpQH4rXLuvTXKR0zqHq3go0RVXYv/YVqv4TnPH95VbwUxZdQlK1EtcMvQvMpDngHbt13Csh9Z4qT9AbkiQH5BA==" + "integrity": "sha512-RpQH4rXLuvTXKR0zqHq3go0RVXYv/YVqv4TnPH95VbwUxZdQlK1EtcMvQvMpDngHbt13Csh9Z4qT9AbkiQH5BA==", + "dev": true }, "node_modules/@types/hast": { "version": "2.3.4", @@ -5223,77 +5159,6 @@ "node": ">=8" } }, - "node_modules/api": { - "version": "6.1.2", - "resolved": "https://registry.npmjs.org/api/-/api-6.1.2.tgz", - "integrity": "sha512-+804Qg5KpQNbvWg49LuZ5hA6bzp/blskK6s2VJPvufssKHA0GUbea0o5Sn2N0/ecgnJwafhFD1oTR11aBJuEsQ==", - "dependencies": { - "@readme/oas-to-har": "^20.0.2", - "@readme/openapi-parser": "^2.4.0", - "caseless": "^0.12.0", - "chalk": "^4.1.2", - "commander": "^10.0.0", - "datauri": "^4.1.0", - "execa": "^5.1.1", - "fetch-har": "^8.1.5", - "figures": "^3.2.0", - "find-cache-dir": "^3.3.1", - "form-data-encoder": "^1.7.2", - "formdata-node": "^4.3.2", - "get-stream": "^6.0.1", - "isomorphic-fetch": "^3.0.0", - "js-yaml": "^4.1.0", - "json-schema-to-ts": "^2.6.2-beta.0", - "json-schema-traverse": "^1.0.0", - "lodash": "^4.17.21", - "make-dir": "^3.1.0", - "node-abort-controller": "^3.1.1", - "oas": "^20.4.0", - "ora": "^5.4.1", - "prompts": "^2.4.2", - "remove-undefined-objects": "^2.0.2", - "semver": "^7.3.8", - "ssri": "^10.0.1", - "ts-morph": "^17.0.1", - "validate-npm-package-name": "^5.0.0" - }, - "bin": { - "api": "bin/api" - }, - "engines": { - "node": ">=16" - } - }, - "node_modules/api/node_modules/commander": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/commander/-/commander-10.0.1.tgz", - "integrity": "sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==", - "engines": { - "node": ">=14" - } - }, - "node_modules/api/node_modules/form-data-encoder": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-1.9.0.tgz", - "integrity": "sha512-rahaRMkN8P8d/tgK/BLPX+WBVM27NbvdXBxqQujBtkDAIFspaRqN7Od7lfdGQA6KAD+f82fYCLBq1ipvcu8qLw==" - }, - "node_modules/api/node_modules/formdata-node": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/formdata-node/-/formdata-node-4.4.1.tgz", - "integrity": "sha512-0iirZp3uVDjVGt9p49aTaqjk84TrglENEDuqfdlZQ1roC9CWlPk6Avf8EEnZNcAqPonwkG35x4n3ww/1THYAeQ==", - "dependencies": { - "node-domexception": "1.0.0", - "web-streams-polyfill": "4.0.0-beta.3" - }, - "engines": { - "node": ">= 12.20" - } - }, - "node_modules/api/node_modules/json-schema-traverse": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==" - }, "node_modules/append-field": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/append-field/-/append-field-1.0.0.tgz", @@ -5653,6 +5518,7 @@ "version": "1.5.1", "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==", + "dev": true, "funding": [ { "type": "github", @@ -5687,6 +5553,7 @@ "version": "4.1.0", "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", + "dev": true, "dependencies": { "buffer": "^5.5.0", "inherits": "^2.0.4", @@ -5893,6 +5760,7 @@ "version": "3.0.3", "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "dev": true, "dependencies": { "fill-range": "^7.1.1" }, @@ -5949,6 +5817,7 @@ "version": "5.7.1", "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz", "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==", + "dev": true, "funding": [ { "type": "github", @@ -5990,6 +5859,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz", "integrity": "sha512-qwVpFEHNfhYJIzNRBvd2C1kyo6jz3ZSMPyyuR47OPdiKWlbYnZNyDWuyR175qDnAJLiCo5fBBqPb3RiXgWlkOQ==", + "dev": true, "dependencies": { "semver": "^7.0.0" } @@ -6210,7 +6080,8 @@ "node_modules/caseless": { "version": "0.12.0", "resolved": "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz", - "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=" + "integrity": "sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=", + "dev": true }, "node_modules/ccount": { "version": "2.0.1", @@ -6380,6 +6251,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "dev": true, "dependencies": { "restore-cursor": "^3.1.0" }, @@ -6391,6 +6263,7 @@ "version": "2.9.2", "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.9.2.tgz", "integrity": "sha512-ywqV+5MmyL4E7ybXgKys4DugZbX0FC6LnwrhjuykIjnK9k8OQacQ7axGKnjDXWNhns0xot3bZI5h55H8yo9cJg==", + "dev": true, "engines": { "node": ">=6" }, @@ -6424,6 +6297,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz", "integrity": "sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==", + "dev": true, "engines": { "node": ">=0.8" } @@ -6451,11 +6325,6 @@ "node": "^14.17.0 || ^16.13.0 || >=18.0.0" } }, - "node_modules/code-block-writer": { - "version": "11.0.3", - "resolved": "https://registry.npmjs.org/code-block-writer/-/code-block-writer-11.0.3.tgz", - "integrity": "sha512-NiujjUFB4SwScJq2bwbYUtXbZhBSlY6vYzm++3Q6oC+U+injTqfPYFK8wS9COOmb2lueqp0ZRB4nK1VYeHgNyw==" - }, "node_modules/code-error-fragment": { "version": "0.0.230", "resolved": "https://registry.npmjs.org/code-error-fragment/-/code-error-fragment-0.0.230.tgz", @@ -7170,6 +7039,7 @@ "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "dev": true, "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", @@ -7291,18 +7161,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/datauri": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/datauri/-/datauri-4.1.0.tgz", - "integrity": "sha512-y17kh32+I82G+ED9MNWFkZiP/Cq/vO1hN9+tSZsT9C9qn3NrvcBnh7crSepg0AQPge1hXx2Ca44s1FRdv0gFWA==", - "dependencies": { - "image-size": "1.0.0", - "mimer": "^2.0.2" - }, - "engines": { - "node": ">= 10" - } - }, "node_modules/dateformat": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/dateformat/-/dateformat-3.0.3.tgz", @@ -7615,6 +7473,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.4.tgz", "integrity": "sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==", + "dev": true, "dependencies": { "clone": "^1.0.2" }, @@ -9497,6 +9356,7 @@ "version": "5.1.1", "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", + "dev": true, "dependencies": { "cross-spawn": "^7.0.3", "get-stream": "^6.0.0", @@ -9640,6 +9500,7 @@ "version": "3.2.12", "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.12.tgz", "integrity": "sha512-DVj4CQIYYow0BlaelwK1pHl5n5cRSJfM60UA0zK891sVInoPri2Ekj7+e1CT3/3qxXenpI+nBBmQAcJPJgaj4w==", + "dev": true, "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", @@ -9680,6 +9541,7 @@ "version": "1.13.0", "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", "integrity": "sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw==", + "dev": true, "dependencies": { "reusify": "^1.0.4" } @@ -9697,39 +9559,11 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/fetch-har": { - "version": "8.1.5", - "resolved": "https://registry.npmjs.org/fetch-har/-/fetch-har-8.1.5.tgz", - "integrity": "sha512-c9WDro4RWC+suOVRJFNW21cgqTOELRZpvFJgfENvOM7Yt/VA4QeFtRax795SyOpTisdpcl5XNQlQZdAE6HERDA==", - "dependencies": { - "@readme/data-urls": "^1.0.1", - "@types/har-format": "^1.2.8", - "readable-stream": "^3.6.0" - }, - "engines": { - "node": ">=14" - }, - "optionalDependencies": { - "formdata-node": "^4.3.2" - } - }, - "node_modules/fetch-har/node_modules/formdata-node": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/formdata-node/-/formdata-node-4.4.1.tgz", - "integrity": "sha512-0iirZp3uVDjVGt9p49aTaqjk84TrglENEDuqfdlZQ1roC9CWlPk6Avf8EEnZNcAqPonwkG35x4n3ww/1THYAeQ==", - "optional": true, - "dependencies": { - "node-domexception": "1.0.0", - "web-streams-polyfill": "4.0.0-beta.3" - }, - "engines": { - "node": ">= 12.20" - } - }, "node_modules/figures": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz", "integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==", + "dev": true, "dependencies": { "escape-string-regexp": "^1.0.5" }, @@ -9777,6 +9611,7 @@ "version": "7.1.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "dev": true, "dependencies": { "to-regex-range": "^5.0.1" }, @@ -10281,6 +10116,7 @@ "version": "6.0.1", "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", "integrity": "sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==", + "dev": true, "engines": { "node": ">=10" }, @@ -10464,6 +10300,7 @@ "version": "5.1.2", "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, "dependencies": { "is-glob": "^4.0.1" }, @@ -11054,6 +10891,7 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-2.1.0.tgz", "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", + "dev": true, "engines": { "node": ">=10.17.0" } @@ -11083,6 +10921,7 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", + "dev": true, "funding": [ { "type": "github", @@ -11131,20 +10970,6 @@ "node": ">=10" } }, - "node_modules/image-size": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/image-size/-/image-size-1.0.0.tgz", - "integrity": "sha512-JLJ6OwBfO1KcA+TvJT+v8gbE6iWbj24LyDNFgFEN0lzegn6cC6a/p3NIDaepMsJjQjlUWqIC7wJv8lBFxPNjcw==", - "dependencies": { - "queue": "6.0.2" - }, - "bin": { - "image-size": "bin/image-size.js" - }, - "engines": { - "node": ">=12.0.0" - } - }, "node_modules/import-fresh": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", @@ -11644,6 +11469,7 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", + "dev": true, "engines": { "node": ">=0.10.0" } @@ -11687,6 +11513,7 @@ "version": "4.0.3", "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dev": true, "dependencies": { "is-extglob": "^2.1.1" }, @@ -11766,6 +11593,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-1.0.0.tgz", "integrity": "sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==", + "dev": true, "engines": { "node": ">=8" } @@ -11819,6 +11647,7 @@ "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, "engines": { "node": ">=0.12.0" } @@ -11943,6 +11772,7 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.0.tgz", "integrity": "sha512-XCoy+WlUr7d1+Z8GgSuXmpuUFC9fOhRXglJMx+dwLKTkL44Cjd4W1Z5P+BQZpr+cR93aGP4S/s7Ftw6Nd/kiEw==", + "dev": true, "engines": { "node": ">=8" } @@ -12014,6 +11844,7 @@ "version": "0.1.0", "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", "integrity": "sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==", + "dev": true, "engines": { "node": ">=10" }, @@ -12106,7 +11937,8 @@ "node_modules/isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=" + "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=", + "dev": true }, "node_modules/isobject": { "version": "3.0.1", @@ -12121,6 +11953,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/isomorphic-fetch/-/isomorphic-fetch-3.0.0.tgz", "integrity": "sha512-qvUtwJ3j6qwsF3jLxkZ72qCgjMysPzDfeV240JHiGZsANBYd+EEuu35v7dfrJ9Up0Ak07D7GGSkGhCHTqg/5wA==", + "dev": true, "dependencies": { "node-fetch": "^2.6.1", "whatwg-fetch": "^3.4.1" @@ -12425,19 +12258,6 @@ "node": ">=12.0.0" } }, - "node_modules/json-schema-to-ts": { - "version": "2.12.0", - "resolved": "https://registry.npmjs.org/json-schema-to-ts/-/json-schema-to-ts-2.12.0.tgz", - "integrity": "sha512-uTde38yBm5lzJSRPWRaasxZo72pb+JGE4iUksNdNfAkFaLhV4N9akeBxPPUpZy5onINt9Zo0oTLrAoEXyZESiQ==", - "dependencies": { - "@babel/runtime": "^7.18.3", - "@types/json-schema": "^7.0.9", - "ts-algebra": "^1.2.2" - }, - "engines": { - "node": ">=16" - } - }, "node_modules/json-schema-traverse": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", @@ -12573,14 +12393,6 @@ "node": ">=0.10.0" } }, - "node_modules/kleur": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", - "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", - "engines": { - "node": ">=6" - } - }, "node_modules/language-subtag-registry": { "version": "0.3.22", "resolved": "https://registry.npmjs.org/language-subtag-registry/-/language-subtag-registry-0.3.22.tgz", @@ -13221,6 +13033,7 @@ "version": "4.1.0", "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", "integrity": "sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==", + "dev": true, "dependencies": { "chalk": "^4.1.0", "is-unicode-supported": "^0.1.0" @@ -13810,12 +13623,14 @@ "node_modules/merge-stream": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", - "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==" + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "dev": true }, "node_modules/merge2": { "version": "1.4.1", "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, "engines": { "node": ">= 8" } @@ -14563,6 +14378,7 @@ "version": "4.0.4", "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", "integrity": "sha512-pRmzw/XUcwXGpD9aI9q/0XOwLNygjETJ8y0ao0wdqprrzDa4YnxLcz7fQRZr8voh8V10kGhABbNcHVk5wHgWwg==", + "dev": true, "dependencies": { "braces": "^3.0.1", "picomatch": "^2.2.3" @@ -14602,21 +14418,11 @@ "node": ">= 0.6" } }, - "node_modules/mimer": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/mimer/-/mimer-2.0.2.tgz", - "integrity": "sha512-izxvjsB7Ur5HrTbPu6VKTrzxSMBFBqyZQc6dWlZNQ4/wAvf886fD4lrjtFd8IQ8/WmZKdxKjUtqFFNaj3hQ52g==", - "bin": { - "mimer": "bin/mimer" - }, - "engines": { - "node": ">= 12" - } - }, "node_modules/mimic-fn": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "dev": true, "engines": { "node": ">=6" } @@ -15179,15 +14985,11 @@ "node": ">= 10.13" } }, - "node_modules/node-abort-controller": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/node-abort-controller/-/node-abort-controller-3.1.1.tgz", - "integrity": "sha512-AGK2yQKIjRuqnc6VkX2Xj5d+QW8xZ87pa1UK6yA6ouUyuxfHuMP6umE5QK7UmTeOAymo+Zx1Fxiuw9rVx8taHQ==" - }, "node_modules/node-domexception": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz", "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==", + "dev": true, "funding": [ { "type": "github", @@ -15832,6 +15634,7 @@ "version": "4.0.1", "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dev": true, "dependencies": { "path-key": "^3.0.0" }, @@ -16366,6 +16169,7 @@ "version": "5.1.2", "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "dev": true, "dependencies": { "mimic-fn": "^2.1.0" }, @@ -16420,6 +16224,7 @@ "version": "5.4.1", "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz", "integrity": "sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==", + "dev": true, "dependencies": { "bl": "^4.1.0", "chalk": "^4.1.0", @@ -17055,11 +16860,6 @@ "node": ">= 0.8" } }, - "node_modules/path-browserify": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/path-browserify/-/path-browserify-1.0.1.tgz", - "integrity": "sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==" - }, "node_modules/path-exists": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", @@ -17080,6 +16880,7 @@ "version": "3.1.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true, "engines": { "node": ">=8" } @@ -17163,6 +16964,7 @@ "version": "2.3.0", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.0.tgz", "integrity": "sha512-lY1Q/PiJGC2zOv/z391WOTD+Z02bCgsFfvxoXXf6h7kv9o+WmsmzYqrAwY63sNgOxE4xEdq0WyUnXfKeBrSvYw==", + "dev": true, "engines": { "node": ">=8.6" }, @@ -17338,18 +17140,6 @@ "node": ">=10" } }, - "node_modules/prompts": { - "version": "2.4.2", - "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", - "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", - "dependencies": { - "kleur": "^3.0.3", - "sisteransi": "^1.0.5" - }, - "engines": { - "node": ">= 6" - } - }, "node_modules/promzard": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/promzard/-/promzard-1.0.2.tgz", @@ -17504,6 +17294,7 @@ "version": "6.11.0", "resolved": "https://registry.npmjs.org/qs/-/qs-6.11.0.tgz", "integrity": "sha512-MvjoMCJwEarSbUYk5O+nmoSzSutSsTwF85zcHPQ9OrlFoZOYIjaqBAJIqIXjptyD5vThxGq52Xu/MaJzRkIk4Q==", + "dev": true, "dependencies": { "side-channel": "^1.0.4" }, @@ -17520,18 +17311,11 @@ "integrity": "sha512-FIqgj2EUvTa7R50u0rGsyTftzjYmv/a3hO345bZNrqabNqjtgiDMgmo4mkUjd+nzU5oF3dClKqFIPUKybUyqoQ==", "dev": true }, - "node_modules/queue": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/queue/-/queue-6.0.2.tgz", - "integrity": "sha512-iHZWu+q3IdFZFX36ro/lKBkSvfkztY5Y7HMiPlOUjhupPcG2JMfst2KKEpu5XndviX/3UhFbRngUPNKtgvtZiA==", - "dependencies": { - "inherits": "~2.0.3" - } - }, "node_modules/queue-microtask": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, "funding": [ { "type": "github", @@ -17817,6 +17601,7 @@ "version": "3.6.0", "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.0.tgz", "integrity": "sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA==", + "dev": true, "dependencies": { "inherits": "^2.0.3", "string_decoder": "^1.1.1", @@ -18102,14 +17887,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/remove-undefined-objects": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/remove-undefined-objects/-/remove-undefined-objects-2.0.2.tgz", - "integrity": "sha512-b6x4MUtR4YBW1aCoGx3tE4mA2PFjiXSmtSdNmLexQzUdZa4ybnJAItXLKpkcVgCUJIzJtk2DFG402sMSEMlonQ==", - "engines": { - "node": ">=14" - } - }, "node_modules/require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -18213,6 +17990,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", + "dev": true, "dependencies": { "onetime": "^5.1.0", "signal-exit": "^3.0.2" @@ -18292,6 +18070,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true, "engines": { "iojs": ">=1.0.0", "node": ">=0.10.0" @@ -18355,6 +18134,7 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, "funding": [ { "type": "github", @@ -18421,7 +18201,8 @@ "node_modules/safe-buffer": { "version": "5.1.2", "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz", - "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==" + "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==", + "dev": true }, "node_modules/safe-regex-test": { "version": "1.0.3", @@ -18468,6 +18249,7 @@ "version": "7.6.2", "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "dev": true, "bin": { "semver": "bin/semver.js" }, @@ -18609,6 +18391,7 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, "dependencies": { "shebang-regex": "^3.0.0" }, @@ -18620,6 +18403,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true, "engines": { "node": ">=8" } @@ -18698,7 +18482,8 @@ "node_modules/signal-exit": { "version": "3.0.7", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", - "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==" + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "dev": true }, "node_modules/sigstore": { "version": "1.9.0", @@ -18885,11 +18670,6 @@ "node": ">= 10" } }, - "node_modules/sisteransi": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", - "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==" - }, "node_modules/slash": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", @@ -19261,6 +19041,7 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "dev": true, "dependencies": { "safe-buffer": "~5.1.0" } @@ -19440,6 +19221,7 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-2.0.0.tgz", "integrity": "sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==", + "dev": true, "engines": { "node": ">=6" } @@ -19933,6 +19715,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, "dependencies": { "is-number": "^7.0.0" }, @@ -20011,11 +19794,6 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/ts-algebra": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/ts-algebra/-/ts-algebra-1.2.2.tgz", - "integrity": "sha512-kloPhf1hq3JbCPOTYoOWDKxebWjNb2o/LKnNfkWhxVVisFFmMJPPdJeGoGmM+iRLyoXAR61e08Pb+vUXINg8aA==" - }, "node_modules/ts-api-utils": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.3.0.tgz", @@ -20028,15 +19806,6 @@ "typescript": ">=4.2.0" } }, - "node_modules/ts-morph": { - "version": "17.0.1", - "resolved": "https://registry.npmjs.org/ts-morph/-/ts-morph-17.0.1.tgz", - "integrity": "sha512-10PkHyXmrtsTvZSL+cqtJLTgFXkU43Gd0JCc0Rw6GchWbqKe0Rwgt1v3ouobTZwQzF1mGhDeAlWYBMGRV7y+3g==", - "dependencies": { - "@ts-morph/common": "~0.18.0", - "code-block-writer": "^11.0.3" - } - }, "node_modules/tsconfig-paths": { "version": "3.14.2", "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.14.2.tgz", @@ -20990,7 +20759,8 @@ "node_modules/util-deprecate": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", - "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=" + "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=", + "dev": true }, "node_modules/utils-merge": { "version": "1.0.1", @@ -21073,6 +20843,7 @@ "version": "5.0.0", "resolved": "https://registry.npmjs.org/validate-npm-package-name/-/validate-npm-package-name-5.0.0.tgz", "integrity": "sha512-YuKoXDAhBYxY7SfOKxHBDoSyENFeW5VvIIQp2TGQuit8gpK6MnWaQelBKxso72DoxTZfZdcP3W90LqpSkgPzLQ==", + "dev": true, "dependencies": { "builtins": "^5.0.0" }, @@ -21463,6 +21234,7 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz", "integrity": "sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg==", + "dev": true, "dependencies": { "defaults": "^1.0.3" } @@ -21481,6 +21253,7 @@ "version": "4.0.0-beta.3", "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-4.0.0-beta.3.tgz", "integrity": "sha512-QW95TCTaHmsYfHDybGMwO5IJIM93I/6vTRk+daHTWFPhwh+C8Cg7j7XyKrwrj8Ib6vYXe0ocYNrmzY4xAAN6ug==", + "dev": true, "engines": { "node": ">= 14" } @@ -21622,7 +21395,8 @@ "node_modules/whatwg-fetch": { "version": "3.6.2", "resolved": "https://registry.npmjs.org/whatwg-fetch/-/whatwg-fetch-3.6.2.tgz", - "integrity": "sha512-bJlen0FcuU/0EMLrdbJ7zOnW6ITZLrZMIarMUVmdKtsGvZna8vxKYaexICWPfZ8qwf9fzNq+UEIZrnSaApt6RA==" + "integrity": "sha512-bJlen0FcuU/0EMLrdbJ7zOnW6ITZLrZMIarMUVmdKtsGvZna8vxKYaexICWPfZ8qwf9fzNq+UEIZrnSaApt6RA==", + "dev": true }, "node_modules/whatwg-url": { "version": "5.0.0", @@ -21637,6 +21411,7 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, "dependencies": { "isexe": "^2.0.0" }, @@ -22103,12 +21878,9 @@ "version": "7.0.0-alpha.7", "license": "ISC", "dependencies": { - "@types/har-format": "^1.2.10", - "api": "^6.1.1", "content-type": "^1.0.5", "find-cache-dir": "^3.3.2", "flat-cache": "^3.0.4", - "json-schema-to-ts": "^2.9.2", "lodash": "^4.17.15", "oas": "^20.10.2", "ssri": "^10.0.1", @@ -22122,6 +21894,7 @@ "@types/content-type": "^1.1.5", "@types/find-cache-dir": "^3.2.1", "@types/flat-cache": "^2.0.0", + "@types/har-format": "^1.2.15", "@types/lodash": "^4.14.197", "@types/multer": "^1.4.7", "@types/node": "^20.14.12", diff --git a/packages/node/package.json b/packages/node/package.json index 26201a580..3524cd5df 100644 --- a/packages/node/package.json +++ b/packages/node/package.json @@ -25,12 +25,9 @@ "dist" ], "dependencies": { - "@types/har-format": "^1.2.10", - "api": "^6.1.1", "content-type": "^1.0.5", "find-cache-dir": "^3.3.2", "flat-cache": "^3.0.4", - "json-schema-to-ts": "^2.9.2", "lodash": "^4.17.15", "oas": "^20.10.2", "ssri": "^10.0.1", @@ -44,6 +41,7 @@ "@types/content-type": "^1.1.5", "@types/find-cache-dir": "^3.2.1", "@types/flat-cache": "^2.0.0", + "@types/har-format": "^1.2.15", "@types/lodash": "^4.14.197", "@types/multer": "^1.4.7", "@types/node": "^20.14.12", diff --git a/packages/node/src/.api/api.json b/packages/node/src/.api/api.json deleted file mode 100644 index f7cbc79bb..000000000 --- a/packages/node/src/.api/api.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "version": "1.0", - "apis": [ - { - "identifier": "developers", - "source": "@developers/v2.0#5a1mg1plldzmnq5", - "integrity": "sha512-pA1uoUA9nuzjAXOzYpXzBxL8P9YgJbthrDnufYNJS6YJnK0j0Rz5wNA3JlwJrA69vJpDTu22MB4JnSlifeE0oA==", - "installerVersion": "6.1.1" - } - ] -} diff --git a/packages/node/src/.api/apis/developers/index.ts b/packages/node/src/.api/apis/developers/index.ts deleted file mode 100644 index 083a63dd4..000000000 --- a/packages/node/src/.api/apis/developers/index.ts +++ /dev/null @@ -1,487 +0,0 @@ -import type * as types from './types'; -import type { ConfigOptions, FetchResponse } from 'api/dist/core'; -import Oas from 'oas'; -import APICore from 'api/dist/core'; -import definition from './openapi.json'; - -class SDK { - spec: Oas; - core: APICore; - - constructor() { - this.spec = Oas.init(definition); - this.core = new APICore(this.spec, 'developers/4.465.0 (api/6.1.1)'); - } - - /** - * Optionally configure various options that the SDK allows. - * - * @param config Object of supported SDK options and toggles. - * @param config.timeout Override the default `fetch` request timeout of 30 seconds. This number - * should be represented in milliseconds. - */ - config(config: ConfigOptions) { - this.core.setConfig(config); - } - - /** - * If the API you're using requires authentication you can supply the required credentials - * through this method and the library will magically determine how they should be used - * within your API request. - * - * With the exception of OpenID and MutualTLS, it supports all forms of authentication - * supported by the OpenAPI specification. - * - * @example HTTP Basic auth - * sdk.auth('username', 'password'); - * - * @example Bearer tokens (HTTP or OAuth 2) - * sdk.auth('myBearerToken'); - * - * @example API Keys - * sdk.auth('myApiKey'); - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#fixed-fields-22} - * @see {@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-22} - * @param values Your auth credentials for the API; can specify up to two strings or numbers. - */ - auth(...values: string[] | number[]) { - this.core.setAuth(...values); - return this; - } - - /** - * If the API you're using offers alternate server URLs, and server variables, you can tell - * the SDK which one to use with this method. To use it you can supply either one of the - * server URLs that are contained within the OpenAPI definition (along with any server - * variables), or you can pass it a fully qualified URL to use (that may or may not exist - * within the OpenAPI definition). - * - * @example Server URL with server variables - * sdk.server('https://{region}.api.example.com/{basePath}', { - * name: 'eu', - * basePath: 'v14', - * }); - * - * @example Fully qualified server URL - * sdk.server('https://eu.api.example.com/v14'); - * - * @param url Server URL - * @param variables An object of variables to replace into the server URL. - */ - server(url: string, variables = {}) { - this.core.setServer(url, variables); - } - - /** - * Get an API definition file that's been uploaded to ReadMe. - * - * @summary Retrieve an entry from the API Registry - * @throws FetchError<404, types.GetApiRegistryResponse404> The registry entry couldn't be found. - */ - getAPIRegistry(metadata: types.GetApiRegistryMetadataParam): Promise> { - return this.core.fetch('/api-registry/{uuid}', 'get', metadata); - } - - /** - * Get API specification metadata. - * - * @summary Get metadata - * @throws FetchError<400, types.GetApiSpecificationResponse400> No version was supplied. - * @throws FetchError<401, types.GetApiSpecificationResponse401> Unauthorized - * @throws FetchError<403, types.GetApiSpecificationResponse403> Unauthorized - * @throws FetchError<404, types.GetApiSpecificationResponse404> The version couldn't be found. - */ - getAPISpecification(metadata?: types.GetApiSpecificationMetadataParam): Promise> { - return this.core.fetch('/api-specification', 'get', metadata); - } - - /** - * Upload an API specification to ReadMe. Or, to use a newer solution see - * https://docs.readme.com/main/docs/rdme. - * - * @summary Upload specification - * @throws FetchError<400, types.UploadApiSpecificationResponse400> There was a validation error during upload. - * @throws FetchError<401, types.UploadApiSpecificationResponse401> Unauthorized - * @throws FetchError<403, types.UploadApiSpecificationResponse403> Unauthorized - * @throws FetchError<408, types.UploadApiSpecificationResponse408> The spec upload timed out. - */ - uploadAPISpecification(body: types.UploadApiSpecificationBodyParam, metadata?: types.UploadApiSpecificationMetadataParam): Promise> { - return this.core.fetch('/api-specification', 'post', body, metadata); - } - - /** - * Update an API specification in ReadMe. - * - * @summary Update specification - * @throws FetchError<400, types.UpdateApiSpecificationResponse400> There was a validation error during upload. - * @throws FetchError<401, types.UpdateApiSpecificationResponse401> Unauthorized - * @throws FetchError<403, types.UpdateApiSpecificationResponse403> Unauthorized - * @throws FetchError<408, types.UpdateApiSpecificationResponse408> The spec upload timed out. - */ - updateAPISpecification(body: types.UpdateApiSpecificationBodyParam, metadata: types.UpdateApiSpecificationMetadataParam): Promise> { - return this.core.fetch('/api-specification/{id}', 'put', body, metadata); - } - - /** - * Delete an API specification in ReadMe. - * - * @summary Delete specification - * @throws FetchError<400, types.DeleteApiSpecificationResponse400> The spec ID isn't valid. - * @throws FetchError<401, types.DeleteApiSpecificationResponse401> Unauthorized - * @throws FetchError<403, types.DeleteApiSpecificationResponse403> Unauthorized - * @throws FetchError<404, types.DeleteApiSpecificationResponse404> The spec couldn't be found. - */ - deleteAPISpecification(metadata: types.DeleteApiSpecificationMetadataParam): Promise> { - return this.core.fetch('/api-specification/{id}', 'delete', metadata); - } - - /** - * Returns all the roles we're hiring for at ReadMe! - * - * @summary Get open roles - */ - getOpenRoles(): Promise> { - return this.core.fetch('/apply', 'get'); - } - - /** - * This endpoint will let you apply to a job at ReadMe programatically, without having to - * go through our UI! - * - * @summary Submit your application! - */ - applyToReadMe(body: types.ApplyToReadMeBodyParam): Promise> { - return this.core.fetch('/apply', 'post', body); - } - - /** - * Returns all the categories for a specified version. - * - * @summary Get all categories - */ - getCategories(metadata?: types.GetCategoriesMetadataParam): Promise> { - return this.core.fetch('/categories', 'get', metadata); - } - - /** - * Create a new category inside of this project. - * - * @summary Create category - * @throws FetchError<400, types.CreateCategoryResponse400> The category couldn't be saved. - */ - createCategory(body: types.CreateCategoryBodyParam, metadata?: types.CreateCategoryMetadataParam): Promise> { - return this.core.fetch('/categories', 'post', body, metadata); - } - - /** - * Returns the category with this slug. - * - * @summary Get category - * @throws FetchError<404, types.GetCategoryResponse404> The category couldn't be found. - */ - getCategory(metadata: types.GetCategoryMetadataParam): Promise> { - return this.core.fetch('/categories/{slug}', 'get', metadata); - } - - /** - * Change the properties of a category. - * - * @summary Update category - * @throws FetchError<400, types.UpdateCategoryResponse400> The category couldn't be saved. - * @throws FetchError<404, types.UpdateCategoryResponse404> The category couldn't be found. - */ - updateCategory(body: types.UpdateCategoryBodyParam, metadata: types.UpdateCategoryMetadataParam): Promise> { - return this.core.fetch('/categories/{slug}', 'put', body, metadata); - } - - /** - * Delete the category with this slug. - * >⚠️Heads Up! - * > This will also delete all of the docs within this category. - * - * @summary Delete category - * @throws FetchError<404, types.DeleteCategoryResponse404> The category couldn't be found. - */ - deleteCategory(metadata: types.DeleteCategoryMetadataParam): Promise> { - return this.core.fetch('/categories/{slug}', 'delete', metadata); - } - - /** - * Returns the docs and children docs within this category. - * - * @summary Get docs for category - * @throws FetchError<404, types.GetCategoryDocsResponse404> The category couldn't be found. - */ - getCategoryDocs(metadata: types.GetCategoryDocsMetadataParam): Promise> { - return this.core.fetch('/categories/{slug}/docs', 'get', metadata); - } - - /** - * Returns a list of changelogs. - * - * @summary Get changelogs - */ - getChangelogs(metadata?: types.GetChangelogsMetadataParam): Promise> { - return this.core.fetch('/changelogs', 'get', metadata); - } - - /** - * Create a new changelog entry. - * - * @summary Create changelog - */ - createChangelog(body: types.CreateChangelogBodyParam): Promise> { - return this.core.fetch('/changelogs', 'post', body); - } - - /** - * Returns the changelog with this slug. - * - * @summary Get changelog - */ - getChangelog(metadata: types.GetChangelogMetadataParam): Promise> { - return this.core.fetch('/changelogs/{slug}', 'get', metadata); - } - - /** - * Update a changelog with this slug. - * - * @summary Update changelog - */ - updateChangelog(body: types.UpdateChangelogBodyParam, metadata: types.UpdateChangelogMetadataParam): Promise> { - return this.core.fetch('/changelogs/{slug}', 'put', body, metadata); - } - - /** - * Delete the changelog with this slug. - * - * @summary Delete changelog - */ - deleteChangelog(metadata: types.DeleteChangelogMetadataParam): Promise> { - return this.core.fetch('/changelogs/{slug}', 'delete', metadata); - } - - /** - * Returns a list of custom pages. - * - * @summary Get custom pages - * @throws FetchError<401, types.GetCustomPagesResponse401> Unauthorized - * @throws FetchError<403, types.GetCustomPagesResponse403> Unauthorized - */ - getCustomPages(metadata?: types.GetCustomPagesMetadataParam): Promise> { - return this.core.fetch('/custompages', 'get', metadata); - } - - /** - * Create a new custom page inside of this project. - * - * @summary Create custom page - * @throws FetchError<400, types.CreateCustomPageResponse400> The page couldn't be saved. - * @throws FetchError<401, types.CreateCustomPageResponse401> Unauthorized - * @throws FetchError<403, types.CreateCustomPageResponse403> Unauthorized - */ - createCustomPage(body: types.CreateCustomPageBodyParam): Promise> { - return this.core.fetch('/custompages', 'post', body); - } - - /** - * Returns the custom page with this slug. - * - * @summary Get custom page - * @throws FetchError<401, types.GetCustomPageResponse401> Unauthorized - * @throws FetchError<403, types.GetCustomPageResponse403> Unauthorized - * @throws FetchError<404, types.GetCustomPageResponse404> The custom page couldn't be found. - */ - getCustomPage(metadata: types.GetCustomPageMetadataParam): Promise> { - return this.core.fetch('/custompages/{slug}', 'get', metadata); - } - - /** - * Update a custom page with this slug. - * - * @summary Update custom page - * @throws FetchError<400, types.UpdateCustomPageResponse400> The page couldn't be saved. - * @throws FetchError<401, types.UpdateCustomPageResponse401> Unauthorized - * @throws FetchError<403, types.UpdateCustomPageResponse403> Unauthorized - * @throws FetchError<404, types.UpdateCustomPageResponse404> The custom page couldn't be found. - */ - updateCustomPage(body: types.UpdateCustomPageBodyParam, metadata: types.UpdateCustomPageMetadataParam): Promise> { - return this.core.fetch('/custompages/{slug}', 'put', body, metadata); - } - - /** - * Delete the custom page with this slug. - * - * @summary Delete custom page - * @throws FetchError<401, types.DeleteCustomPageResponse401> Unauthorized - * @throws FetchError<403, types.DeleteCustomPageResponse403> Unauthorized - * @throws FetchError<404, types.DeleteCustomPageResponse404> The custom page couldn't be found. - */ - deleteCustomPage(metadata: types.DeleteCustomPageMetadataParam): Promise> { - return this.core.fetch('/custompages/{slug}', 'delete', metadata); - } - - /** - * Returns the doc with this slug. - * - * @summary Get doc - * @throws FetchError<401, types.GetDocResponse401> Unauthorized - * @throws FetchError<403, types.GetDocResponse403> Unauthorized - * @throws FetchError<404, types.GetDocResponse404> The doc couldn't be found. - */ - getDoc(metadata: types.GetDocMetadataParam): Promise> { - return this.core.fetch('/docs/{slug}', 'get', metadata); - } - - /** - * Update a doc with this slug. - * - * @summary Update doc - * @throws FetchError<400, types.UpdateDocResponse400> The doc couldn't be saved. - * @throws FetchError<401, types.UpdateDocResponse401> Unauthorized - * @throws FetchError<403, types.UpdateDocResponse403> Unauthorized - * @throws FetchError<404, types.UpdateDocResponse404> The doc couldn't be found. - */ - updateDoc(body: types.UpdateDocBodyParam, metadata: types.UpdateDocMetadataParam): Promise> { - return this.core.fetch('/docs/{slug}', 'put', body, metadata); - } - - /** - * Delete the doc with this slug. - * - * @summary Delete doc - * @throws FetchError<401, types.DeleteDocResponse401> Unauthorized - * @throws FetchError<403, types.DeleteDocResponse403> Unauthorized - * @throws FetchError<404, types.DeleteDocResponse404> The doc couldn't be found. - */ - deleteDoc(metadata: types.DeleteDocMetadataParam): Promise> { - return this.core.fetch('/docs/{slug}', 'delete', metadata); - } - - /** - * This is intended for use by enterprise users with staging enabled. This endpoint will - * return the live version of your document, whereas the standard endpoint will always - * return staging. - * - * @summary Get production doc - * @throws FetchError<401, types.GetProductionDocResponse401> Unauthorized - * @throws FetchError<403, types.GetProductionDocResponse403> Unauthorized - * @throws FetchError<404, types.GetProductionDocResponse404> The doc couldn't be found. - */ - getProductionDoc(metadata: types.GetProductionDocMetadataParam): Promise> { - return this.core.fetch('/docs/{slug}/production', 'get', metadata); - } - - /** - * Create a new doc inside of this project. - * - * @summary Create doc - * @throws FetchError<400, types.CreateDocResponse400> The doc couldn't be saved. - * @throws FetchError<401, types.CreateDocResponse401> Unauthorized - * @throws FetchError<403, types.CreateDocResponse403> Unauthorized - */ - createDoc(body: types.CreateDocBodyParam, metadata?: types.CreateDocMetadataParam): Promise> { - return this.core.fetch('/docs', 'post', body, metadata); - } - - /** - * Returns all docs that match the search. - * - * @summary Search docs - * @throws FetchError<401, types.SearchDocsResponse401> Unauthorized - * @throws FetchError<403, types.SearchDocsResponse403> Unauthorized - */ - searchDocs(metadata: types.SearchDocsMetadataParam): Promise> { - return this.core.fetch('/docs/search', 'post', metadata); - } - - /** - * Returns project data for the API key. - * - * @summary Get metadata about the current project - * @throws FetchError<401, types.GetProjectResponse401> Unauthorized - * @throws FetchError<403, types.GetProjectResponse403> Unauthorized - */ - getProject(): Promise> { - return this.core.fetch('/', 'get'); - } - - /** - * Returns a copy of our OpenAPI Definition. - * - * @summary Get our OpenAPI Definition - */ - getAPISchema(): Promise> { - return this.core.fetch('/schema', 'get'); - } - - /** - * Retrieve a list of versions associated with a project API key. - * - * @summary Get versions - * @throws FetchError<401, types.GetVersionsResponse401> Unauthorized - * @throws FetchError<403, types.GetVersionsResponse403> Unauthorized - */ - getVersions(): Promise> { - return this.core.fetch('/version', 'get'); - } - - /** - * Create a new version. - * - * @summary Create version - * @throws FetchError<400, types.CreateVersionResponse400> There was a validation error during creation. - * @throws FetchError<401, types.CreateVersionResponse401> Unauthorized - * @throws FetchError<403, types.CreateVersionResponse403> Unauthorized - * @throws FetchError<404, types.CreateVersionResponse404> The version couldn't be found. - */ - createVersion(body: types.CreateVersionBodyParam): Promise> { - return this.core.fetch('/version', 'post', body); - } - - /** - * Returns the version with this version ID. - * - * @summary Get version - * @throws FetchError<401, types.GetVersionResponse401> Unauthorized - * @throws FetchError<403, types.GetVersionResponse403> Unauthorized - * @throws FetchError<404, types.GetVersionResponse404> The version couldn't be found. - */ - getVersion(metadata: types.GetVersionMetadataParam): Promise> { - return this.core.fetch('/version/{versionId}', 'get', metadata); - } - - /** - * Update an existing version. - * - * @summary Update version - * @throws FetchError<400, types.UpdateVersionResponse400> A stable version can't be demoted. - * @throws FetchError<401, types.UpdateVersionResponse401> Unauthorized - * @throws FetchError<403, types.UpdateVersionResponse403> Unauthorized - * @throws FetchError<404, types.UpdateVersionResponse404> The version couldn't be found. - */ - updateVersion(body: types.UpdateVersionBodyParam, metadata: types.UpdateVersionMetadataParam): Promise> { - return this.core.fetch('/version/{versionId}', 'put', body, metadata); - } - - /** - * Delete a version - * - * @summary Delete version - * @throws FetchError<400, types.DeleteVersionResponse400> A stable version can't be removed. - * @throws FetchError<401, types.DeleteVersionResponse401> Unauthorized - * @throws FetchError<403, types.DeleteVersionResponse403> Unauthorized - * @throws FetchError<404, types.DeleteVersionResponse404> The version couldn't be found. - */ - deleteVersion(metadata: types.DeleteVersionMetadataParam): Promise> { - return this.core.fetch('/version/{versionId}', 'delete', metadata); - } -} - -const createSDK = (() => { return new SDK(); })() -; - -export default createSDK; - -export type { ApplyToReadMeBodyParam, CreateCategoryBodyParam, CreateCategoryMetadataParam, CreateCategoryResponse400, CreateChangelogBodyParam, CreateCustomPageBodyParam, CreateCustomPageResponse400, CreateCustomPageResponse401, CreateCustomPageResponse403, CreateDocBodyParam, CreateDocMetadataParam, CreateDocResponse201, CreateDocResponse400, CreateDocResponse401, CreateDocResponse403, CreateVersionBodyParam, CreateVersionResponse400, CreateVersionResponse401, CreateVersionResponse403, CreateVersionResponse404, DeleteApiSpecificationMetadataParam, DeleteApiSpecificationResponse400, DeleteApiSpecificationResponse401, DeleteApiSpecificationResponse403, DeleteApiSpecificationResponse404, DeleteCategoryMetadataParam, DeleteCategoryResponse404, DeleteChangelogMetadataParam, DeleteCustomPageMetadataParam, DeleteCustomPageResponse401, DeleteCustomPageResponse403, DeleteCustomPageResponse404, DeleteDocMetadataParam, DeleteDocResponse401, DeleteDocResponse403, DeleteDocResponse404, DeleteVersionMetadataParam, DeleteVersionResponse400, DeleteVersionResponse401, DeleteVersionResponse403, DeleteVersionResponse404, GetApiRegistryMetadataParam, GetApiRegistryResponse200, GetApiRegistryResponse404, GetApiSchemaResponse200, GetApiSpecificationMetadataParam, GetApiSpecificationResponse200, GetApiSpecificationResponse400, GetApiSpecificationResponse401, GetApiSpecificationResponse403, GetApiSpecificationResponse404, GetCategoriesMetadataParam, GetCategoriesResponse200, GetCategoryDocsMetadataParam, GetCategoryDocsResponse404, GetCategoryMetadataParam, GetCategoryResponse404, GetChangelogMetadataParam, GetChangelogsMetadataParam, GetChangelogsResponse200, GetCustomPageMetadataParam, GetCustomPageResponse401, GetCustomPageResponse403, GetCustomPageResponse404, GetCustomPagesMetadataParam, GetCustomPagesResponse200, GetCustomPagesResponse401, GetCustomPagesResponse403, GetDocMetadataParam, GetDocResponse200, GetDocResponse401, GetDocResponse403, GetDocResponse404, GetOpenRolesResponse200, GetProductionDocMetadataParam, GetProductionDocResponse200, GetProductionDocResponse401, GetProductionDocResponse403, GetProductionDocResponse404, GetProjectResponse200, GetProjectResponse401, GetProjectResponse403, GetVersionMetadataParam, GetVersionResponse401, GetVersionResponse403, GetVersionResponse404, GetVersionsResponse401, GetVersionsResponse403, SearchDocsMetadataParam, SearchDocsResponse401, SearchDocsResponse403, UpdateApiSpecificationBodyParam, UpdateApiSpecificationMetadataParam, UpdateApiSpecificationResponse400, UpdateApiSpecificationResponse401, UpdateApiSpecificationResponse403, UpdateApiSpecificationResponse408, UpdateCategoryBodyParam, UpdateCategoryMetadataParam, UpdateCategoryResponse400, UpdateCategoryResponse404, UpdateChangelogBodyParam, UpdateChangelogMetadataParam, UpdateCustomPageBodyParam, UpdateCustomPageMetadataParam, UpdateCustomPageResponse400, UpdateCustomPageResponse401, UpdateCustomPageResponse403, UpdateCustomPageResponse404, UpdateDocBodyParam, UpdateDocMetadataParam, UpdateDocResponse200, UpdateDocResponse400, UpdateDocResponse401, UpdateDocResponse403, UpdateDocResponse404, UpdateVersionBodyParam, UpdateVersionMetadataParam, UpdateVersionResponse400, UpdateVersionResponse401, UpdateVersionResponse403, UpdateVersionResponse404, UploadApiSpecificationBodyParam, UploadApiSpecificationMetadataParam, UploadApiSpecificationResponse400, UploadApiSpecificationResponse401, UploadApiSpecificationResponse403, UploadApiSpecificationResponse408 } from './types'; diff --git a/packages/node/src/.api/apis/developers/openapi.json b/packages/node/src/.api/apis/developers/openapi.json deleted file mode 100644 index 3931d1e93..000000000 --- a/packages/node/src/.api/apis/developers/openapi.json +++ /dev/null @@ -1,13624 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "description": "Create beautiful product and API documentation with our developer friendly platform.", - "version": "4.465.0", - "title": "ReadMe API 🦉", - "contact": { - "name": "API Support", - "url": "https://docs.readme.com/main/docs/need-more-support", - "email": "support@readme.io" - } - }, - "servers": [ - { - "url": "https://dash.readme.com/api/v1" - } - ], - "tags": [ - { - "name": "API Registry" - }, - { - "name": "API Specification" - }, - { - "name": "Apply to ReadMe" - }, - { - "name": "Categories" - }, - { - "name": "Changelog" - }, - { - "name": "Custom Pages" - }, - { - "name": "Docs" - }, - { - "name": "Errors" - }, - { - "name": "Projects" - }, - { - "name": "Version" - } - ], - "paths": { - "/api-registry/{uuid}": { - "get": { - "operationId": "getAPIRegistry", - "summary": "Retrieve an entry from the API Registry", - "description": "Get an API definition file that's been uploaded to ReadMe.", - "tags": [ - "API Registry" - ], - "parameters": [ - { - "name": "uuid", - "in": "path", - "description": "An API Registry UUID. This can be found by navigating to your API Reference page and viewing code snippets for Node with the `api` library.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "Successfully retrieved API registry entry.", - "content": { - "application/json": { - "schema": { - "type": "object" - } - } - } - }, - "404": { - "description": "The registry entry couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "REGISTRY_NOTFOUND" - } - } - } - ] - } - } - } - } - } - } - }, - "/api-specification": { - "get": { - "operationId": "getAPISpecification", - "summary": "Get metadata", - "description": "Get API specification metadata.", - "tags": [ - "API Specification" - ], - "parameters": [ - { - "name": "perPage", - "in": "query", - "description": "Number of items to include in pagination (up to 100, defaults to 10).", - "schema": { - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100 - } - }, - { - "name": "page", - "in": "query", - "description": "Used to specify further pages (starts at 1).", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - } - }, - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Successfully retrieved API specification metadata.", - "headers": { - "Link": { - "description": "Pagination information. See https://docs.readme.com/main/reference/pagination for more information.", - "schema": { - "type": "string" - } - }, - "x-total-count": { - "description": "The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination.", - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "No version was supplied.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_EMPTY" - } - } - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The version couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "post": { - "operationId": "uploadAPISpecification", - "summary": "Upload specification", - "description": "Upload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/main/docs/rdme.", - "tags": [ - "API Specification" - ], - "parameters": [ - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "spec": { - "description": "OpenAPI/Swagger file. We accept JSON or YAML.", - "type": "string", - "format": "binary" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "The API specification was successfully uploaded." - }, - "400": { - "description": "There was a validation error during upload.", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_FILE_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_INVALID" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_INVALID_SCHEMA" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_VERSION_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "408": { - "description": "The spec upload timed out.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_TIMEOUT" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/api-specification/{id}": { - "put": { - "operationId": "updateAPISpecification", - "summary": "Update specification", - "description": "Update an API specification in ReadMe.", - "tags": [ - "API Specification" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of the API specification. The unique ID for each API can be found by navigating to your **API Definitions** page.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "spec": { - "description": "OpenAPI/Swagger file. We accept JSON or YAML.", - "type": "string", - "format": "binary" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "The API specification was updated." - }, - "400": { - "description": "There was a validation error during upload.", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_FILE_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_ID_DUPLICATE" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_ID_INVALID" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_INVALID" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_INVALID_SCHEMA" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_VERSION_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "There is no API specification with that ID." - }, - "408": { - "description": "The spec upload timed out.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_TIMEOUT" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "delete": { - "operationId": "deleteAPISpecification", - "summary": "Delete specification", - "description": "Delete an API specification in ReadMe.", - "tags": [ - "API Specification" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of the API specification. The unique ID for each API can be found by navigating to your **API Definitions** page.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "204": { - "description": "The API specification was deleted." - }, - "400": { - "description": "The spec ID isn't valid.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_ID_INVALID" - } - } - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The spec couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/apply": { - "get": { - "operationId": "getOpenRoles", - "summary": "Get open roles", - "description": "Returns all the roles we're hiring for at ReadMe!", - "tags": [ - "Apply to ReadMe" - ], - "responses": { - "200": { - "description": "All the roles that we're hiring for.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "slug": { - "type": "string", - "description": "A slugified version of the job opening title.", - "example": "api-engineer" - }, - "title": { - "type": "string", - "description": "The job opening position.", - "example": "API Engineer" - }, - "description": { - "type": "string", - "description": "The description for this open position. This content is formatted as HTML." - }, - "pullquote": { - "type": "string", - "description": "A short pullquote for the open position.", - "example": "Deeply knowledgeable of the web, HTTP, and the API space." - }, - "location": { - "type": "string", - "description": "Where this position is located at.", - "example": "Remote" - }, - "department": { - "type": "string", - "description": "The internal organization you'll be working in.", - "example": "Engineering" - }, - "url": { - "type": "string", - "format": "url", - "description": "The place where you can apply for the position!" - } - } - } - } - } - } - } - } - }, - "post": { - "operationId": "applyToReadMe", - "summary": "Submit your application!", - "description": "This endpoint will let you apply to a job at ReadMe programatically, without having to go through our UI!", - "tags": [ - "Apply to ReadMe" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "Your full name", - "default": "Your Name" - }, - "email": { - "type": "string", - "format": "email", - "description": "A valid email we can reach you at.", - "default": "you@example.com" - }, - "job": { - "type": "string", - "description": "The job you're looking to apply for (https://readme.com/careers).", - "enum": [ - "Product Designer" - ], - "default": "Product Designer" - }, - "pronouns": { - "type": "string", - "description": "Learn more at https://lgbtlifecenter.org/pronouns/" - }, - "linkedin": { - "type": "string", - "format": "url", - "description": "What have you been up to the past few years?" - }, - "github": { - "type": "string", - "description": "Or Bitbucket, Gitlab or anywhere else your code is hosted!", - "format": "url" - }, - "coverLetter": { - "type": "string", - "format": "blob", - "description": "What should we know about you?" - }, - "dontReallyApply": { - "type": "boolean", - "description": "Want to play with the API but not actually apply? Set this to true.", - "default": false - } - }, - "required": [ - "name", - "email", - "job" - ] - } - } - } - }, - "responses": { - "200": { - "description": "You did it!" - } - } - } - }, - "/categories": { - "get": { - "operationId": "getCategories", - "summary": "Get all categories", - "description": "Returns all the categories for a specified version.", - "tags": [ - "Categories" - ], - "parameters": [ - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "perPage", - "in": "query", - "description": "Number of items to include in pagination (up to 100, defaults to 10).", - "schema": { - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100 - } - }, - { - "name": "page", - "in": "query", - "description": "Used to specify further pages (starts at 1).", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - } - } - ], - "responses": { - "200": { - "description": "The list of categories.", - "headers": { - "Link": { - "description": "Pagination information. See https://docs.readme.com/main/reference/pagination for more information.", - "schema": { - "type": "string" - } - }, - "x-total-count": { - "description": "The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination.", - "schema": { - "type": "string" - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "post": { - "operationId": "createCategory", - "summary": "Create category", - "description": "Create a new category inside of this project.", - "tags": [ - "Categories" - ], - "parameters": [ - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "A short title for the category. This is what will show in the sidebar." - }, - "type": { - "type": "string", - "enum": [ - "reference", - "guide" - ], - "default": "guide", - "description": "A category can be part of your reference or guide documentation, which is determined by this field." - } - } - }, - { - "required": [ - "title" - ] - } - ] - } - } - } - }, - "responses": { - "201": { - "description": "The category has successfully been created." - }, - "400": { - "description": "The category couldn't be saved.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CATEGORY_INVALID" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/categories/{slug}": { - "get": { - "operationId": "getCategory", - "summary": "Get category", - "description": "Returns the category with this slug.", - "tags": [ - "Categories" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".", - "example": "getting-started", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The category exists and has been returned." - }, - "404": { - "description": "The category couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CATEGORY_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "put": { - "operationId": "updateCategory", - "summary": "Update category", - "description": "Change the properties of a category.", - "tags": [ - "Categories" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".", - "example": "getting-started", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "A short title for the category. This is what will show in the sidebar." - }, - "type": { - "type": "string", - "enum": [ - "reference", - "guide" - ], - "default": "guide", - "description": "A category can be part of your reference or guide documentation, which is determined by this field." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "The category was successfully updated." - }, - "400": { - "description": "The category couldn't be saved.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CATEGORY_INVALID" - } - } - } - ] - } - } - } - }, - "404": { - "description": "The category couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CATEGORY_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "delete": { - "operationId": "deleteCategory", - "summary": "Delete category", - "description": "Delete the category with this slug.\n>⚠️Heads Up!\n> This will also delete all of the docs within this category.", - "tags": [ - "Categories" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".", - "example": "getting-started", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The category was deleted." - }, - "404": { - "description": "The category couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CATEGORY_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/categories/{slug}/docs": { - "get": { - "operationId": "getCategoryDocs", - "summary": "Get docs for category", - "description": "Returns the docs and children docs within this category.", - "tags": [ - "Categories" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\".", - "example": "getting-started", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The category exists and all of the docs have been returned." - }, - "404": { - "description": "The category couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CATEGORY_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/changelogs": { - "get": { - "operationId": "getChangelogs", - "summary": "Get changelogs", - "description": "Returns a list of changelogs.", - "tags": [ - "Changelog" - ], - "parameters": [ - { - "name": "perPage", - "in": "query", - "description": "Number of items to include in pagination (up to 100, defaults to 10).", - "schema": { - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100 - } - }, - { - "name": "page", - "in": "query", - "description": "Used to specify further pages (starts at 1).", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - } - } - ], - "responses": { - "200": { - "description": "The list of changelogs.", - "headers": { - "Link": { - "description": "Pagination information. See https://docs.readme.com/main/reference/pagination for more information.", - "schema": { - "type": "string" - } - }, - "x-total-count": { - "description": "The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination.", - "schema": { - "type": "string" - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "post": { - "operationId": "createChangelog", - "summary": "Create changelog", - "description": "Create a new changelog entry.", - "tags": [ - "Changelog" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the changelog." - }, - "type": { - "type": "string", - "default": "", - "enum": [ - "", - "added", - "fixed", - "improved", - "deprecated", - "removed" - ] - }, - "body": { - "type": "string", - "description": "Body content of the changelog." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the changelog.", - "default": true - } - }, - "required": [ - "title", - "body" - ] - } - } - } - }, - "responses": { - "201": { - "description": "The changelog was successfully created." - }, - "400": { - "description": "There was a validation error during creation." - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/changelogs/{slug}": { - "get": { - "operationId": "getChangelog", - "summary": "Get changelog", - "description": "Returns the changelog with this slug.", - "tags": [ - "Changelog" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Update\", enter the slug \"owlet-update\".", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The changelog exists and has been returned." - }, - "404": { - "description": "There is no changelog with that slug." - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "put": { - "operationId": "updateChangelog", - "summary": "Update changelog", - "description": "Update a changelog with this slug.", - "tags": [ - "Changelog" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Weekly Update\", enter the slug \"owlet-weekly-update\".", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the changelog." - }, - "type": { - "type": "string", - "default": "", - "enum": [ - "", - "added", - "fixed", - "improved", - "deprecated", - "removed" - ] - }, - "body": { - "type": "string", - "description": "Body content of the changelog." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the changelog.", - "default": true - } - }, - "required": [ - "title", - "body" - ] - } - } - } - }, - "responses": { - "200": { - "description": "The changelog was successfully updated." - }, - "400": { - "description": "There was a validation error during update." - }, - "404": { - "description": "There is no changelog with that slug." - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "delete": { - "operationId": "deleteChangelog", - "summary": "Delete changelog", - "description": "Delete the changelog with this slug.", - "tags": [ - "Changelog" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Weekly Update\", enter the slug \"owlet-weekly-update\".", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The changelog was successfully updated." - }, - "404": { - "description": "There is no changelog with that slug." - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/custompages": { - "get": { - "operationId": "getCustomPages", - "summary": "Get custom pages", - "description": "Returns a list of custom pages.", - "tags": [ - "Custom Pages" - ], - "parameters": [ - { - "name": "perPage", - "in": "query", - "description": "Number of items to include in pagination (up to 100, defaults to 10).", - "schema": { - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100 - } - }, - { - "name": "page", - "in": "query", - "description": "Used to specify further pages (starts at 1).", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - } - } - ], - "responses": { - "200": { - "description": "The list of custom pages.", - "headers": { - "Link": { - "description": "Pagination information. See https://docs.readme.com/main/reference/pagination for more information.", - "schema": { - "type": "string" - } - }, - "x-total-count": { - "description": "The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination.", - "schema": { - "type": "string" - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "post": { - "operationId": "createCustomPage", - "summary": "Create custom page", - "description": "Create a new custom page inside of this project.", - "tags": [ - "Custom Pages" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the custom page." - }, - "body": { - "type": "string", - "description": "Body formatted in Markdown (displayed by default)." - }, - "html": { - "type": "string", - "description": "Body formatted in HTML (sanitized, only displayed if `htmlmode` is **true**)." - }, - "htmlmode": { - "type": "boolean", - "description": "**true** if `html` should be displayed, **false** if `body` should be displayed.", - "default": false - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the custom page.", - "default": true - } - }, - "required": [ - "title" - ] - } - } - } - }, - "responses": { - "201": { - "description": "The custom page was successfully created." - }, - "400": { - "description": "The page couldn't be saved.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CUSTOMPAGE_INVALID" - } - } - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/custompages/{slug}": { - "get": { - "operationId": "getCustomPage", - "summary": "Get custom page", - "description": "Returns the custom page with this slug.", - "tags": [ - "Custom Pages" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\".", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The custom page exists and has been returned." - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The custom page couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CUSTOMPAGE_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "put": { - "operationId": "updateCustomPage", - "summary": "Update custom page", - "description": "Update a custom page with this slug.", - "tags": [ - "Custom Pages" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\".", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the custom page." - }, - "body": { - "type": "string", - "description": "Body formatted in Markdown (displayed by default)." - }, - "html": { - "type": "string", - "description": "Body formatted in HTML (sanitized, only displayed if `htmlmode` is **true**)." - }, - "htmlmode": { - "type": "boolean", - "description": "**true** if `html` should be displayed, **false** if `body` should be displayed.", - "default": false - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the custom page.", - "default": true - } - }, - "required": [ - "title" - ] - } - } - } - }, - "responses": { - "200": { - "description": "The custom page was successfully updated." - }, - "400": { - "description": "The page couldn't be saved.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CUSTOMPAGE_INVALID" - } - } - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The custom page couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CUSTOMPAGE_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "delete": { - "operationId": "deleteCustomPage", - "summary": "Delete custom page", - "description": "Delete the custom page with this slug.", - "tags": [ - "Custom Pages" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\".", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The custom page was successfully updated." - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The custom page couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CUSTOMPAGE_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/docs/{slug}": { - "get": { - "operationId": "getDoc", - "summary": "Get doc", - "description": "Returns the doc with this slug.", - "tags": [ - "Docs" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\".", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The doc exists and has been returned.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the page." - }, - "type": { - "type": "string", - "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).", - "enum": [ - "basic", - "error", - "link" - ] - }, - "body": { - "type": "string", - "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)." - }, - "category": { - "type": "string", - "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the page." - }, - "order": { - "type": "integer", - "description": "The position of the page in your project sidebar.", - "example": 999 - }, - "parentDoc": { - "type": "string", - "description": "The parent doc's ID, if the page is a subpage." - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The error code for docs with the \"error\" type." - } - } - } - }, - "additionalProperties": true - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The doc couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "DOC_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "put": { - "operationId": "updateDoc", - "summary": "Update doc", - "description": "Update a doc with this slug.", - "tags": [ - "Docs" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\".", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the page." - }, - "type": { - "type": "string", - "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).", - "enum": [ - "basic", - "error", - "link" - ] - }, - "body": { - "type": "string", - "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)." - }, - "category": { - "type": "string", - "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the page." - }, - "order": { - "type": "integer", - "description": "The position of the page in your project sidebar.", - "example": 999 - }, - "parentDoc": { - "type": "string", - "description": "The parent doc's ID, if the page is a subpage." - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The error code for docs with the \"error\" type." - } - } - }, - "categorySlug": { - "type": "string", - "description": "The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field." - }, - "parentDocSlug": { - "type": "string", - "description": "If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field." - } - }, - "additionalProperties": true - } - } - } - }, - "responses": { - "200": { - "description": "The doc was successfully updated.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the page." - }, - "type": { - "type": "string", - "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).", - "enum": [ - "basic", - "error", - "link" - ] - }, - "body": { - "type": "string", - "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)." - }, - "category": { - "type": "string", - "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the page." - }, - "order": { - "type": "integer", - "description": "The position of the page in your project sidebar.", - "example": 999 - }, - "parentDoc": { - "type": "string", - "description": "The parent doc's ID, if the page is a subpage." - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The error code for docs with the \"error\" type." - } - } - } - }, - "additionalProperties": true - } - } - } - }, - "400": { - "description": "The doc couldn't be saved.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "DOC_INVALID" - } - } - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The doc couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "DOC_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "delete": { - "operationId": "deleteDoc", - "summary": "Delete doc", - "description": "Delete the doc with this slug.", - "tags": [ - "Docs" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\".", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The doc was successfully updated." - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The doc couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "DOC_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/docs/{slug}/production": { - "get": { - "operationId": "getProductionDoc", - "summary": "Get production doc", - "description": "This is intended for use by enterprise users with staging enabled. This endpoint will return the live version of your document, whereas the standard endpoint will always return staging.", - "tags": [ - "Docs" - ], - "parameters": [ - { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\".", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The doc exists and has been returned.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the page." - }, - "type": { - "type": "string", - "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).", - "enum": [ - "basic", - "error", - "link" - ] - }, - "body": { - "type": "string", - "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)." - }, - "category": { - "type": "string", - "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the page." - }, - "order": { - "type": "integer", - "description": "The position of the page in your project sidebar.", - "example": 999 - }, - "parentDoc": { - "type": "string", - "description": "The parent doc's ID, if the page is a subpage." - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The error code for docs with the \"error\" type." - } - } - } - }, - "additionalProperties": true - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The doc couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "DOC_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/docs": { - "post": { - "operationId": "createDoc", - "summary": "Create doc", - "description": "Create a new doc inside of this project.", - "tags": [ - "Docs" - ], - "parameters": [ - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the page." - }, - "type": { - "type": "string", - "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).", - "enum": [ - "basic", - "error", - "link" - ] - }, - "body": { - "type": "string", - "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)." - }, - "category": { - "type": "string", - "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the page." - }, - "order": { - "type": "integer", - "description": "The position of the page in your project sidebar.", - "example": 999 - }, - "parentDoc": { - "type": "string", - "description": "The parent doc's ID, if the page is a subpage." - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The error code for docs with the \"error\" type." - } - } - }, - "categorySlug": { - "type": "string", - "description": "The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field." - }, - "parentDocSlug": { - "type": "string", - "description": "If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field." - } - }, - "oneOf": [ - { - "required": [ - "title", - "category" - ], - "title": "`category` Parameter" - }, - { - "required": [ - "title", - "categorySlug" - ], - "title": "`categorySlug` Parameter" - } - ], - "additionalProperties": true - } - } - } - }, - "responses": { - "201": { - "description": "The doc was successfully created.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the page." - }, - "type": { - "type": "string", - "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).", - "enum": [ - "basic", - "error", - "link" - ] - }, - "body": { - "type": "string", - "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)." - }, - "category": { - "type": "string", - "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the page." - }, - "order": { - "type": "integer", - "description": "The position of the page in your project sidebar.", - "example": 999 - }, - "parentDoc": { - "type": "string", - "description": "The parent doc's ID, if the page is a subpage." - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The error code for docs with the \"error\" type." - } - } - } - }, - "additionalProperties": true - } - } - } - }, - "400": { - "description": "The doc couldn't be saved.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "DOC_INVALID" - } - } - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/docs/search": { - "post": { - "operationId": "searchDocs", - "summary": "Search docs", - "description": "Returns all docs that match the search.", - "tags": [ - "Docs" - ], - "parameters": [ - { - "name": "search", - "in": "query", - "description": "Search string to look for.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The search was successful and results were returned." - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/": { - "get": { - "operationId": "getProject", - "summary": "Get metadata about the current project", - "description": "Returns project data for the API key.", - "tags": [ - "Projects" - ], - "responses": { - "200": { - "description": "Project data", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "subdomain": { - "type": "string" - }, - "jwtSecret": { - "type": "string" - }, - "baseUrl": { - "type": "string", - "format": "url", - "description": "The base URL for the project. If the project is not running under a custom domain, it will be `https://projectSubdomain.readme.io`, otherwise it can either be or `https://example.com` or, in the case of an enterprise child project `https://example.com/projectSubdomain`." - }, - "plan": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/schema": { - "get": { - "operationId": "getAPISchema", - "summary": "Get our OpenAPI Definition", - "description": "Returns a copy of our OpenAPI Definition.", - "tags": [ - "API Specification" - ], - "responses": { - "200": { - "description": "OpenAPI Definition data", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": true - } - } - } - } - } - } - }, - "/version": { - "get": { - "operationId": "getVersions", - "summary": "Get versions", - "description": "Retrieve a list of versions associated with a project API key.", - "tags": [ - "Version" - ], - "responses": { - "200": { - "description": "A list of versions." - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "post": { - "operationId": "createVersion", - "summary": "Create version", - "description": "Create a new version.", - "tags": [ - "Version" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "Semantic Version" - }, - "codename": { - "type": "string", - "description": "Dubbed name of version." - }, - "from": { - "type": "string", - "description": "Semantic Version to use as the base fork." - }, - "is_stable": { - "type": "boolean", - "description": "Should this be the **main** version?" - }, - "is_beta": { - "type": "boolean", - "default": true - }, - "is_hidden": { - "type": "boolean", - "description": "Should this be publically accessible?" - }, - "is_deprecated": { - "type": "boolean", - "description": "Should this be deprecated? Only allowed in PUT operations." - } - }, - "required": [ - "version", - "from" - ] - } - } - } - }, - "responses": { - "200": { - "description": "The version was successfully created." - }, - "400": { - "description": "There was a validation error during creation.", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_DUPLICATE" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_FORK_EMPTY" - } - } - } - ] - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The version couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_FORK_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - }, - "/version/{versionId}": { - "get": { - "operationId": "getVersion", - "summary": "Get version", - "description": "Returns the version with this version ID.", - "tags": [ - "Version" - ], - "parameters": [ - { - "name": "versionId", - "in": "path", - "description": "Semver identifier for the project version. For best results, use the formatted `version_clean` value listed in the response from the [Get Versions endpoint](/reference/getversions).", - "example": "v1.0.0", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The version exists and has been returned." - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The version couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "put": { - "operationId": "updateVersion", - "summary": "Update version", - "description": "Update an existing version.", - "tags": [ - "Version" - ], - "parameters": [ - { - "name": "versionId", - "in": "path", - "description": "Semver identifier for the project version. For best results, use the formatted `version_clean` value listed in the response from the [Get Versions endpoint](/reference/getversions).", - "example": "v1.0.0", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "Semantic Version" - }, - "codename": { - "type": "string", - "description": "Dubbed name of version." - }, - "from": { - "type": "string", - "description": "Semantic Version to use as the base fork." - }, - "is_stable": { - "type": "boolean", - "description": "Should this be the **main** version?" - }, - "is_beta": { - "type": "boolean", - "default": true - }, - "is_hidden": { - "type": "boolean", - "description": "Should this be publically accessible?" - }, - "is_deprecated": { - "type": "boolean", - "description": "Should this be deprecated? Only allowed in PUT operations." - } - }, - "required": [ - "version", - "from" - ] - } - } - } - }, - "responses": { - "200": { - "description": "The version was successfully updated." - }, - "400": { - "description": "A stable version can't be demoted.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_CANT_DEMOTE_STABLE" - } - } - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The version couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - }, - "delete": { - "operationId": "deleteVersion", - "summary": "Delete version", - "description": "Delete a version", - "tags": [ - "Version" - ], - "parameters": [ - { - "name": "versionId", - "in": "path", - "description": "Semver identifier for the project version. For best results, use the formatted `version_clean` value listed in the response from the [Get Versions endpoint](/reference/getversions).", - "example": "v1.0.0", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The version was successfully deleted." - }, - "400": { - "description": "A stable version can't be removed.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_CANT_REMOVE_STABLE" - } - } - } - ] - } - } - } - }, - "401": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "403": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "404": { - "description": "The version couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "security": [ - { - "apiKey": [] - } - ] - } - } - }, - "components": { - "securitySchemes": { - "apiKey": { - "type": "http", - "scheme": "basic" - } - }, - "headers": { - "link": { - "description": "Pagination information. See https://docs.readme.com/main/reference/pagination for more information.", - "schema": { - "type": "string" - } - }, - "x-total-count": { - "description": "The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination.", - "schema": { - "type": "string" - } - } - }, - "parameters": { - "slug": { - "name": "slug", - "in": "path", - "description": "A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\".", - "required": true, - "schema": { - "type": "string" - } - }, - "page": { - "name": "page", - "in": "query", - "description": "Used to specify further pages (starts at 1).", - "schema": { - "type": "integer", - "default": 1, - "minimum": 1 - } - }, - "perPage": { - "name": "perPage", - "in": "query", - "description": "Number of items to include in pagination (up to 100, defaults to 10).", - "schema": { - "type": "integer", - "default": 10, - "minimum": 1, - "maximum": 100 - } - }, - "x-readme-version": { - "in": "header", - "name": "x-readme-version", - "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions.", - "example": "v3.0", - "required": false, - "schema": { - "type": "string" - } - }, - "versionId": { - "name": "versionId", - "in": "path", - "description": "Semver identifier for the project version. For best results, use the formatted `version_clean` value listed in the response from the [Get Versions endpoint](/reference/getversions).", - "example": "v1.0.0", - "required": true, - "schema": { - "type": "string" - } - } - }, - "responses": { - "authForbidden": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - ] - } - } - } - }, - "authUnauthorized": { - "description": "Unauthorized", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - ] - } - } - } - }, - "error_APIKEY_EMPTY": { - "description": "An API key was not supplied.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - } - } - } - }, - "error_APIKEY_MISMATCH": { - "description": "The API key doesn't match the project.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - } - } - } - }, - "error_APIKEY_NOTFOUND": { - "description": "The API key couldn't be located.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_APPLY_INVALID_EMAIL": { - "description": "You need to provide a valid email.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APPLY_INVALID_EMAIL" - } - } - } - ] - } - } - } - }, - "error_APPLY_INVALID_JOB": { - "description": "You need to provide a job.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APPLY_INVALID_JOB" - } - } - } - ] - } - } - } - }, - "error_APPLY_INVALID_NAME": { - "description": "You need to provide a name.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APPLY_INVALID_NAME" - } - } - } - ] - } - } - } - }, - "error_CATEGORY_INVALID": { - "description": "The category couldn't be saved.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CATEGORY_INVALID" - } - } - } - ] - } - } - } - }, - "error_CATEGORY_NOTFOUND": { - "description": "The category couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CATEGORY_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_CHANGELOG_INVALID": { - "description": "The changelog couldn't be saved.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CHANGELOG_INVALID" - } - } - } - ] - } - } - } - }, - "error_CHANGELOG_NOTFOUND": { - "description": "The changelog couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CHANGELOG_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_CUSTOMPAGE_INVALID": { - "description": "The page couldn't be saved.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CUSTOMPAGE_INVALID" - } - } - } - ] - } - } - } - }, - "error_CUSTOMPAGE_NOTFOUND": { - "description": "The custom page couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CUSTOMPAGE_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_DOC_INVALID": { - "description": "The doc couldn't be saved.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "DOC_INVALID" - } - } - } - ] - } - } - } - }, - "error_DOC_NOTFOUND": { - "description": "The doc couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "DOC_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_ENDPOINT_NOTFOUND": { - "description": "The endpoint doesn't exist.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "ENDPOINT_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_INTERNAL_ERROR": { - "description": "An unknown error has occurred.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "INTERNAL_ERROR" - } - } - } - ] - } - } - } - }, - "error_PROJECT_NEEDSSTAGING": { - "description": "The project does not have staging enabled.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "PROJECT_NEEDSSTAGING" - } - } - } - ] - } - } - } - }, - "error_PROJECT_NOTFOUND": { - "description": "The project couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "PROJECT_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_RATE_LIMITED": { - "description": "The request has been rate limited.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "RATE_LIMITED" - } - } - } - ] - } - } - } - }, - "error_REGISTRY_INVALID": { - "description": "The registry entry couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "REGISTRY_INVALID" - } - } - } - ] - } - } - } - }, - "error_REGISTRY_NOTFOUND": { - "description": "The registry entry couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "REGISTRY_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_SPEC_FILE_EMPTY": { - "description": "A spec file wasn't included.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_FILE_EMPTY" - } - } - } - ] - } - } - } - }, - "error_SPEC_ID_DUPLICATE": { - "description": "The spec ID already tied to another version.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_ID_DUPLICATE" - } - } - } - ] - } - } - } - }, - "error_SPEC_ID_INVALID": { - "description": "The spec ID isn't valid.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_ID_INVALID" - } - } - } - ] - } - } - } - }, - "error_SPEC_INVALID": { - "description": "The uploaded spec isn't valid JSON or YAML.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_INVALID" - } - } - } - ] - } - } - } - }, - "error_SPEC_INVALID_SCHEMA": { - "description": "The uploaded spec has OpenAPI validation errors.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_INVALID_SCHEMA" - } - } - } - ] - } - } - } - }, - "error_SPEC_NOTFOUND": { - "description": "The spec couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_SPEC_TIMEOUT": { - "description": "The spec upload timed out.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_TIMEOUT" - } - } - } - ] - } - } - } - }, - "error_SPEC_VERSION_NOTFOUND": { - "description": "The spec version couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_VERSION_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_UNEXPECTED_ERROR": { - "description": "An unknown error has occurred.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "UNEXPECTED_ERROR" - } - } - } - ] - } - } - } - }, - "error_VERSION_CANT_DEMOTE_STABLE": { - "description": "A stable version can't be demoted.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_CANT_DEMOTE_STABLE" - } - } - } - ] - } - } - } - }, - "error_VERSION_CANT_REMOVE_STABLE": { - "description": "A stable version can't be removed.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_CANT_REMOVE_STABLE" - } - } - } - ] - } - } - } - }, - "error_VERSION_DUPLICATE": { - "description": "The version already exists.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_DUPLICATE" - } - } - } - ] - } - } - } - }, - "error_VERSION_EMPTY": { - "description": "No version was supplied.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_EMPTY" - } - } - } - ] - } - } - } - }, - "error_VERSION_FORK_EMPTY": { - "description": "New versions need to be forked from an existing version.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_FORK_EMPTY" - } - } - } - ] - } - } - } - }, - "error_VERSION_FORK_NOTFOUND": { - "description": "The version couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_FORK_NOTFOUND" - } - } - } - ] - } - } - } - }, - "error_VERSION_INVALID": { - "description": "The version is invalid.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_INVALID" - } - } - } - ] - } - } - } - }, - "error_VERSION_NOTFOUND": { - "description": "The version couldn't be found.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_NOTFOUND" - } - } - } - ] - } - } - } - } - }, - "schemas": { - "baseError": { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - "apply": { - "type": "object", - "properties": { - "name": { - "type": "string", - "minLength": 1, - "description": "Your full name", - "default": "Your Name" - }, - "email": { - "type": "string", - "format": "email", - "description": "A valid email we can reach you at.", - "default": "you@example.com" - }, - "job": { - "type": "string", - "description": "The job you're looking to apply for (https://readme.com/careers).", - "enum": [ - "Product Designer" - ], - "default": "Product Designer" - }, - "pronouns": { - "type": "string", - "description": "Learn more at https://lgbtlifecenter.org/pronouns/" - }, - "linkedin": { - "type": "string", - "format": "url", - "description": "What have you been up to the past few years?" - }, - "github": { - "type": "string", - "description": "Or Bitbucket, Gitlab or anywhere else your code is hosted!", - "format": "url" - }, - "coverLetter": { - "type": "string", - "format": "blob", - "description": "What should we know about you?" - }, - "dontReallyApply": { - "type": "boolean", - "description": "Want to play with the API but not actually apply? Set this to true.", - "default": false - } - }, - "required": [ - "name", - "email", - "job" - ] - }, - "category": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "A short title for the category. This is what will show in the sidebar." - }, - "type": { - "type": "string", - "enum": [ - "reference", - "guide" - ], - "default": "guide", - "description": "A category can be part of your reference or guide documentation, which is determined by this field." - } - } - }, - "changelog": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the changelog." - }, - "type": { - "type": "string", - "default": "", - "enum": [ - "", - "added", - "fixed", - "improved", - "deprecated", - "removed" - ] - }, - "body": { - "type": "string", - "description": "Body content of the changelog." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the changelog.", - "default": true - } - }, - "required": [ - "title", - "body" - ] - }, - "condensedProjectData": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "subdomain": { - "type": "string" - }, - "jwtSecret": { - "type": "string" - }, - "baseUrl": { - "type": "string", - "format": "url", - "description": "The base URL for the project. If the project is not running under a custom domain, it will be `https://projectSubdomain.readme.io`, otherwise it can either be or `https://example.com` or, in the case of an enterprise child project `https://example.com/projectSubdomain`." - }, - "plan": { - "type": "string" - } - } - }, - "customPage": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the custom page." - }, - "body": { - "type": "string", - "description": "Body formatted in Markdown (displayed by default)." - }, - "html": { - "type": "string", - "description": "Body formatted in HTML (sanitized, only displayed if `htmlmode` is **true**)." - }, - "htmlmode": { - "type": "boolean", - "description": "**true** if `html` should be displayed, **false** if `body` should be displayed.", - "default": false - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the custom page.", - "default": true - } - }, - "required": [ - "title" - ] - }, - "docSchemaPost": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the page." - }, - "type": { - "type": "string", - "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).", - "enum": [ - "basic", - "error", - "link" - ] - }, - "body": { - "type": "string", - "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)." - }, - "category": { - "type": "string", - "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the page." - }, - "order": { - "type": "integer", - "description": "The position of the page in your project sidebar.", - "example": 999 - }, - "parentDoc": { - "type": "string", - "description": "The parent doc's ID, if the page is a subpage." - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The error code for docs with the \"error\" type." - } - } - }, - "categorySlug": { - "type": "string", - "description": "The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field." - }, - "parentDocSlug": { - "type": "string", - "description": "If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field." - } - }, - "oneOf": [ - { - "required": [ - "title", - "category" - ], - "title": "`category` Parameter" - }, - { - "required": [ - "title", - "categorySlug" - ], - "title": "`categorySlug` Parameter" - } - ], - "additionalProperties": true - }, - "docSchemaPut": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the page." - }, - "type": { - "type": "string", - "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).", - "enum": [ - "basic", - "error", - "link" - ] - }, - "body": { - "type": "string", - "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)." - }, - "category": { - "type": "string", - "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the page." - }, - "order": { - "type": "integer", - "description": "The position of the page in your project sidebar.", - "example": 999 - }, - "parentDoc": { - "type": "string", - "description": "The parent doc's ID, if the page is a subpage." - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The error code for docs with the \"error\" type." - } - } - }, - "categorySlug": { - "type": "string", - "description": "The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field." - }, - "parentDocSlug": { - "type": "string", - "description": "If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field." - } - }, - "additionalProperties": true - }, - "docSchemaResponse": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "Title of the page." - }, - "type": { - "type": "string", - "description": "Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).", - "enum": [ - "basic", - "error", - "link" - ] - }, - "body": { - "type": "string", - "description": "Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)." - }, - "category": { - "type": "string", - "description": "Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)." - }, - "hidden": { - "type": "boolean", - "description": "Visibility of the page." - }, - "order": { - "type": "integer", - "description": "The position of the page in your project sidebar.", - "example": 999 - }, - "parentDoc": { - "type": "string", - "description": "The parent doc's ID, if the page is a subpage." - }, - "error": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "The error code for docs with the \"error\" type." - } - } - } - }, - "additionalProperties": true - }, - "version": { - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "Semantic Version" - }, - "codename": { - "type": "string", - "description": "Dubbed name of version." - }, - "from": { - "type": "string", - "description": "Semantic Version to use as the base fork." - }, - "is_stable": { - "type": "boolean", - "description": "Should this be the **main** version?" - }, - "is_beta": { - "type": "boolean", - "default": true - }, - "is_hidden": { - "type": "boolean", - "description": "Should this be publically accessible?" - }, - "is_deprecated": { - "type": "boolean", - "description": "Should this be deprecated? Only allowed in PUT operations." - } - }, - "required": [ - "version", - "from" - ] - }, - "jobOpening": { - "type": "object", - "properties": { - "slug": { - "type": "string", - "description": "A slugified version of the job opening title.", - "example": "api-engineer" - }, - "title": { - "type": "string", - "description": "The job opening position.", - "example": "API Engineer" - }, - "description": { - "type": "string", - "description": "The description for this open position. This content is formatted as HTML." - }, - "pullquote": { - "type": "string", - "description": "A short pullquote for the open position.", - "example": "Deeply knowledgeable of the web, HTTP, and the API space." - }, - "location": { - "type": "string", - "description": "Where this position is located at.", - "example": "Remote" - }, - "department": { - "type": "string", - "description": "The internal organization you'll be working in.", - "example": "Engineering" - }, - "url": { - "type": "string", - "format": "url", - "description": "The place where you can apply for the position!" - } - } - }, - "error_APIKEY_EMPTY": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_EMPTY" - } - } - } - ] - }, - "error_APIKEY_MISMATCH": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_MISMATCH" - } - } - } - ] - }, - "error_APIKEY_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APIKEY_NOTFOUND" - } - } - } - ] - }, - "error_APPLY_INVALID_EMAIL": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APPLY_INVALID_EMAIL" - } - } - } - ] - }, - "error_APPLY_INVALID_JOB": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APPLY_INVALID_JOB" - } - } - } - ] - }, - "error_APPLY_INVALID_NAME": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "APPLY_INVALID_NAME" - } - } - } - ] - }, - "error_CATEGORY_INVALID": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CATEGORY_INVALID" - } - } - } - ] - }, - "error_CATEGORY_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CATEGORY_NOTFOUND" - } - } - } - ] - }, - "error_CHANGELOG_INVALID": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CHANGELOG_INVALID" - } - } - } - ] - }, - "error_CHANGELOG_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CHANGELOG_NOTFOUND" - } - } - } - ] - }, - "error_CUSTOMPAGE_INVALID": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CUSTOMPAGE_INVALID" - } - } - } - ] - }, - "error_CUSTOMPAGE_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "CUSTOMPAGE_NOTFOUND" - } - } - } - ] - }, - "error_DOC_INVALID": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "DOC_INVALID" - } - } - } - ] - }, - "error_DOC_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "DOC_NOTFOUND" - } - } - } - ] - }, - "error_ENDPOINT_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "ENDPOINT_NOTFOUND" - } - } - } - ] - }, - "error_INTERNAL_ERROR": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "INTERNAL_ERROR" - } - } - } - ] - }, - "error_PROJECT_NEEDSSTAGING": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "PROJECT_NEEDSSTAGING" - } - } - } - ] - }, - "error_PROJECT_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "PROJECT_NOTFOUND" - } - } - } - ] - }, - "error_RATE_LIMITED": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "RATE_LIMITED" - } - } - } - ] - }, - "error_REGISTRY_INVALID": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "REGISTRY_INVALID" - } - } - } - ] - }, - "error_REGISTRY_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "REGISTRY_NOTFOUND" - } - } - } - ] - }, - "error_SPEC_FILE_EMPTY": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_FILE_EMPTY" - } - } - } - ] - }, - "error_SPEC_ID_DUPLICATE": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_ID_DUPLICATE" - } - } - } - ] - }, - "error_SPEC_ID_INVALID": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_ID_INVALID" - } - } - } - ] - }, - "error_SPEC_INVALID": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_INVALID" - } - } - } - ] - }, - "error_SPEC_INVALID_SCHEMA": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_INVALID_SCHEMA" - } - } - } - ] - }, - "error_SPEC_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_NOTFOUND" - } - } - } - ] - }, - "error_SPEC_TIMEOUT": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_TIMEOUT" - } - } - } - ] - }, - "error_SPEC_VERSION_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "SPEC_VERSION_NOTFOUND" - } - } - } - ] - }, - "error_UNEXPECTED_ERROR": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "UNEXPECTED_ERROR" - } - } - } - ] - }, - "error_VERSION_CANT_DEMOTE_STABLE": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_CANT_DEMOTE_STABLE" - } - } - } - ] - }, - "error_VERSION_CANT_REMOVE_STABLE": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_CANT_REMOVE_STABLE" - } - } - } - ] - }, - "error_VERSION_DUPLICATE": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_DUPLICATE" - } - } - } - ] - }, - "error_VERSION_EMPTY": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_EMPTY" - } - } - } - ] - }, - "error_VERSION_FORK_EMPTY": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_FORK_EMPTY" - } - } - } - ] - }, - "error_VERSION_FORK_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_FORK_NOTFOUND" - } - } - } - ] - }, - "error_VERSION_INVALID": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_INVALID" - } - } - } - ] - }, - "error_VERSION_NOTFOUND": { - "allOf": [ - { - "type": "object", - "properties": { - "error": { - "type": "string", - "description": "An error code unique to the error received." - }, - "message": { - "type": "string", - "description": "The reason why the error occured." - }, - "suggestion": { - "type": "string", - "description": "A helpful suggestion for how to alleviate the error." - }, - "docs": { - "type": "string", - "format": "url", - "description": "A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.", - "example": "https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f" - }, - "help": { - "type": "string", - "description": "Information on where you can receive additional assistance from our wonderful support team.", - "example": "If you need help, email support@readme.io" - }, - "poem": { - "type": "array", - "description": "A short poem we wrote you about your error.", - "items": { - "type": "string" - }, - "example": [ - "If you're seeing this error,", - "Things didn't quite go the way we hoped.", - "When we tried to process your request,", - "Maybe trying again it'll work—who knows!" - ] - } - } - }, - { - "type": "object", - "properties": { - "error": { - "type": "string", - "default": "VERSION_NOTFOUND" - } - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/packages/node/src/.api/apis/developers/schemas.ts b/packages/node/src/.api/apis/developers/schemas.ts deleted file mode 100644 index b8a53852a..000000000 --- a/packages/node/src/.api/apis/developers/schemas.ts +++ /dev/null @@ -1,73 +0,0 @@ -const ApplyToReadMe = {"body":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Your full name","default":"Your Name"},"email":{"type":"string","format":"email","description":"A valid email we can reach you at.","default":"you@example.com"},"job":{"type":"string","description":"The job you're looking to apply for (https://readme.com/careers).\n\nDefault: `Product Designer`","enum":["Product Designer"],"default":"Product Designer"},"pronouns":{"type":"string","description":"Learn more at https://lgbtlifecenter.org/pronouns/"},"linkedin":{"type":"string","format":"url","description":"What have you been up to the past few years?"},"github":{"type":"string","description":"Or Bitbucket, Gitlab or anywhere else your code is hosted!","format":"url"},"coverLetter":{"type":"string","format":"blob","description":"What should we know about you?"},"dontReallyApply":{"type":"boolean","description":"Want to play with the API but not actually apply? Set this to true.","default":false}},"required":["name","email","job"],"$schema":"http://json-schema.org/draft-04/schema#"}} as const -; -const CreateCategory = {"body":{"type":"object","required":["title"],"properties":{"title":{"type":"string","description":"A short title for the category. This is what will show in the sidebar."},"type":{"type":"string","enum":["reference","guide"],"default":"guide","description":"A category can be part of your reference or guide documentation, which is determined by this field.\n\nDefault: `guide`"}},"$schema":"http://json-schema.org/draft-04/schema#"},"metadata":{"allOf":[{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"400":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CATEGORY_INVALID"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const CreateChangelog = {"body":{"type":"object","properties":{"title":{"type":"string","description":"Title of the changelog."},"type":{"type":"string","enum":["","added","fixed","improved","deprecated","removed"],"description":"Default: "},"body":{"type":"string","description":"Body content of the changelog."},"hidden":{"type":"boolean","description":"Visibility of the changelog.","default":true}},"required":["title","body"],"$schema":"http://json-schema.org/draft-04/schema#"}} as const -; -const CreateCustomPage = {"body":{"type":"object","properties":{"title":{"type":"string","description":"Title of the custom page."},"body":{"type":"string","description":"Body formatted in Markdown (displayed by default)."},"html":{"type":"string","description":"Body formatted in HTML (sanitized, only displayed if `htmlmode` is **true**)."},"htmlmode":{"type":"boolean","description":"**true** if `html` should be displayed, **false** if `body` should be displayed.","default":false},"hidden":{"type":"boolean","description":"Visibility of the custom page.","default":true}},"required":["title"],"$schema":"http://json-schema.org/draft-04/schema#"},"response":{"400":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CUSTOMPAGE_INVALID"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const CreateDoc = {"body":{"type":"object","oneOf":[{"required":["title","category"],"title":"`category` Parameter","properties":{"title":{"type":"string","description":"Title of the page."},"type":{"type":"string","description":"Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).","enum":["basic","error","link"]},"body":{"type":"string","description":"Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."},"category":{"type":"string","description":"Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."},"hidden":{"type":"boolean","description":"Visibility of the page."},"order":{"type":"integer","description":"The position of the page in your project sidebar.","examples":[999]},"parentDoc":{"type":"string","description":"The parent doc's ID, if the page is a subpage."},"error":{"type":"object","properties":{"code":{"type":"string","description":"The error code for docs with the \"error\" type."}}},"categorySlug":{"type":"string","description":"The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field."},"parentDocSlug":{"type":"string","description":"If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field."}},"type":"object"},{"required":["title","categorySlug"],"title":"`categorySlug` Parameter","properties":{"title":{"type":"string","description":"Title of the page."},"type":{"type":"string","description":"Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).","enum":["basic","error","link"]},"body":{"type":"string","description":"Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."},"category":{"type":"string","description":"Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."},"hidden":{"type":"boolean","description":"Visibility of the page."},"order":{"type":"integer","description":"The position of the page in your project sidebar.","examples":[999]},"parentDoc":{"type":"string","description":"The parent doc's ID, if the page is a subpage."},"error":{"type":"object","properties":{"code":{"type":"string","description":"The error code for docs with the \"error\" type."}}},"categorySlug":{"type":"string","description":"The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field."},"parentDocSlug":{"type":"string","description":"If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field."}},"type":"object"}],"additionalProperties":true,"$schema":"http://json-schema.org/draft-04/schema#"},"metadata":{"allOf":[{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"201":{"type":"object","properties":{"title":{"type":"string","description":"Title of the page."},"type":{"type":"string","description":"Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).\n\n`basic` `error` `link`","enum":["basic","error","link"]},"body":{"type":"string","description":"Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."},"category":{"type":"string","description":"Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."},"hidden":{"type":"boolean","description":"Visibility of the page."},"order":{"type":"integer","description":"The position of the page in your project sidebar.","examples":[999]},"parentDoc":{"type":"string","description":"The parent doc's ID, if the page is a subpage."},"error":{"type":"object","properties":{"code":{"type":"string","description":"The error code for docs with the \"error\" type."}}}},"additionalProperties":true,"$schema":"http://json-schema.org/draft-04/schema#"},"400":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"DOC_INVALID"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const CreateVersion = {"body":{"type":"object","properties":{"version":{"type":"string","description":"Semantic Version"},"codename":{"type":"string","description":"Dubbed name of version."},"from":{"type":"string","description":"Semantic Version to use as the base fork."},"is_stable":{"type":"boolean","description":"Should this be the **main** version?"},"is_beta":{"type":"boolean","default":true},"is_hidden":{"type":"boolean","description":"Should this be publically accessible?"},"is_deprecated":{"type":"boolean","description":"Should this be deprecated? Only allowed in PUT operations."}},"required":["version","from"],"$schema":"http://json-schema.org/draft-04/schema#"},"response":{"400":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_DUPLICATE"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_FORK_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_FORK_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const DeleteApiSpecification = {"metadata":{"allOf":[{"type":"object","properties":{"id":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"ID of the API specification. The unique ID for each API can be found by navigating to your **API Definitions** page."}},"required":["id"]}]},"response":{"400":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_ID_INVALID"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const DeleteCategory = {"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","examples":["getting-started"],"$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CATEGORY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const DeleteChangelog = {"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Weekly Update\", enter the slug \"owlet-weekly-update\"."}},"required":["slug"]}]}} as const -; -const DeleteCustomPage = {"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]}]},"response":{"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CUSTOMPAGE_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const DeleteDoc = {"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"DOC_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const DeleteVersion = {"metadata":{"allOf":[{"type":"object","properties":{"versionId":{"type":"string","examples":["v1.0.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Semver identifier for the project version. For best results, use the formatted `version_clean` value listed in the response from the [Get Versions endpoint](/reference/getversions)."}},"required":["versionId"]}]},"response":{"400":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_CANT_REMOVE_STABLE"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetApiRegistry = {"metadata":{"allOf":[{"type":"object","properties":{"uuid":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"An API Registry UUID. This can be found by navigating to your API Reference page and viewing code snippets for Node with the `api` library."}},"required":["uuid"]}]},"response":{"200":{"type":"object","additionalProperties":true,"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"REGISTRY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetApiSchema = {"response":{"200":{"type":"object","additionalProperties":true,"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetApiSpecification = {"metadata":{"allOf":[{"type":"object","properties":{"perPage":{"type":"integer","default":10,"minimum":1,"maximum":100,"$schema":"http://json-schema.org/draft-04/schema#","description":"Number of items to include in pagination (up to 100, defaults to 10)."},"page":{"type":"integer","default":1,"minimum":1,"$schema":"http://json-schema.org/draft-04/schema#","description":"Used to specify further pages (starts at 1)."}},"required":[]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"200":{"type":"object","properties":{"Link":{"type":"string","description":"Pagination information. See https://docs.readme.com/main/reference/pagination for more information."},"x-total-count":{"type":"string","description":"The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination."}}},"400":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetCategories = {"metadata":{"allOf":[{"type":"object","properties":{"perPage":{"type":"integer","default":10,"minimum":1,"maximum":100,"$schema":"http://json-schema.org/draft-04/schema#","description":"Number of items to include in pagination (up to 100, defaults to 10)."},"page":{"type":"integer","default":1,"minimum":1,"$schema":"http://json-schema.org/draft-04/schema#","description":"Used to specify further pages (starts at 1)."}},"required":[]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"200":{"type":"object","properties":{"Link":{"type":"string","description":"Pagination information. See https://docs.readme.com/main/reference/pagination for more information."},"x-total-count":{"type":"string","description":"The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination."}}}}} as const -; -const GetCategory = {"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","examples":["getting-started"],"$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CATEGORY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetCategoryDocs = {"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","examples":["getting-started"],"$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CATEGORY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetChangelog = {"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Update\", enter the slug \"owlet-update\"."}},"required":["slug"]}]}} as const -; -const GetChangelogs = {"metadata":{"allOf":[{"type":"object","properties":{"perPage":{"type":"integer","default":10,"minimum":1,"maximum":100,"$schema":"http://json-schema.org/draft-04/schema#","description":"Number of items to include in pagination (up to 100, defaults to 10)."},"page":{"type":"integer","default":1,"minimum":1,"$schema":"http://json-schema.org/draft-04/schema#","description":"Used to specify further pages (starts at 1)."}},"required":[]}]},"response":{"200":{"type":"object","properties":{"Link":{"type":"string","description":"Pagination information. See https://docs.readme.com/main/reference/pagination for more information."},"x-total-count":{"type":"string","description":"The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination."}}}}} as const -; -const GetCustomPage = {"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]}]},"response":{"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CUSTOMPAGE_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetCustomPages = {"metadata":{"allOf":[{"type":"object","properties":{"perPage":{"type":"integer","default":10,"minimum":1,"maximum":100,"$schema":"http://json-schema.org/draft-04/schema#","description":"Number of items to include in pagination (up to 100, defaults to 10)."},"page":{"type":"integer","default":1,"minimum":1,"$schema":"http://json-schema.org/draft-04/schema#","description":"Used to specify further pages (starts at 1)."}},"required":[]}]},"response":{"200":{"type":"object","properties":{"Link":{"type":"string","description":"Pagination information. See https://docs.readme.com/main/reference/pagination for more information."},"x-total-count":{"type":"string","description":"The total amount of results, ignoring pagination. See https://docs.readme.com/main/reference/pagination for more information about pagination."}}},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetDoc = {"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"200":{"type":"object","properties":{"title":{"type":"string","description":"Title of the page."},"type":{"type":"string","description":"Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).\n\n`basic` `error` `link`","enum":["basic","error","link"]},"body":{"type":"string","description":"Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."},"category":{"type":"string","description":"Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."},"hidden":{"type":"boolean","description":"Visibility of the page."},"order":{"type":"integer","description":"The position of the page in your project sidebar.","examples":[999]},"parentDoc":{"type":"string","description":"The parent doc's ID, if the page is a subpage."},"error":{"type":"object","properties":{"code":{"type":"string","description":"The error code for docs with the \"error\" type."}}}},"additionalProperties":true,"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"DOC_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetOpenRoles = {"response":{"200":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"A slugified version of the job opening title.","examples":["api-engineer"]},"title":{"type":"string","description":"The job opening position.","examples":["API Engineer"]},"description":{"type":"string","description":"The description for this open position. This content is formatted as HTML."},"pullquote":{"type":"string","description":"A short pullquote for the open position.","examples":["Deeply knowledgeable of the web, HTTP, and the API space."]},"location":{"type":"string","description":"Where this position is located at.","examples":["Remote"]},"department":{"type":"string","description":"The internal organization you'll be working in.","examples":["Engineering"]},"url":{"type":"string","format":"url","description":"The place where you can apply for the position!"}}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetProductionDoc = {"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"200":{"type":"object","properties":{"title":{"type":"string","description":"Title of the page."},"type":{"type":"string","description":"Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).\n\n`basic` `error` `link`","enum":["basic","error","link"]},"body":{"type":"string","description":"Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."},"category":{"type":"string","description":"Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."},"hidden":{"type":"boolean","description":"Visibility of the page."},"order":{"type":"integer","description":"The position of the page in your project sidebar.","examples":[999]},"parentDoc":{"type":"string","description":"The parent doc's ID, if the page is a subpage."},"error":{"type":"object","properties":{"code":{"type":"string","description":"The error code for docs with the \"error\" type."}}}},"additionalProperties":true,"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"DOC_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetProject = {"response":{"200":{"type":"object","properties":{"name":{"type":"string"},"subdomain":{"type":"string"},"jwtSecret":{"type":"string"},"baseUrl":{"type":"string","format":"url","description":"The base URL for the project. If the project is not running under a custom domain, it will be `https://projectSubdomain.readme.io`, otherwise it can either be or `https://example.com` or, in the case of an enterprise child project `https://example.com/projectSubdomain`."},"plan":{"type":"string"}},"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetVersion = {"metadata":{"allOf":[{"type":"object","properties":{"versionId":{"type":"string","examples":["v1.0.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Semver identifier for the project version. For best results, use the formatted `version_clean` value listed in the response from the [Get Versions endpoint](/reference/getversions)."}},"required":["versionId"]}]},"response":{"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const GetVersions = {"response":{"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const SearchDocs = {"metadata":{"allOf":[{"type":"object","properties":{"search":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"Search string to look for."}},"required":["search"]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const UpdateApiSpecification = {"body":{"type":"object","properties":{"spec":{"description":"OpenAPI/Swagger file. We accept JSON or YAML.","type":"string","format":"binary"}},"$schema":"http://json-schema.org/draft-04/schema#"},"metadata":{"allOf":[{"type":"object","properties":{"id":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"ID of the API specification. The unique ID for each API can be found by navigating to your **API Definitions** page."}},"required":["id"]}]},"response":{"400":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_FILE_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_ID_DUPLICATE"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_ID_INVALID"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_INVALID"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_INVALID_SCHEMA"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_VERSION_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"408":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_TIMEOUT"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const UpdateCategory = {"body":{"type":"object","properties":{"title":{"type":"string","description":"A short title for the category. This is what will show in the sidebar."},"type":{"type":"string","enum":["reference","guide"],"default":"guide","description":"A category can be part of your reference or guide documentation, which is determined by this field.\n\nDefault: `guide`"}},"$schema":"http://json-schema.org/draft-04/schema#"},"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","examples":["getting-started"],"$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the category title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the category \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"400":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CATEGORY_INVALID"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CATEGORY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const UpdateChangelog = {"body":{"type":"object","properties":{"title":{"type":"string","description":"Title of the changelog."},"type":{"type":"string","enum":["","added","fixed","improved","deprecated","removed"],"description":"Default: "},"body":{"type":"string","description":"Body content of the changelog."},"hidden":{"type":"boolean","description":"Visibility of the changelog.","default":true}},"required":["title","body"],"$schema":"http://json-schema.org/draft-04/schema#"},"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the changelog title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the changelog \"Owlet Weekly Update\", enter the slug \"owlet-weekly-update\"."}},"required":["slug"]}]}} as const -; -const UpdateCustomPage = {"body":{"type":"object","properties":{"title":{"type":"string","description":"Title of the custom page."},"body":{"type":"string","description":"Body formatted in Markdown (displayed by default)."},"html":{"type":"string","description":"Body formatted in HTML (sanitized, only displayed if `htmlmode` is **true**)."},"htmlmode":{"type":"boolean","description":"**true** if `html` should be displayed, **false** if `body` should be displayed.","default":false},"hidden":{"type":"boolean","description":"Visibility of the custom page.","default":true}},"required":["title"],"$schema":"http://json-schema.org/draft-04/schema#"},"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]}]},"response":{"400":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CUSTOMPAGE_INVALID"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"CUSTOMPAGE_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const UpdateDoc = {"body":{"type":"object","properties":{"title":{"type":"string","description":"Title of the page."},"type":{"type":"string","description":"Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).","enum":["basic","error","link"]},"body":{"type":"string","description":"Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."},"category":{"type":"string","description":"Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."},"hidden":{"type":"boolean","description":"Visibility of the page."},"order":{"type":"integer","description":"The position of the page in your project sidebar.","examples":[999]},"parentDoc":{"type":"string","description":"The parent doc's ID, if the page is a subpage."},"error":{"type":"object","properties":{"code":{"type":"string","description":"The error code for docs with the \"error\" type."}}},"categorySlug":{"type":"string","description":"The slug of the category this page is associated with. You can get this through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories). This field is an alternative to the `category` field."},"parentDocSlug":{"type":"string","description":"If this page is a subpage, this field will be the slug of the parent document. You can get this through https://docs.readme.com/main/reference/docs#getdoc. This field is an alternative to the `parentDoc` field."}},"additionalProperties":true,"$schema":"http://json-schema.org/draft-04/schema#"},"metadata":{"allOf":[{"type":"object","properties":{"slug":{"type":"string","$schema":"http://json-schema.org/draft-04/schema#","description":"A URL-safe representation of the page title. Slugs must be all lowercase, and replace spaces with hyphens. For example, for the title \"Getting Started\", enter the slug \"getting-started\"."}},"required":["slug"]},{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"200":{"type":"object","properties":{"title":{"type":"string","description":"Title of the page."},"type":{"type":"string","description":"Type of the page. The available types all show up under the /docs/ URL path of your docs project (also known as the \"guides\" section). Can be \"basic\" (most common), \"error\" (page desribing an API error), or \"link\" (page that redirects to an external link).\n\n`basic` `error` `link`","enum":["basic","error","link"]},"body":{"type":"string","description":"Body content of the page, formatted in [ReadMe-flavored Markdown](https://docs.readme.com/rdmd/docs)."},"category":{"type":"string","description":"Category ID of the page, which you can get through [the **Get all categories** endpoint](https://docs.readme.com/main/reference/getcategories)."},"hidden":{"type":"boolean","description":"Visibility of the page."},"order":{"type":"integer","description":"The position of the page in your project sidebar.","examples":[999]},"parentDoc":{"type":"string","description":"The parent doc's ID, if the page is a subpage."},"error":{"type":"object","properties":{"code":{"type":"string","description":"The error code for docs with the \"error\" type."}}}},"additionalProperties":true,"$schema":"http://json-schema.org/draft-04/schema#"},"400":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"DOC_INVALID"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"DOC_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const UpdateVersion = {"body":{"type":"object","properties":{"version":{"type":"string","description":"Semantic Version"},"codename":{"type":"string","description":"Dubbed name of version."},"from":{"type":"string","description":"Semantic Version to use as the base fork."},"is_stable":{"type":"boolean","description":"Should this be the **main** version?"},"is_beta":{"type":"boolean","default":true},"is_hidden":{"type":"boolean","description":"Should this be publically accessible?"},"is_deprecated":{"type":"boolean","description":"Should this be deprecated? Only allowed in PUT operations."}},"required":["version","from"],"$schema":"http://json-schema.org/draft-04/schema#"},"metadata":{"allOf":[{"type":"object","properties":{"versionId":{"type":"string","examples":["v1.0.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Semver identifier for the project version. For best results, use the formatted `version_clean` value listed in the response from the [Get Versions endpoint](/reference/getversions)."}},"required":["versionId"]}]},"response":{"400":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_CANT_DEMOTE_STABLE"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"404":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"VERSION_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -const UploadApiSpecification = {"body":{"type":"object","properties":{"spec":{"description":"OpenAPI/Swagger file. We accept JSON or YAML.","type":"string","format":"binary"}},"$schema":"http://json-schema.org/draft-04/schema#"},"metadata":{"allOf":[{"type":"object","properties":{"x-readme-version":{"type":"string","examples":["v3.0"],"$schema":"http://json-schema.org/draft-04/schema#","description":"Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."}},"required":[]}]},"response":{"400":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_FILE_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_INVALID"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_INVALID_SCHEMA"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_VERSION_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"401":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_EMPTY"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}},{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_NOTFOUND"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"403":{"oneOf":[{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"APIKEY_MISMATCH"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}}}],"$schema":"http://json-schema.org/draft-04/schema#"},"408":{"type":"object","properties":{"error":{"type":"string","description":"An error code unique to the error received.","default":"SPEC_TIMEOUT"},"message":{"type":"string","description":"The reason why the error occured."},"suggestion":{"type":"string","description":"A helpful suggestion for how to alleviate the error."},"docs":{"type":"string","format":"url","description":"A [ReadMe Metrics](https://readme.com/metrics/) log URL where you can see more information the request that you made. If we have metrics URLs unavailable for your request, this URL will be a URL to our API Reference.","examples":["https://docs.readme.com/logs/6883d0ee-cf79-447a-826f-a48f7d5bdf5f"]},"help":{"type":"string","description":"Information on where you can receive additional assistance from our wonderful support team.","examples":["If you need help, email support@readme.io"]},"poem":{"type":"array","description":"A short poem we wrote you about your error.","items":{"type":"string"},"examples":["If you're seeing this error,","Things didn't quite go the way we hoped.","When we tried to process your request,","Maybe trying again it'll work—who knows!"]}},"$schema":"http://json-schema.org/draft-04/schema#"}}} as const -; -export { ApplyToReadMe, CreateCategory, CreateChangelog, CreateCustomPage, CreateDoc, CreateVersion, DeleteApiSpecification, DeleteCategory, DeleteChangelog, DeleteCustomPage, DeleteDoc, DeleteVersion, GetApiRegistry, GetApiSchema, GetApiSpecification, GetCategories, GetCategory, GetCategoryDocs, GetChangelog, GetChangelogs, GetCustomPage, GetCustomPages, GetDoc, GetOpenRoles, GetProductionDoc, GetProject, GetVersion, GetVersions, SearchDocs, UpdateApiSpecification, UpdateCategory, UpdateChangelog, UpdateCustomPage, UpdateDoc, UpdateVersion, UploadApiSpecification } diff --git a/packages/node/src/.api/apis/developers/types.ts b/packages/node/src/.api/apis/developers/types.ts deleted file mode 100644 index cd1c29655..000000000 --- a/packages/node/src/.api/apis/developers/types.ts +++ /dev/null @@ -1,131 +0,0 @@ -import type { FromSchema } from 'json-schema-to-ts'; -import * as schemas from './schemas'; - -export type ApplyToReadMeBodyParam = FromSchema; -export type CreateCategoryBodyParam = FromSchema; -export type CreateCategoryMetadataParam = FromSchema; -export type CreateCategoryResponse400 = FromSchema; -export type CreateChangelogBodyParam = FromSchema; -export type CreateCustomPageBodyParam = FromSchema; -export type CreateCustomPageResponse400 = FromSchema; -export type CreateCustomPageResponse401 = FromSchema; -export type CreateCustomPageResponse403 = FromSchema; -export type CreateDocBodyParam = FromSchema; -export type CreateDocMetadataParam = FromSchema; -export type CreateDocResponse201 = FromSchema; -export type CreateDocResponse400 = FromSchema; -export type CreateDocResponse401 = FromSchema; -export type CreateDocResponse403 = FromSchema; -export type CreateVersionBodyParam = FromSchema; -export type CreateVersionResponse400 = FromSchema; -export type CreateVersionResponse401 = FromSchema; -export type CreateVersionResponse403 = FromSchema; -export type CreateVersionResponse404 = FromSchema; -export type DeleteApiSpecificationMetadataParam = FromSchema; -export type DeleteApiSpecificationResponse400 = FromSchema; -export type DeleteApiSpecificationResponse401 = FromSchema; -export type DeleteApiSpecificationResponse403 = FromSchema; -export type DeleteApiSpecificationResponse404 = FromSchema; -export type DeleteCategoryMetadataParam = FromSchema; -export type DeleteCategoryResponse404 = FromSchema; -export type DeleteChangelogMetadataParam = FromSchema; -export type DeleteCustomPageMetadataParam = FromSchema; -export type DeleteCustomPageResponse401 = FromSchema; -export type DeleteCustomPageResponse403 = FromSchema; -export type DeleteCustomPageResponse404 = FromSchema; -export type DeleteDocMetadataParam = FromSchema; -export type DeleteDocResponse401 = FromSchema; -export type DeleteDocResponse403 = FromSchema; -export type DeleteDocResponse404 = FromSchema; -export type DeleteVersionMetadataParam = FromSchema; -export type DeleteVersionResponse400 = FromSchema; -export type DeleteVersionResponse401 = FromSchema; -export type DeleteVersionResponse403 = FromSchema; -export type DeleteVersionResponse404 = FromSchema; -export type GetApiRegistryMetadataParam = FromSchema; -export type GetApiRegistryResponse200 = FromSchema; -export type GetApiRegistryResponse404 = FromSchema; -export type GetApiSchemaResponse200 = FromSchema; -export type GetApiSpecificationMetadataParam = FromSchema; -export type GetApiSpecificationResponse200 = FromSchema; -export type GetApiSpecificationResponse400 = FromSchema; -export type GetApiSpecificationResponse401 = FromSchema; -export type GetApiSpecificationResponse403 = FromSchema; -export type GetApiSpecificationResponse404 = FromSchema; -export type GetCategoriesMetadataParam = FromSchema; -export type GetCategoriesResponse200 = FromSchema; -export type GetCategoryDocsMetadataParam = FromSchema; -export type GetCategoryDocsResponse404 = FromSchema; -export type GetCategoryMetadataParam = FromSchema; -export type GetCategoryResponse404 = FromSchema; -export type GetChangelogMetadataParam = FromSchema; -export type GetChangelogsMetadataParam = FromSchema; -export type GetChangelogsResponse200 = FromSchema; -export type GetCustomPageMetadataParam = FromSchema; -export type GetCustomPageResponse401 = FromSchema; -export type GetCustomPageResponse403 = FromSchema; -export type GetCustomPageResponse404 = FromSchema; -export type GetCustomPagesMetadataParam = FromSchema; -export type GetCustomPagesResponse200 = FromSchema; -export type GetCustomPagesResponse401 = FromSchema; -export type GetCustomPagesResponse403 = FromSchema; -export type GetDocMetadataParam = FromSchema; -export type GetDocResponse200 = FromSchema; -export type GetDocResponse401 = FromSchema; -export type GetDocResponse403 = FromSchema; -export type GetDocResponse404 = FromSchema; -export type GetOpenRolesResponse200 = FromSchema; -export type GetProductionDocMetadataParam = FromSchema; -export type GetProductionDocResponse200 = FromSchema; -export type GetProductionDocResponse401 = FromSchema; -export type GetProductionDocResponse403 = FromSchema; -export type GetProductionDocResponse404 = FromSchema; -export type GetProjectResponse200 = FromSchema; -export type GetProjectResponse401 = FromSchema; -export type GetProjectResponse403 = FromSchema; -export type GetVersionMetadataParam = FromSchema; -export type GetVersionResponse401 = FromSchema; -export type GetVersionResponse403 = FromSchema; -export type GetVersionResponse404 = FromSchema; -export type GetVersionsResponse401 = FromSchema; -export type GetVersionsResponse403 = FromSchema; -export type SearchDocsMetadataParam = FromSchema; -export type SearchDocsResponse401 = FromSchema; -export type SearchDocsResponse403 = FromSchema; -export type UpdateApiSpecificationBodyParam = FromSchema; -export type UpdateApiSpecificationMetadataParam = FromSchema; -export type UpdateApiSpecificationResponse400 = FromSchema; -export type UpdateApiSpecificationResponse401 = FromSchema; -export type UpdateApiSpecificationResponse403 = FromSchema; -export type UpdateApiSpecificationResponse408 = FromSchema; -export type UpdateCategoryBodyParam = FromSchema; -export type UpdateCategoryMetadataParam = FromSchema; -export type UpdateCategoryResponse400 = FromSchema; -export type UpdateCategoryResponse404 = FromSchema; -export type UpdateChangelogBodyParam = FromSchema; -export type UpdateChangelogMetadataParam = FromSchema; -export type UpdateCustomPageBodyParam = FromSchema; -export type UpdateCustomPageMetadataParam = FromSchema; -export type UpdateCustomPageResponse400 = FromSchema; -export type UpdateCustomPageResponse401 = FromSchema; -export type UpdateCustomPageResponse403 = FromSchema; -export type UpdateCustomPageResponse404 = FromSchema; -export type UpdateDocBodyParam = FromSchema; -export type UpdateDocMetadataParam = FromSchema; -export type UpdateDocResponse200 = FromSchema; -export type UpdateDocResponse400 = FromSchema; -export type UpdateDocResponse401 = FromSchema; -export type UpdateDocResponse403 = FromSchema; -export type UpdateDocResponse404 = FromSchema; -export type UpdateVersionBodyParam = FromSchema; -export type UpdateVersionMetadataParam = FromSchema; -export type UpdateVersionResponse400 = FromSchema; -export type UpdateVersionResponse401 = FromSchema; -export type UpdateVersionResponse403 = FromSchema; -export type UpdateVersionResponse404 = FromSchema; -export type UploadApiSpecificationBodyParam = FromSchema; -export type UploadApiSpecificationMetadataParam = FromSchema; -export type UploadApiSpecificationResponse400 = FromSchema; -export type UploadApiSpecificationResponse401 = FromSchema; -export type UploadApiSpecificationResponse403 = FromSchema; -export type UploadApiSpecificationResponse408 = FromSchema; diff --git a/packages/node/src/lib/ReadMe.ts b/packages/node/src/lib/ReadMe.ts index 54dfb8a6a..1b72066e6 100644 --- a/packages/node/src/lib/ReadMe.ts +++ b/packages/node/src/lib/ReadMe.ts @@ -1,8 +1,8 @@ import type { Options } from './log'; -import type { GetProjectResponse200 } from '../.api/apis/developers'; import type { NextFunction, Request, Response } from 'express'; -import readmeSdk from '../.api/apis/developers'; +import pkg from '../../package.json'; +import config from '../config'; import findAPIKey from './find-api-key'; import { getGroupByApiKey } from './get-group-id'; @@ -65,7 +65,14 @@ interface ReadMeVersion { export default class ReadMe { private readmeAPIKey: string; - private readmeProjectData!: GetProjectResponse200; + private readmeProjectData!: { + [x: string]: unknown; + baseUrl?: string; + jwtSecret?: string; + name?: string; + plan?: string; + subdomain?: string; + }; private readmeVersionData!: ReadMeVersion[]; @@ -134,12 +141,23 @@ export default class ReadMe { const baseUrl = `${req.protocol}://${req.get('host')}${req.baseUrl}`; if (!this.readmeProjectData) { - readmeSdk.auth(this.readmeAPIKey); try { - this.readmeProjectData = (await readmeSdk.getProject()).data; - this.readmeVersionData = (await readmeSdk.getVersions()).data as ReadMeVersion[]; - // eslint-disable-next-line @typescript-eslint/no-explicit-any - } catch (e: any) { + const encodedApiKey = Buffer.from(`${this.readmeAPIKey}:`).toString('base64'); + const { origin: readmeAPIOrigin } = new URL(config.readmeApiUrl); + const headers = { + authorization: encodedApiKey, + 'user-agent': `${pkg.name}/${pkg.version}`, + }; + + this.readmeProjectData = await fetch(new URL('/api/v1/', readmeAPIOrigin), { + headers, + }).then(r => r.json() as Promise); + + // return this.core.fetch('/version', 'get'); + this.readmeVersionData = await fetch(new URL('/api/v1/version', readmeAPIOrigin), { + headers, + }).then(r => r.json() as Promise); + } catch (e) { // TODO: Maybe send this to sentry? if (e.status === 401) { console.error('Invalid ReadMe API key. Contact support@readme.io for help!'); diff --git a/packages/node/tsconfig.json b/packages/node/tsconfig.json index 1f706a2e8..ec5b1e510 100644 --- a/packages/node/tsconfig.json +++ b/packages/node/tsconfig.json @@ -6,13 +6,18 @@ "declaration": true, "inlineSourceMap": true, "outDir": "./dist", - "resolveJsonModule": true + "resolveJsonModule": true, + + /** + * With strict mode on anything thrown within a `try-catch` is typed as `unknown`. Because we + * have the `no-throw-literal` ESLint rule enabled these things will always be an `Error` object + * so TS forcing us to type a known `Error` object as `(err as Error).message` in order to + * access a message adds nothing but unnecessary bloat for us. + * + * @see {@link https://eslint.org/docs/latest/rules/no-throw-literal} + * @see {@link https://www.typescriptlang.org/tsconfig#useUnknownInCatchVariables} + */ + "useUnknownInCatchVariables": false }, - "include": [ - "src/**/*", - "src/.api/**/*", - // We have to explicitly list these config files - // due to the dynamic require in certain envs - "src/config/*.json" - ] + "include": ["src/**/*"] }