@bfra.me/api-core 0.1.0

package/test-utils/sdks/readme/src/schemas/ErrorSpecInvalidSchema.ts

@@ -0,0 +1,49 @@
+const ErrorSpecInvalidSchema = {
+  "title": "error_SPEC_INVALID_SCHEMA",
+  "x-readme-ref-name": "error_SPEC_INVALID_SCHEMA",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorSpecInvalidSchema

package/test-utils/sdks/readme/src/schemas/ErrorSpecNotfound.ts

@@ -0,0 +1,49 @@
+const ErrorSpecNotfound = {
+  "title": "error_SPEC_NOTFOUND",
+  "x-readme-ref-name": "error_SPEC_NOTFOUND",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorSpecNotfound

package/test-utils/sdks/readme/src/schemas/ErrorSpecTimeout.ts

@@ -0,0 +1,49 @@
+const ErrorSpecTimeout = {
+  "title": "error_SPEC_TIMEOUT",
+  "x-readme-ref-name": "error_SPEC_TIMEOUT",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorSpecTimeout

package/test-utils/sdks/readme/src/schemas/ErrorSpecVersionNotfound.ts

@@ -0,0 +1,49 @@
+const ErrorSpecVersionNotfound = {
+  "title": "error_SPEC_VERSION_NOTFOUND",
+  "x-readme-ref-name": "error_SPEC_VERSION_NOTFOUND",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorSpecVersionNotfound

package/test-utils/sdks/readme/src/schemas/ErrorVersionCantDemoteStable.ts

@@ -0,0 +1,49 @@
+const ErrorVersionCantDemoteStable = {
+  "title": "error_VERSION_CANT_DEMOTE_STABLE",
+  "x-readme-ref-name": "error_VERSION_CANT_DEMOTE_STABLE",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorVersionCantDemoteStable

package/test-utils/sdks/readme/src/schemas/ErrorVersionCantRemoveStable.ts

@@ -0,0 +1,49 @@
+const ErrorVersionCantRemoveStable = {
+  "title": "error_VERSION_CANT_REMOVE_STABLE",
+  "x-readme-ref-name": "error_VERSION_CANT_REMOVE_STABLE",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorVersionCantRemoveStable

package/test-utils/sdks/readme/src/schemas/ErrorVersionDuplicate.ts

@@ -0,0 +1,49 @@
+const ErrorVersionDuplicate = {
+  "title": "error_VERSION_DUPLICATE",
+  "x-readme-ref-name": "error_VERSION_DUPLICATE",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorVersionDuplicate

package/test-utils/sdks/readme/src/schemas/ErrorVersionEmpty.ts

@@ -0,0 +1,49 @@
+const ErrorVersionEmpty = {
+  "title": "error_VERSION_EMPTY",
+  "x-readme-ref-name": "error_VERSION_EMPTY",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorVersionEmpty

package/test-utils/sdks/readme/src/schemas/ErrorVersionForkEmpty.ts

@@ -0,0 +1,49 @@
+const ErrorVersionForkEmpty = {
+  "title": "error_VERSION_FORK_EMPTY",
+  "x-readme-ref-name": "error_VERSION_FORK_EMPTY",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorVersionForkEmpty

package/test-utils/sdks/readme/src/schemas/ErrorVersionForkNotfound.ts

@@ -0,0 +1,49 @@
+const ErrorVersionForkNotfound = {
+  "title": "error_VERSION_FORK_NOTFOUND",
+  "x-readme-ref-name": "error_VERSION_FORK_NOTFOUND",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorVersionForkNotfound

package/test-utils/sdks/readme/src/schemas/ErrorVersionNotfound.ts

@@ -0,0 +1,49 @@
+const ErrorVersionNotfound = {
+  "title": "error_VERSION_NOTFOUND",
+  "x-readme-ref-name": "error_VERSION_NOTFOUND",
+  "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!"
+      ]
+    }
+  }
+} as const;
+export default ErrorVersionNotfound

package/test-utils/sdks/readme/src/schemas/GetApiRegistry.ts

@@ -0,0 +1,27 @@
+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#"
+    }
+  }
+} as const;
+export default GetApiRegistry

package/test-utils/sdks/readme/src/schemas/GetApiSchema.ts

@@ -0,0 +1,10 @@
+const GetApiSchema = {
+  "response": {
+    "200": {
+      "type": "object",
+      "additionalProperties": true,
+      "$schema": "http://json-schema.org/draft-04/schema#"
+    }
+  }
+} as const;
+export default GetApiSchema

package/test-utils/sdks/readme/src/schemas/GetApiSpecification.ts

@@ -0,0 +1,74 @@
+import ErrorApikeyEmpty from './ErrorApikeyEmpty.js';
+import ErrorApikeyMismatch from './ErrorApikeyMismatch.js';
+import ErrorApikeyNotfound from './ErrorApikeyNotfound.js';
+
+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."
+        }
+      }
+    },
+    "401": {
+      "oneOf": [
+        ErrorApikeyEmpty,
+        ErrorApikeyNotfound
+      ],
+      "$schema": "http://json-schema.org/draft-04/schema#"
+    },
+    "403": {
+      "oneOf": [
+        ErrorApikeyMismatch
+      ],
+      "$schema": "http://json-schema.org/draft-04/schema#"
+    }
+  }
+} as const;
+export default GetApiSpecification