@bfra.me/api-core 0.1.0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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