@bfra.me/api-core 0.1.0 → 0.1.2

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

@@ -1,57 +0,0 @@
-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;
-export default GetCategories

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

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

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

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

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

@@ -1,20 +0,0 @@
-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;
-export default GetChangelog

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

@@ -1,43 +0,0 @@
-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;
-export default GetChangelogs

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

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

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

@@ -1,60 +0,0 @@
-import ErrorApikeyEmpty from './ErrorApikeyEmpty.js';
-import ErrorApikeyMismatch from './ErrorApikeyMismatch.js';
-import ErrorApikeyNotfound from './ErrorApikeyNotfound.js';
-
-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": [
-        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 GetCustomPages

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

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

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

@@ -1,12 +0,0 @@
-import JobOpening from './JobOpening.js';
-
-const GetOpenRoles = {
-  "response": {
-    "200": {
-      "type": "array",
-      "items": JobOpening,
-      "$schema": "http://json-schema.org/draft-04/schema#"
-    }
-  }
-} as const;
-export default GetOpenRoles

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

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

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

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

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

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

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

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

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

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

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

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