@bfra.me/api-core 0.1.0 → 0.1.1

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

@@ -1,67 +0,0 @@
-import ErrorApikeyEmpty from './ErrorApikeyEmpty.js';
-import ErrorApikeyMismatch from './ErrorApikeyMismatch.js';
-import ErrorApikeyNotfound from './ErrorApikeyNotfound.js';
-import ErrorSpecFileEmpty from './ErrorSpecFileEmpty.js';
-import ErrorSpecIdDuplicate from './ErrorSpecIdDuplicate.js';
-import ErrorSpecIdInvalid from './ErrorSpecIdInvalid.js';
-import ErrorSpecInvalid from './ErrorSpecInvalid.js';
-import ErrorSpecInvalidSchema from './ErrorSpecInvalidSchema.js';
-import ErrorSpecVersionNotfound from './ErrorSpecVersionNotfound.js';
-
-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": [
-        ErrorSpecFileEmpty,
-        ErrorSpecIdDuplicate,
-        ErrorSpecIdInvalid,
-        ErrorSpecInvalid,
-        ErrorSpecInvalidSchema,
-        ErrorSpecVersionNotfound
-      ],
-      "$schema": "http://json-schema.org/draft-04/schema#"
-    },
-    "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 UpdateApiSpecification

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

@@ -1,37 +0,0 @@
-const UpdateCategory = {
-  "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": []
-      }
-    ]
-  }
-} as const;
-export default UpdateCategory

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

