@bfra.me/api-core 0.1.0

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

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

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

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

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

@@ -0,0 +1,33 @@
+import ErrorApikeyEmpty from './ErrorApikeyEmpty.js';
+import ErrorApikeyMismatch from './ErrorApikeyMismatch.js';
+import ErrorApikeyNotfound from './ErrorApikeyNotfound.js';
+import ErrorVersionDuplicate from './ErrorVersionDuplicate.js';
+import ErrorVersionEmpty from './ErrorVersionEmpty.js';
+import ErrorVersionForkEmpty from './ErrorVersionForkEmpty.js';
+
+const CreateVersion = {
+  "response": {
+    "400": {
+      "oneOf": [
+        ErrorVersionEmpty,
+        ErrorVersionDuplicate,
+        ErrorVersionForkEmpty
+      ],
+      "$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 CreateVersion

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,62 @@
+const 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.",
+      "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,
+  "title": "docSchemaPut",
+  "x-readme-ref-name": "docSchemaPut"
+} as const;
+export default DocSchemaPut

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

@@ -0,0 +1,54 @@
+const 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).\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,
+  "title": "docSchemaResponse",
+  "x-readme-ref-name": "docSchemaResponse"
+} as const;
+export default DocSchemaResponse

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

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