@@ -1,20 +0,0 @@
-const UpdateChangelog = {
-  "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;
-export default UpdateChangelog

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

@@ -1,39 +0,0 @@
-import ErrorApikeyEmpty from './ErrorApikeyEmpty.js';
-import ErrorApikeyMismatch from './ErrorApikeyMismatch.js';
-import ErrorApikeyNotfound from './ErrorApikeyNotfound.js';
-
-const UpdateCustomPage = {
-  "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": [
-        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 UpdateCustomPage

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

@@ -1,53 +0,0 @@
-import ErrorApikeyEmpty from './ErrorApikeyEmpty.js';
-import ErrorApikeyMismatch from './ErrorApikeyMismatch.js';
-import ErrorApikeyNotfound from './ErrorApikeyNotfound.js';
-
-const UpdateDoc = {
-  "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": [
-        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 UpdateDoc

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

@@ -1,42 +0,0 @@
-import ErrorApikeyEmpty from './ErrorApikeyEmpty.js';
-import ErrorApikeyMismatch from './ErrorApikeyMismatch.js';
-import ErrorApikeyNotfound from './ErrorApikeyNotfound.js';
-
-const UpdateVersion = {
-  "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": [
-        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 UpdateVersion

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

@@ -1,64 +0,0 @@
-import ErrorApikeyEmpty from './ErrorApikeyEmpty.js';
-import ErrorApikeyMismatch from './ErrorApikeyMismatch.js';
-import ErrorApikeyNotfound from './ErrorApikeyNotfound.js';
-import ErrorSpecFileEmpty from './ErrorSpecFileEmpty.js';
-import ErrorSpecInvalid from './ErrorSpecInvalid.js';
-import ErrorSpecInvalidSchema from './ErrorSpecInvalidSchema.js';
-import ErrorSpecVersionNotfound from './ErrorSpecVersionNotfound.js';
-
-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": [
-        ErrorSpecFileEmpty,
-        ErrorSpecInvalid,
-        ErrorSpecInvalidSchema,
-        ErrorSpecVersionNotfound
-      ],
-      "$schema": "http://json-schema.org/draft-04/schema#"
-    },
-    "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 UploadApiSpecification

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

@@ -1,40 +0,0 @@
-const 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"
-  ],
-  "title": "version",
-  "x-readme-ref-name": "version"
-} as const;
-export default Version

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

@@ -1,70 +0,0 @@
-import Apply from './schemas/Apply.js';
-import Category from './schemas/Category.js';
-import Changelog from './schemas/Changelog.js';
-import CondensedProjectData from './schemas/CondensedProjectData.js';
-import CreateCategory from './schemas/CreateCategory.js';
-import CreateCustomPage from './schemas/CreateCustomPage.js';
-import CreateDoc from './schemas/CreateDoc.js';
-import CreateVersion from './schemas/CreateVersion.js';
-import CustomPage from './schemas/CustomPage.js';
-import DeleteApiSpecification from './schemas/DeleteApiSpecification.js';
-import DeleteCategory from './schemas/DeleteCategory.js';
-import DeleteChangelog from './schemas/DeleteChangelog.js';
-import DeleteCustomPage from './schemas/DeleteCustomPage.js';
-import DeleteDoc from './schemas/DeleteDoc.js';
-import DeleteVersion from './schemas/DeleteVersion.js';
-import DocSchemaPost from './schemas/DocSchemaPost.js';
-import DocSchemaPut from './schemas/DocSchemaPut.js';
-import DocSchemaResponse from './schemas/DocSchemaResponse.js';
-import ErrorApikeyEmpty from './schemas/ErrorApikeyEmpty.js';
-import ErrorApikeyMismatch from './schemas/ErrorApikeyMismatch.js';
-import ErrorApikeyNotfound from './schemas/ErrorApikeyNotfound.js';
-import ErrorCategoryInvalid from './schemas/ErrorCategoryInvalid.js';
-import ErrorCategoryNotfound from './schemas/ErrorCategoryNotfound.js';
-import ErrorCustompageInvalid from './schemas/ErrorCustompageInvalid.js';
-import ErrorCustompageNotfound from './schemas/ErrorCustompageNotfound.js';
-import ErrorDocInvalid from './schemas/ErrorDocInvalid.js';
-import ErrorDocNotfound from './schemas/ErrorDocNotfound.js';
-import ErrorRegistryNotfound from './schemas/ErrorRegistryNotfound.js';
-import ErrorSpecFileEmpty from './schemas/ErrorSpecFileEmpty.js';
-import ErrorSpecIdDuplicate from './schemas/ErrorSpecIdDuplicate.js';
-import ErrorSpecIdInvalid from './schemas/ErrorSpecIdInvalid.js';
-import ErrorSpecInvalid from './schemas/ErrorSpecInvalid.js';
-import ErrorSpecInvalidSchema from './schemas/ErrorSpecInvalidSchema.js';
-import ErrorSpecNotfound from './schemas/ErrorSpecNotfound.js';
-import ErrorSpecTimeout from './schemas/ErrorSpecTimeout.js';
-import ErrorSpecVersionNotfound from './schemas/ErrorSpecVersionNotfound.js';
-import ErrorVersionCantDemoteStable from './schemas/ErrorVersionCantDemoteStable.js';
-import ErrorVersionCantRemoveStable from './schemas/ErrorVersionCantRemoveStable.js';
-import ErrorVersionDuplicate from './schemas/ErrorVersionDuplicate.js';
-import ErrorVersionEmpty from './schemas/ErrorVersionEmpty.js';
-import ErrorVersionForkEmpty from './schemas/ErrorVersionForkEmpty.js';
-import ErrorVersionForkNotfound from './schemas/ErrorVersionForkNotfound.js';
-import ErrorVersionNotfound from './schemas/ErrorVersionNotfound.js';
-import GetApiRegistry from './schemas/GetApiRegistry.js';
-import GetApiSchema from './schemas/GetApiSchema.js';
-import GetApiSpecification from './schemas/GetApiSpecification.js';
-import GetCategories from './schemas/GetCategories.js';
-import GetCategory from './schemas/GetCategory.js';
-import GetCategoryDocs from './schemas/GetCategoryDocs.js';
-import GetChangelog from './schemas/GetChangelog.js';
-import GetChangelogs from './schemas/GetChangelogs.js';
-import GetCustomPage from './schemas/GetCustomPage.js';
-import GetCustomPages from './schemas/GetCustomPages.js';
-import GetDoc from './schemas/GetDoc.js';
-import GetOpenRoles from './schemas/GetOpenRoles.js';
-import GetProductionDoc from './schemas/GetProductionDoc.js';
-import GetProject from './schemas/GetProject.js';
-import GetVersion from './schemas/GetVersion.js';
-import GetVersions from './schemas/GetVersions.js';
-import JobOpening from './schemas/JobOpening.js';
-import SearchDocs from './schemas/SearchDocs.js';
-import UpdateApiSpecification from './schemas/UpdateApiSpecification.js';
-import UpdateCategory from './schemas/UpdateCategory.js';
-import UpdateChangelog from './schemas/UpdateChangelog.js';
-import UpdateCustomPage from './schemas/UpdateCustomPage.js';
-import UpdateDoc from './schemas/UpdateDoc.js';
-import UpdateVersion from './schemas/UpdateVersion.js';
-import UploadApiSpecification from './schemas/UploadApiSpecification.js';
-import Version from './schemas/Version.js';
-export { Apply, Category, Changelog, CondensedProjectData, CreateCategory, CreateCustomPage, CreateDoc, CreateVersion, CustomPage, DeleteApiSpecification, DeleteCategory, DeleteChangelog, DeleteCustomPage, DeleteDoc, DeleteVersion, DocSchemaPost, DocSchemaPut, DocSchemaResponse, ErrorApikeyEmpty, ErrorApikeyMismatch, ErrorApikeyNotfound, ErrorCategoryInvalid, ErrorCategoryNotfound, ErrorCustompageInvalid, ErrorCustompageNotfound, ErrorDocInvalid, ErrorDocNotfound, ErrorRegistryNotfound, ErrorSpecFileEmpty, ErrorSpecIdDuplicate, ErrorSpecIdInvalid, ErrorSpecInvalid, ErrorSpecInvalidSchema, ErrorSpecNotfound, ErrorSpecTimeout, ErrorSpecVersionNotfound, ErrorVersionCantDemoteStable, ErrorVersionCantRemoveStable, ErrorVersionDuplicate, ErrorVersionEmpty, ErrorVersionForkEmpty, ErrorVersionForkNotfound, ErrorVersionNotfound, GetApiRegistry, GetApiSchema, GetApiSpecification, GetCategories, GetCategory, GetCategoryDocs, GetChangelog, GetChangelogs, GetCustomPage, GetCustomPages, GetDoc, GetOpenRoles, GetProductionDoc, GetProject, GetVersion, GetVersions, JobOpening, SearchDocs, UpdateApiSpecification, UpdateCategory, UpdateChangelog, UpdateCustomPage, UpdateDoc, UpdateVersion, UploadApiSpecification, Version }