/** * This is a snapshot of the OpenAPI description for ReadMe APIv2. * * This is used both for typechecking as well as for runtime validation. * We use ajv to validate the user data against schemas in this document. * * @see {@link https://docs.readme.com/main/openapi/readme-api-v2-beta.json} */ declare const document: { readonly openapi: "3.1.0"; readonly info: { readonly description: "Create beautiful product and API documentation with our developer friendly platform."; readonly version: "2.0.0-beta"; readonly title: "ReadMe API v2 🦉 (BETA)"; readonly 'x-readme-deploy': "5.344.0"; readonly termsOfService: "https://readme.com/tos"; readonly contact: { readonly name: "API Support"; readonly url: "https://docs.readme.com/main/docs/need-more-support"; readonly email: "support@readme.io"; }; }; readonly components: { readonly securitySchemes: { readonly bearer: { readonly type: "http"; readonly scheme: "bearer"; readonly description: "A bearer token that will be supplied within an `Authentication` header as `bearer `."; }; }; readonly schemas: {}; }; readonly paths: { readonly '/projects/{subdomain}/apikeys': { readonly post: { readonly operationId: "createAPIKey"; readonly summary: "Create an API key"; readonly tags: ["API Keys"]; readonly description: "Create an API key for your ReadMe project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly label: { readonly allOf: [{ readonly type: "string"; }, { readonly type: "string"; readonly minLength: 1; }]; }; }; readonly required: ["label"]; readonly additionalProperties: false; }; }; }; readonly required: true; }; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly maxLength: 30; }; readonly in: "path"; readonly name: "subdomain"; readonly required: true; readonly description: "The subdomain of your project."; }]; readonly responses: { readonly '201': { readonly description: "Created"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly token: { readonly type: "string"; readonly pattern: "rdme_\\w+"; }; readonly label: { readonly type: "string"; readonly nullable: true; }; readonly last_accessed_on: { readonly type: "string"; readonly format: "date-time"; readonly nullable: true; readonly description: "An ISO 8601 formatted date for when the API key was last accessed."; }; readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the API key was created."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)\\/apikeys\\/[a-f\\d]{24}"; }; }; readonly required: ["token", "label", "last_accessed_on", "created_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; readonly get: { readonly operationId: "getAPIKeys"; readonly summary: "Get your API keys"; readonly tags: ["API Keys"]; readonly description: "Get the API keys for your ReadMe project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "number"; readonly minimum: 1; readonly default: 1; }; readonly in: "query"; readonly name: "page"; readonly required: false; readonly description: "Used to specify further pages (starts at 1)."; }, { readonly schema: { readonly type: "number"; readonly minimum: 1; readonly maximum: 100; readonly default: 10; }; readonly in: "query"; readonly name: "per_page"; readonly required: false; readonly description: "Number of items to include in pagination (up to 100, defaults to 10)."; }, { readonly schema: { readonly type: "string"; readonly pattern: "(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly maxLength: 30; }; readonly in: "path"; readonly name: "subdomain"; readonly required: true; readonly description: "The subdomain of your project."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly total: { readonly type: "number"; }; readonly page: { readonly type: "number"; }; readonly per_page: { readonly type: "number"; }; readonly paging: { readonly type: "object"; readonly properties: { readonly next: { readonly type: "string"; readonly nullable: true; }; readonly previous: { readonly type: "string"; readonly nullable: true; }; readonly first: { readonly type: "string"; readonly nullable: true; }; readonly last: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["next", "previous", "first", "last"]; readonly additionalProperties: false; }; readonly data: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly token: { readonly type: "string"; readonly pattern: "rdme_\\w+"; }; readonly label: { readonly type: "string"; readonly nullable: true; }; readonly last_accessed_on: { readonly type: "string"; readonly format: "date-time"; readonly nullable: true; readonly description: "An ISO 8601 formatted date for when the API key was last accessed."; }; readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the API key was created."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)\\/apikeys\\/[a-f\\d]{24}"; }; }; readonly required: ["token", "label", "last_accessed_on", "created_at", "uri"]; readonly additionalProperties: false; }; }; }; readonly required: ["total", "page", "per_page", "paging", "data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/projects/{subdomain}/apikeys/{api_key_id}': { readonly delete: { readonly operationId: "deleteAPIKey"; readonly summary: "Delete an API key"; readonly tags: ["API Keys"]; readonly description: "Delete an API key from your ReadMe project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "[a-f\\d]{24}"; }; readonly in: "path"; readonly name: "api_key_id"; readonly required: true; readonly description: "The unique identifier for your API key."; }, { readonly schema: { readonly type: "string"; readonly pattern: "(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly maxLength: 30; }; readonly in: "path"; readonly name: "subdomain"; readonly required: true; readonly description: "The subdomain of your project."; }]; readonly responses: { readonly '204': { readonly description: "No Content"; }; }; }; readonly get: { readonly operationId: "getAPIKey"; readonly summary: "Get an API key"; readonly tags: ["API Keys"]; readonly description: "Get an API key for your ReadMe project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "[a-f\\d]{24}"; }; readonly in: "path"; readonly name: "api_key_id"; readonly required: true; readonly description: "The unique identifier for your API key."; }, { readonly schema: { readonly type: "string"; readonly pattern: "(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly maxLength: 30; }; readonly in: "path"; readonly name: "subdomain"; readonly required: true; readonly description: "The subdomain of your project."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly token: { readonly type: "string"; readonly pattern: "rdme_\\w+"; }; readonly label: { readonly type: "string"; readonly nullable: true; }; readonly last_accessed_on: { readonly type: "string"; readonly format: "date-time"; readonly nullable: true; readonly description: "An ISO 8601 formatted date for when the API key was last accessed."; }; readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the API key was created."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)\\/apikeys\\/[a-f\\d]{24}"; }; }; readonly required: ["token", "label", "last_accessed_on", "created_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; readonly patch: { readonly operationId: "updateAPIKey"; readonly summary: "Update an API key"; readonly tags: ["API Keys"]; readonly description: "Update an API key on your ReadMe project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly label: { readonly allOf: [{ readonly type: "string"; }, { readonly type: "string"; readonly minLength: 1; }]; }; }; readonly required: ["label"]; readonly additionalProperties: false; }; }; }; readonly required: true; }; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "[a-f\\d]{24}"; }; readonly in: "path"; readonly name: "api_key_id"; readonly required: true; readonly description: "The unique identifier for your API key."; }, { readonly schema: { readonly type: "string"; readonly pattern: "(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly maxLength: 30; }; readonly in: "path"; readonly name: "subdomain"; readonly required: true; readonly description: "The subdomain of your project."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly token: { readonly type: "string"; readonly pattern: "rdme_\\w+"; }; readonly label: { readonly type: "string"; readonly nullable: true; }; readonly last_accessed_on: { readonly type: "string"; readonly format: "date-time"; readonly nullable: true; readonly description: "An ISO 8601 formatted date for when the API key was last accessed."; }; readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the API key was created."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)\\/apikeys\\/[a-f\\d]{24}"; }; }; readonly required: ["token", "label", "last_accessed_on", "created_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/branches/{branch}/apis': { readonly get: { readonly operationId: "getAPIs"; readonly summary: "Get all API definitions"; readonly tags: ["APIs"]; readonly description: "Get all API definitions from your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly total: { readonly type: "number"; }; readonly data: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the API definition was created."; }; readonly filename: { readonly type: "string"; readonly description: "This is the unique identifier, its filename, for the API definition."; }; readonly source: { readonly type: "object"; readonly properties: { readonly current: { readonly type: "string"; readonly enum: ["api", "apidesigner", "apieditor", "bidi", "form", "postman", "rdme", "rdme_github", "url"]; }; readonly original: { readonly type: "string"; readonly enum: ["api", "apidesigner", "apieditor", "bidi", "form", "postman", "rdme", "rdme_github", "url"]; }; }; readonly required: ["current", "original"]; readonly additionalProperties: false; readonly description: "The sources by which this API definition was ingested."; }; readonly type: { readonly type: "string"; readonly enum: ["openapi", "postman", "swagger", "unknown"]; readonly description: "The type of API definition. This will be `unknown` if the API definition has either not yet been processed or failed with validation errors."; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the API definition was last updated."; }; readonly upload: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "string"; readonly enum: ["pending", "failed", "done", "pending_update", "failed_update"]; readonly description: "The status of the API definition upload."; }; readonly reason: { readonly type: "string"; readonly nullable: true; readonly description: "The reason for the upload failure if it failed."; }; readonly warnings: { readonly type: "string"; readonly nullable: true; readonly description: "Any fixable warnings that may exist within the API definition if the upload was ingested without errors."; }; }; readonly required: ["status", "reason", "warnings"]; readonly additionalProperties: false; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/apis\\/((([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+.(json|yaml|yml)))"; readonly description: "A URI to the API definition resource."; }; }; readonly required: ["created_at", "filename", "source", "type", "updated_at", "upload", "uri"]; readonly additionalProperties: false; }; }; }; readonly required: ["total", "data"]; readonly additionalProperties: false; }; }; }; }; }; }; readonly post: { readonly operationId: "createAPI"; readonly summary: "Create an API definition"; readonly tags: ["APIs"]; readonly description: "Create an API definition in the API Reference section of your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'multipart/form-data': { readonly schema: { readonly type: "object"; readonly properties: { readonly schema: { readonly description: "The API definition."; }; readonly upload_source: { readonly default: "form"; readonly description: "The source that the API definition is being uploaded through."; }; readonly url: { readonly description: "The URL where the API definition is hosted."; }; }; readonly additionalProperties: false; }; }; }; }; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '202': { readonly description: "Accepted"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly upload: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "string"; readonly enum: ["pending", "failed", "done", "pending_update", "failed_update"]; readonly description: "The status of the API definition upload."; }; }; readonly required: ["status"]; readonly additionalProperties: false; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/apis\\/((([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+.(json|yaml|yml)))"; readonly description: "A URI to the API definition resource."; }; }; readonly required: ["upload", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/branches/{branch}/apis/{filename}': { readonly get: { readonly operationId: "getAPI"; readonly summary: "Get an API definition"; readonly tags: ["APIs"]; readonly description: "Get an API definition from your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+.(json|yaml|yml))"; }; readonly in: "path"; readonly name: "filename"; readonly required: true; readonly description: "The filename of the API definition to retrieve."; }, { readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the API definition was created."; }; readonly filename: { readonly type: "string"; readonly description: "This is the unique identifier, its filename, for the API definition."; }; readonly source: { readonly type: "object"; readonly properties: { readonly current: { readonly type: "string"; readonly enum: ["api", "apidesigner", "apieditor", "bidi", "form", "postman", "rdme", "rdme_github", "url"]; }; readonly original: { readonly type: "string"; readonly enum: ["api", "apidesigner", "apieditor", "bidi", "form", "postman", "rdme", "rdme_github", "url"]; }; }; readonly required: ["current", "original"]; readonly additionalProperties: false; readonly description: "The sources by which this API definition was ingested."; }; readonly type: { readonly type: "string"; readonly enum: ["openapi", "postman", "swagger", "unknown"]; readonly description: "The type of API definition. This will be `unknown` if the API definition has either not yet been processed or failed with validation errors."; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the API definition was last updated."; }; readonly upload: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "string"; readonly enum: ["pending", "failed", "done", "pending_update", "failed_update"]; readonly description: "The status of the API definition upload."; }; readonly reason: { readonly type: "string"; readonly nullable: true; readonly description: "The reason for the upload failure if it failed."; }; readonly warnings: { readonly type: "string"; readonly nullable: true; readonly description: "Any fixable warnings that may exist within the API definition if the upload was ingested without errors."; }; }; readonly required: ["status", "reason", "warnings"]; readonly additionalProperties: false; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/apis\\/((([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+.(json|yaml|yml)))"; readonly description: "A URI to the API definition resource."; }; readonly schema: { readonly type: "object"; readonly additionalProperties: {}; readonly description: "The API schema."; }; }; readonly required: ["created_at", "filename", "source", "type", "updated_at", "upload", "uri", "schema"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; readonly delete: { readonly operationId: "deleteAPI"; readonly summary: "Delete an API definition"; readonly tags: ["APIs"]; readonly description: "Delete an API definition from the API Reference section of your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+.(json|yaml|yml))"; }; readonly in: "path"; readonly name: "filename"; readonly required: true; readonly description: "The filename of the API definition to retrieve."; }, { readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '204': { readonly description: "No Content"; }; }; }; readonly put: { readonly operationId: "updateAPI"; readonly summary: "Update an API definition"; readonly tags: ["APIs"]; readonly description: "Updates an API definition in the API Reference section of your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'multipart/form-data': { readonly schema: { readonly type: "object"; readonly properties: { readonly schema: { readonly description: "The API definition."; }; readonly upload_source: { readonly default: "form"; readonly description: "The source that the API definition is being uploaded through."; }; readonly url: { readonly description: "The URL where the API definition is hosted."; }; }; readonly additionalProperties: false; }; }; }; }; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+.(json|yaml|yml))"; }; readonly in: "path"; readonly name: "filename"; readonly required: true; readonly description: "The filename of the API definition to retrieve."; }, { readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '202': { readonly description: "Accepted"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly upload: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "string"; readonly enum: ["pending", "failed", "done", "pending_update", "failed_update"]; readonly description: "The status of the API definition upload."; }; }; readonly required: ["status"]; readonly additionalProperties: false; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/apis\\/((([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+.(json|yaml|yml)))"; readonly description: "A URI to the API definition resource."; }; }; readonly required: ["upload", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/apply': { readonly get: { readonly operationId: "getOpenRoles"; readonly summary: "Get open roles"; readonly tags: ["Apply to ReadMe"]; readonly description: "Returns all the roles we're hiring for at ReadMe!\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly security: []; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly total: { readonly type: "number"; }; readonly data: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; }; readonly description: { readonly type: "string"; readonly description: "The description for this open position. This content is formatted as HTML."; }; readonly pullquote: { readonly type: "string"; readonly description: "A short pullquote for the open position."; }; readonly location: { readonly type: "string"; readonly description: "Where this position is located at."; }; readonly department: { readonly type: "string"; readonly description: "The internal organization you'll be working in."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly description: "The place where you can apply for the position!"; }; }; readonly required: ["slug", "title", "description", "pullquote", "location", "department", "url"]; readonly additionalProperties: false; }; }; }; readonly required: ["total", "data"]; readonly additionalProperties: false; }; }; }; }; }; }; readonly post: { readonly operationId: "applyToReadMe"; readonly summary: "Submit your application!"; readonly tags: ["Apply to ReadMe"]; readonly description: "This endpoint will let you apply to a job at ReadMe programatically, without having to go through our UI!\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly minLength: 1; readonly description: "Your full name"; }; readonly email: { readonly type: "string"; readonly format: "email"; readonly default: "you@example.com"; readonly description: "A valid email we can reach you at."; }; readonly job: { readonly type: "string"; readonly description: "The job you're looking to apply for (https://readme.com/careers)."; }; readonly pronouns: { readonly type: "string"; readonly description: "Learn more at https://lgbtlifecenter.org/pronouns/"; }; readonly linkedin: { readonly type: "string"; readonly format: "uri"; readonly description: "What have you been up to the past few years?"; }; readonly github: { readonly type: "string"; readonly format: "uri"; readonly description: "Or Bitbucket, GitLab or anywhere else your code is hosted!"; }; readonly coverLetter: { readonly type: "string"; readonly description: "What should we know about you?"; }; readonly dont_really_apply: { readonly type: "boolean"; readonly default: false; readonly description: "If you set this to true, we will not actually apply you to the job."; }; }; readonly required: ["name", "job"]; readonly additionalProperties: false; }; }; }; readonly required: true; }; readonly security: []; readonly responses: { readonly '201': { readonly description: "Created"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly message: { readonly type: "string"; }; readonly keyvalues: { readonly type: "string"; }; readonly careers: { readonly type: "string"; }; readonly 'questions?': { readonly type: "string"; }; readonly poem: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }; readonly required: ["message", "keyvalues", "careers", "questions?", "poem"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/branches/{branch}/categories': { readonly post: { readonly operationId: "createCategory"; readonly summary: "Create a category"; readonly tags: ["Categories"]; readonly description: "Create a category in your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly title: { readonly type: "string"; readonly description: "The category's name."; }; readonly section: { readonly type: "string"; readonly enum: ["guide", "reference"]; readonly default: "guide"; readonly description: "The section of your documentation where the category resides."; }; }; readonly required: ["title"]; readonly additionalProperties: false; }; }; }; readonly required: true; }; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '201': { readonly description: "Created"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly title: { readonly type: "string"; readonly description: "The category's name."; }; readonly section: { readonly type: "string"; readonly enum: ["guide", "reference"]; readonly default: "guide"; readonly description: "The section of your documentation where the category resides."; }; readonly links: { readonly type: "object"; readonly properties: { readonly project: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project that this category belongs to."; }; }; readonly required: ["project"]; readonly additionalProperties: false; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/categories\\/(guides|reference)\\/((.*))"; readonly description: "A URI to the category resource."; }; }; readonly required: ["title", "links", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/branches/{branch}/categories/{section}/{title}': { readonly delete: { readonly operationId: "deleteCategory"; readonly summary: "Delete a category"; readonly tags: ["Categories"]; readonly description: "Delete a category from your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly enum: ["guides", "reference"]; readonly default: "guides"; }; readonly in: "path"; readonly name: "section"; readonly required: true; readonly description: "The section of your documentation where the category resides."; }, { readonly schema: { readonly type: "string"; }; readonly in: "path"; readonly name: "title"; readonly required: true; readonly description: "The category's name."; }, { readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '204': { readonly description: "No Content"; }; }; }; readonly patch: { readonly operationId: "updateCategory"; readonly summary: "Update a category"; readonly tags: ["Categories"]; readonly description: "Update an existing category in your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly title: { readonly type: "string"; readonly description: "The category's name."; }; readonly section: { readonly type: "string"; readonly enum: ["guide", "reference"]; readonly default: "guide"; readonly description: "The section of your documentation where the category resides."; }; readonly position: { readonly type: "number"; readonly description: "The position of the category in your project's sidebar."; }; }; readonly additionalProperties: false; }; }; }; }; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly enum: ["guides", "reference"]; readonly default: "guides"; }; readonly in: "path"; readonly name: "section"; readonly required: true; readonly description: "The section of your documentation where the category resides."; }, { readonly schema: { readonly type: "string"; }; readonly in: "path"; readonly name: "title"; readonly required: true; readonly description: "The category's name."; }, { readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly title: { readonly type: "string"; readonly description: "The category's name."; }; readonly section: { readonly type: "string"; readonly enum: ["guide", "reference"]; readonly default: "guide"; readonly description: "The section of your documentation where the category resides."; }; readonly links: { readonly type: "object"; readonly properties: { readonly project: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project that this category belongs to."; }; }; readonly required: ["project"]; readonly additionalProperties: false; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/categories\\/(guides|reference)\\/((.*))"; readonly description: "A URI to the category resource."; }; }; readonly required: ["title", "links", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/changelogs': { readonly post: { readonly operationId: "createChangelog"; readonly summary: "Create a changelog entry"; readonly tags: ["Changelog"]; readonly description: "Create a new changelog entry in your ReadMe project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly author: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the changelog was created."; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this changelog."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["none", "added", "fixed", "improved", "deprecated", "removed"]; readonly default: "none"; readonly description: "The type of changelog that this is."; }; }; readonly required: ["title"]; readonly additionalProperties: false; }; }; }; readonly required: true; }; readonly responses: { readonly '201': { readonly description: "Created"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly author: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly nullable: true; readonly description: "User ID of the changelog author."; }; readonly name: { readonly type: "string"; readonly nullable: true; readonly description: "Full name of the user who created the changelog."; }; }; readonly required: ["id", "name"]; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["body"]; readonly additionalProperties: false; }; readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the changelog was created."; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your changelog metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this changelog."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["none", "added", "fixed", "improved", "deprecated", "removed"]; readonly default: "none"; readonly description: "The type of changelog that this is."; }; readonly links: { readonly type: "object"; readonly properties: { readonly project: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project that this changelog belongs to."; }; }; readonly required: ["project"]; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the changelog was updated."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/changelogs\\/([a-f\\d]{24}|([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; }; }; readonly required: ["author", "content", "created_at", "metadata", "privacy", "slug", "title", "links", "updated_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; readonly get: { readonly operationId: "getChangelogs"; readonly summary: "Get all changelog entries"; readonly tags: ["Changelog"]; readonly description: "Get all changelog entries from your ReadMe project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "number"; readonly minimum: 1; readonly default: 1; }; readonly in: "query"; readonly name: "page"; readonly required: false; readonly description: "Used to specify further pages (starts at 1)."; }, { readonly schema: { readonly type: "number"; readonly minimum: 1; readonly maximum: 100; readonly default: 10; }; readonly in: "query"; readonly name: "per_page"; readonly required: false; readonly description: "Number of items to include in pagination (up to 100, defaults to 10)."; }, { readonly schema: { readonly type: "string"; readonly enum: ["public", "anyone_with_link", "all"]; readonly default: "all"; }; readonly in: "query"; readonly name: "visibility"; readonly required: false; readonly description: "The visibility setting (`privacy.view`) for the changelog entries you wish to retrieve. Defaults to `all`."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly total: { readonly type: "number"; }; readonly page: { readonly type: "number"; }; readonly per_page: { readonly type: "number"; }; readonly paging: { readonly type: "object"; readonly properties: { readonly next: { readonly type: "string"; readonly nullable: true; }; readonly previous: { readonly type: "string"; readonly nullable: true; }; readonly first: { readonly type: "string"; readonly nullable: true; }; readonly last: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["next", "previous", "first", "last"]; readonly additionalProperties: false; }; readonly data: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly author: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly nullable: true; readonly description: "User ID of the changelog author."; }; readonly name: { readonly type: "string"; readonly nullable: true; readonly description: "Full name of the user who created the changelog."; }; }; readonly required: ["id", "name"]; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["body"]; readonly additionalProperties: false; }; readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the changelog was created."; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your changelog metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this changelog."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["none", "added", "fixed", "improved", "deprecated", "removed"]; readonly default: "none"; readonly description: "The type of changelog that this is."; }; readonly links: { readonly type: "object"; readonly properties: { readonly project: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project that this changelog belongs to."; }; }; readonly required: ["project"]; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the changelog was updated."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/changelogs\\/([a-f\\d]{24}|([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; }; }; readonly required: ["author", "content", "created_at", "metadata", "privacy", "slug", "title", "links", "updated_at", "uri"]; readonly additionalProperties: false; }; }; }; readonly required: ["total", "page", "per_page", "paging", "data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/changelogs/{identifier}': { readonly get: { readonly operationId: "getChangelog"; readonly summary: "Get a changelog entry"; readonly tags: ["Changelog"]; readonly description: "Get a changelog entry from your ReadMe project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly anyOf: [{ readonly type: "string"; readonly pattern: "[a-f\\d]{24}"; readonly description: "A unique identifier for the resource."; }, { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; readonly description: "A URL-safe representation of the resource."; }]; }; readonly in: "path"; readonly name: "identifier"; readonly required: true; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly author: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly nullable: true; readonly description: "User ID of the changelog author."; }; readonly name: { readonly type: "string"; readonly nullable: true; readonly description: "Full name of the user who created the changelog."; }; }; readonly required: ["id", "name"]; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["body"]; readonly additionalProperties: false; }; readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the changelog was created."; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your changelog metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this changelog."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["none", "added", "fixed", "improved", "deprecated", "removed"]; readonly default: "none"; readonly description: "The type of changelog that this is."; }; readonly links: { readonly type: "object"; readonly properties: { readonly project: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project that this changelog belongs to."; }; }; readonly required: ["project"]; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the changelog was updated."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/changelogs\\/([a-f\\d]{24}|([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; }; }; readonly required: ["author", "content", "created_at", "metadata", "privacy", "slug", "title", "links", "updated_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; readonly delete: { readonly operationId: "deleteChangelog"; readonly summary: "Delete a changelog entry"; readonly tags: ["Changelog"]; readonly description: "Delete a changelog entry from your ReadMe project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly anyOf: [{ readonly type: "string"; readonly pattern: "[a-f\\d]{24}"; readonly description: "A unique identifier for the resource."; }, { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; readonly description: "A URL-safe representation of the resource."; }]; }; readonly in: "path"; readonly name: "identifier"; readonly required: true; }]; readonly responses: { readonly '204': { readonly description: "No Content"; }; }; }; readonly patch: { readonly operationId: "updateChangelog"; readonly summary: "Update a changelog entry"; readonly tags: ["Changelog"]; readonly description: "Update an existing changelog entry in your ReadMe project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly author: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly nullable: true; }; readonly name: { readonly type: "string"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the changelog was created."; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this changelog."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["none", "added", "fixed", "improved", "deprecated", "removed"]; readonly default: "none"; readonly description: "The type of changelog that this is."; }; }; readonly additionalProperties: false; }; }; }; }; readonly parameters: [{ readonly schema: { readonly anyOf: [{ readonly type: "string"; readonly pattern: "[a-f\\d]{24}"; readonly description: "A unique identifier for the resource."; }, { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; readonly description: "A URL-safe representation of the resource."; }]; }; readonly in: "path"; readonly name: "identifier"; readonly required: true; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly author: { readonly type: "object"; readonly properties: { readonly id: { readonly type: "string"; readonly nullable: true; readonly description: "User ID of the changelog author."; }; readonly name: { readonly type: "string"; readonly nullable: true; readonly description: "Full name of the user who created the changelog."; }; }; readonly required: ["id", "name"]; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["body"]; readonly additionalProperties: false; }; readonly created_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the changelog was created."; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your changelog metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this changelog."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["none", "added", "fixed", "improved", "deprecated", "removed"]; readonly default: "none"; readonly description: "The type of changelog that this is."; }; readonly links: { readonly type: "object"; readonly properties: { readonly project: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project that this changelog belongs to."; }; }; readonly required: ["project"]; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the changelog was updated."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/changelogs\\/([a-f\\d]{24}|([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; }; }; readonly required: ["author", "content", "created_at", "metadata", "privacy", "slug", "title", "links", "updated_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/branches/{branch}/custom_pages': { readonly post: { readonly operationId: "createCustomPage"; readonly summary: "Create a custom page"; readonly tags: ["Custom Pages"]; readonly description: "Create a custom page in your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly appearance: { readonly type: "object"; readonly properties: { readonly fullscreen: { readonly type: "boolean"; readonly default: false; readonly description: "Whether a html custom page is fullscreen or not."; }; }; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["markdown", "html"]; readonly default: "markdown"; readonly description: "The type of content contained in this custom page."; }; }; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this custom page."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["title"]; readonly additionalProperties: false; }; }; }; readonly required: true; }; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '201': { readonly description: "Created"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly appearance: { readonly type: "object"; readonly properties: { readonly fullscreen: { readonly type: "boolean"; readonly default: false; readonly description: "Whether a html custom page is fullscreen or not."; }; }; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["markdown", "html"]; readonly default: "markdown"; readonly description: "The type of content contained in this custom page."; }; }; readonly required: ["body"]; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your custom page metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this custom page."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly links: { readonly type: "object"; readonly properties: { readonly project: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project resource."; }; }; readonly required: ["project"]; readonly additionalProperties: false; }; readonly renderable: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "boolean"; readonly default: true; readonly description: "A flag for if the resource is renderable or not."; }; readonly error: { readonly type: "string"; readonly nullable: true; readonly description: "The rendering error."; }; readonly message: { readonly type: "string"; readonly nullable: true; readonly description: "Additional details about the rendering error."; }; }; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the custom page was updated."; readonly nullable: true; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/custom_pages\\/([a-f\\d]{24}|([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; }; }; readonly required: ["appearance", "content", "metadata", "privacy", "slug", "title", "links", "renderable", "updated_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; readonly get: { readonly operationId: "getCustomPages"; readonly summary: "Get all custom pages"; readonly tags: ["Custom Pages"]; readonly description: "Get all custom pages from your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly total: { readonly type: "number"; }; readonly data: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly appearance: { readonly type: "object"; readonly properties: { readonly fullscreen: { readonly type: "boolean"; readonly default: false; readonly description: "Whether a html custom page is fullscreen or not."; }; }; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["markdown", "html"]; readonly default: "markdown"; readonly description: "The type of content contained in this custom page."; }; }; readonly required: ["body"]; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your custom page metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this custom page."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly links: { readonly type: "object"; readonly properties: { readonly project: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project resource."; }; }; readonly required: ["project"]; readonly additionalProperties: false; }; readonly renderable: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "boolean"; readonly default: true; readonly description: "A flag for if the resource is renderable or not."; }; readonly error: { readonly type: "string"; readonly nullable: true; readonly description: "The rendering error."; }; readonly message: { readonly type: "string"; readonly nullable: true; readonly description: "Additional details about the rendering error."; }; }; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the custom page was updated."; readonly nullable: true; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/custom_pages\\/([a-f\\d]{24}|([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; }; }; readonly required: ["appearance", "content", "metadata", "privacy", "slug", "title", "links", "renderable", "updated_at", "uri"]; readonly additionalProperties: false; }; }; }; readonly required: ["total", "data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/branches/{branch}/custom_pages/{slug}': { readonly get: { readonly operationId: "getCustomPage"; readonly summary: "Get a custom page"; readonly tags: ["Custom Pages"]; readonly description: "Get a custom page from your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }, { readonly schema: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly in: "path"; readonly name: "slug"; readonly required: true; readonly description: "A URL-safe representation of the resource."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly appearance: { readonly type: "object"; readonly properties: { readonly fullscreen: { readonly type: "boolean"; readonly default: false; readonly description: "Whether a html custom page is fullscreen or not."; }; }; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["markdown", "html"]; readonly default: "markdown"; readonly description: "The type of content contained in this custom page."; }; }; readonly required: ["body"]; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your custom page metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this custom page."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly links: { readonly type: "object"; readonly properties: { readonly project: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project resource."; }; }; readonly required: ["project"]; readonly additionalProperties: false; }; readonly renderable: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "boolean"; readonly default: true; readonly description: "A flag for if the resource is renderable or not."; }; readonly error: { readonly type: "string"; readonly nullable: true; readonly description: "The rendering error."; }; readonly message: { readonly type: "string"; readonly nullable: true; readonly description: "Additional details about the rendering error."; }; }; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the custom page was updated."; readonly nullable: true; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/custom_pages\\/([a-f\\d]{24}|([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; }; }; readonly required: ["appearance", "content", "metadata", "privacy", "slug", "title", "links", "renderable", "updated_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; readonly delete: { readonly operationId: "deleteCustomPage"; readonly summary: "Delete a custom page"; readonly tags: ["Custom Pages"]; readonly description: "Delete a custom page from your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }, { readonly schema: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly in: "path"; readonly name: "slug"; readonly required: true; readonly description: "A URL-safe representation of the resource."; }]; readonly responses: { readonly '204': { readonly description: "No Content"; }; }; }; readonly patch: { readonly operationId: "updateCustomPage"; readonly summary: "Update a custom page"; readonly tags: ["Custom Pages"]; readonly description: "Update an existing custom page in your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly appearance: { readonly type: "object"; readonly properties: { readonly fullscreen: { readonly type: "boolean"; readonly default: false; readonly description: "Whether a html custom page is fullscreen or not."; }; }; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["markdown", "html"]; readonly default: "markdown"; readonly description: "The type of content contained in this custom page."; }; }; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this custom page."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly additionalProperties: false; }; }; }; }; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }, { readonly schema: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly in: "path"; readonly name: "slug"; readonly required: true; readonly description: "A URL-safe representation of the resource."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly appearance: { readonly type: "object"; readonly properties: { readonly fullscreen: { readonly type: "boolean"; readonly default: false; readonly description: "Whether a html custom page is fullscreen or not."; }; }; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["markdown", "html"]; readonly default: "markdown"; readonly description: "The type of content contained in this custom page."; }; }; readonly required: ["body"]; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your custom page metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; readonly description: "The visibility of this custom page."; }; }; readonly additionalProperties: false; }; readonly slug: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly links: { readonly type: "object"; readonly properties: { readonly project: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project resource."; }; }; readonly required: ["project"]; readonly additionalProperties: false; }; readonly renderable: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "boolean"; readonly default: true; readonly description: "A flag for if the resource is renderable or not."; }; readonly error: { readonly type: "string"; readonly nullable: true; readonly description: "The rendering error."; }; readonly message: { readonly type: "string"; readonly nullable: true; readonly description: "Additional details about the rendering error."; }; }; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the custom page was updated."; readonly nullable: true; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/custom_pages\\/([a-f\\d]{24}|([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; }; }; readonly required: ["appearance", "content", "metadata", "privacy", "slug", "title", "links", "renderable", "updated_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/branches/{branch}/guides': { readonly post: { readonly operationId: "createGuide"; readonly summary: "Create a guides page"; readonly tags: ["Guides"]; readonly description: "Create a page in the Guides section of your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly allow_crawlers: { readonly type: "string"; readonly enum: ["enabled", "disabled"]; readonly default: "enabled"; readonly description: "Allow indexing by robots."; }; readonly category: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/categories\\/(guides|reference)\\/((.*))"; readonly description: "A URI to the category resource."; }; }; readonly required: ["uri"]; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly excerpt: { readonly type: "string"; readonly nullable: true; }; readonly link: { readonly type: "object"; readonly properties: { readonly url: { readonly type: "string"; readonly nullable: true; }; readonly new_tab: { readonly type: "boolean"; readonly nullable: true; }; }; readonly additionalProperties: false; readonly description: "Information about where this page should redirect to; only available when `type` is `link`."; }; readonly next: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly pages: { readonly type: "array"; readonly items: { readonly anyOf: [{ readonly type: "object"; readonly properties: { readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["basic", "endpoint"]; }; }; readonly required: ["slug", "title", "type"]; readonly additionalProperties: false; }, { readonly type: "object"; readonly properties: { readonly title: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["link"]; }; readonly url: { readonly type: "string"; }; }; readonly required: ["title", "type", "url"]; readonly additionalProperties: false; }]; }; }; }; readonly additionalProperties: false; }; }; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly keywords: { readonly type: "string"; readonly nullable: true; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; }; }; readonly additionalProperties: false; }; }; readonly additionalProperties: false; }; readonly parent: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/(guides|reference)\\/(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; }; }; readonly additionalProperties: false; }; readonly slug: { readonly allOf: [{ readonly type: "string"; }, { readonly type: "string"; readonly minLength: 1; }]; readonly description: "The accessible URL slug for the page."; }; readonly state: { readonly type: "string"; readonly enum: ["current", "deprecated"]; readonly default: "current"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["api_config", "basic", "endpoint", "link", "webhook"]; readonly default: "basic"; }; readonly position: { readonly type: "number"; }; }; readonly required: ["category", "title"]; readonly additionalProperties: false; }; }; }; readonly required: true; }; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }]; readonly responses: { readonly '201': { readonly description: "Created"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly allow_crawlers: { readonly type: "string"; readonly enum: ["enabled", "disabled"]; readonly default: "enabled"; readonly description: "Allow indexing by robots."; }; readonly category: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/categories\\/(guides|reference)\\/((.*))"; readonly description: "A URI to the category resource."; }; }; readonly required: ["uri"]; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly excerpt: { readonly type: "string"; readonly nullable: true; }; readonly link: { readonly type: "object"; readonly properties: { readonly url: { readonly type: "string"; readonly nullable: true; }; readonly new_tab: { readonly type: "boolean"; readonly nullable: true; readonly description: "Should this URL be opened up in a new tab?"; }; }; readonly required: ["url", "new_tab"]; readonly additionalProperties: false; readonly description: "Information about where this page should redirect to; only available when `type` is `link`."; }; readonly next: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly pages: { readonly type: "array"; readonly items: { readonly anyOf: [{ readonly type: "object"; readonly properties: { readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["basic", "endpoint"]; }; }; readonly required: ["slug", "title", "type"]; readonly additionalProperties: false; }, { readonly type: "object"; readonly properties: { readonly title: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["link"]; }; readonly url: { readonly type: "string"; }; }; readonly required: ["title", "type", "url"]; readonly additionalProperties: false; }]; }; }; }; readonly required: ["description", "pages"]; readonly additionalProperties: false; }; }; readonly required: ["body", "excerpt", "link", "next"]; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your page metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly parent: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/(guides|reference)\\/(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; readonly nullable: true; readonly description: "A URI to the parent page resource including the page ID or slug."; }; }; readonly required: ["uri"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; }; }; readonly additionalProperties: false; }; readonly slug: { readonly allOf: [{ readonly type: "string"; }, { readonly type: "string"; readonly minLength: 1; }]; readonly description: "The accessible URL slug for the page."; }; readonly state: { readonly type: "string"; readonly enum: ["current", "deprecated"]; readonly default: "current"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["api_config", "basic", "endpoint", "link", "webhook"]; readonly default: "basic"; }; readonly href: { readonly type: "object"; readonly properties: { readonly dash: { readonly type: "string"; readonly format: "uri"; readonly description: "A URL to this page in your ReadMe Dash."; }; readonly hub: { readonly type: "string"; readonly format: "uri"; readonly description: "A URL to this page on your ReadMe hub."; }; }; readonly required: ["dash", "hub"]; readonly additionalProperties: false; }; readonly project: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "The name of the project."; }; readonly subdomain: { readonly type: "string"; readonly pattern: "[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*"; readonly maxLength: 30; readonly description: "The subdomain of the project."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project that this page belongs to."; }; }; readonly required: ["name", "subdomain", "uri"]; readonly additionalProperties: false; }; readonly renderable: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "boolean"; readonly default: true; readonly description: "A flag for if the resource is renderable or not."; }; readonly error: { readonly type: "string"; readonly nullable: true; readonly description: "The rendering error."; }; readonly message: { readonly type: "string"; readonly nullable: true; readonly description: "Additional details about the rendering error."; }; }; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the page was updated."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/(guides|reference)\\/(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; readonly description: "A URI to the page resource."; }; }; readonly required: ["category", "content", "metadata", "parent", "privacy", "slug", "title", "href", "project", "renderable", "updated_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/branches/{branch}/guides/{slug}': { readonly get: { readonly operationId: "getGuide"; readonly summary: "Get a guides page"; readonly tags: ["Guides"]; readonly description: "Get a page from the Guides section of your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }, { readonly schema: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly in: "path"; readonly name: "slug"; readonly required: true; readonly description: "A URL-safe representation of the resource."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly allow_crawlers: { readonly type: "string"; readonly enum: ["enabled", "disabled"]; readonly default: "enabled"; readonly description: "Allow indexing by robots."; }; readonly category: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/categories\\/(guides|reference)\\/((.*))"; readonly description: "A URI to the category resource."; }; }; readonly required: ["uri"]; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly excerpt: { readonly type: "string"; readonly nullable: true; }; readonly link: { readonly type: "object"; readonly properties: { readonly url: { readonly type: "string"; readonly nullable: true; }; readonly new_tab: { readonly type: "boolean"; readonly nullable: true; readonly description: "Should this URL be opened up in a new tab?"; }; }; readonly required: ["url", "new_tab"]; readonly additionalProperties: false; readonly description: "Information about where this page should redirect to; only available when `type` is `link`."; }; readonly next: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly pages: { readonly type: "array"; readonly items: { readonly anyOf: [{ readonly type: "object"; readonly properties: { readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["basic", "endpoint"]; }; }; readonly required: ["slug", "title", "type"]; readonly additionalProperties: false; }, { readonly type: "object"; readonly properties: { readonly title: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["link"]; }; readonly url: { readonly type: "string"; }; }; readonly required: ["title", "type", "url"]; readonly additionalProperties: false; }]; }; }; }; readonly required: ["description", "pages"]; readonly additionalProperties: false; }; }; readonly required: ["body", "excerpt", "link", "next"]; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your page metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly parent: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/(guides|reference)\\/(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; readonly nullable: true; readonly description: "A URI to the parent page resource including the page ID or slug."; }; }; readonly required: ["uri"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; }; }; readonly additionalProperties: false; }; readonly slug: { readonly allOf: [{ readonly type: "string"; }, { readonly type: "string"; readonly minLength: 1; }]; readonly description: "The accessible URL slug for the page."; }; readonly state: { readonly type: "string"; readonly enum: ["current", "deprecated"]; readonly default: "current"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["api_config", "basic", "endpoint", "link", "webhook"]; readonly default: "basic"; }; readonly href: { readonly type: "object"; readonly properties: { readonly dash: { readonly type: "string"; readonly format: "uri"; readonly description: "A URL to this page in your ReadMe Dash."; }; readonly hub: { readonly type: "string"; readonly format: "uri"; readonly description: "A URL to this page on your ReadMe hub."; }; }; readonly required: ["dash", "hub"]; readonly additionalProperties: false; }; readonly project: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "The name of the project."; }; readonly subdomain: { readonly type: "string"; readonly pattern: "[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*"; readonly maxLength: 30; readonly description: "The subdomain of the project."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project that this page belongs to."; }; }; readonly required: ["name", "subdomain", "uri"]; readonly additionalProperties: false; }; readonly renderable: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "boolean"; readonly default: true; readonly description: "A flag for if the resource is renderable or not."; }; readonly error: { readonly type: "string"; readonly nullable: true; readonly description: "The rendering error."; }; readonly message: { readonly type: "string"; readonly nullable: true; readonly description: "Additional details about the rendering error."; }; }; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the page was updated."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/(guides|reference)\\/(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; readonly description: "A URI to the page resource."; }; }; readonly required: ["category", "content", "metadata", "parent", "privacy", "slug", "title", "href", "project", "renderable", "updated_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; readonly delete: { readonly operationId: "deleteGuide"; readonly summary: "Delete a guides page"; readonly tags: ["Guides"]; readonly description: "Delete a page from the Guides section of your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }, { readonly schema: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly in: "path"; readonly name: "slug"; readonly required: true; readonly description: "A URL-safe representation of the resource."; }]; readonly responses: { readonly '204': { readonly description: "No Content"; }; }; }; readonly patch: { readonly operationId: "updateGuide"; readonly summary: "Update a guides page"; readonly tags: ["Guides"]; readonly description: "Updates an existing page in the Guides section of your ReadMe project.\n\n>📘\n> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly requestBody: { readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly allow_crawlers: { readonly type: "string"; readonly enum: ["enabled", "disabled"]; readonly default: "enabled"; readonly description: "Allow indexing by robots."; }; readonly category: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/categories\\/(guides|reference)\\/((.*))"; readonly description: "A URI to the category resource."; }; }; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly excerpt: { readonly type: "string"; readonly nullable: true; }; readonly link: { readonly type: "object"; readonly properties: { readonly url: { readonly type: "string"; readonly nullable: true; }; readonly new_tab: { readonly type: "boolean"; readonly nullable: true; }; }; readonly additionalProperties: false; readonly description: "Information about where this page should redirect to; only available when `type` is `link`."; }; readonly next: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly pages: { readonly type: "array"; readonly items: { readonly anyOf: [{ readonly type: "object"; readonly properties: { readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["basic", "endpoint"]; }; }; readonly required: ["slug", "title", "type"]; readonly additionalProperties: false; }, { readonly type: "object"; readonly properties: { readonly title: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["link"]; }; readonly url: { readonly type: "string"; }; }; readonly required: ["title", "type", "url"]; readonly additionalProperties: false; }]; }; }; }; readonly additionalProperties: false; }; }; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly keywords: { readonly type: "string"; readonly nullable: true; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; }; }; readonly additionalProperties: false; }; }; readonly additionalProperties: false; }; readonly parent: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/(guides|reference)\\/(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; readonly nullable: true; }; }; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; }; }; readonly additionalProperties: false; }; readonly slug: { readonly allOf: [{ readonly type: "string"; }, { readonly type: "string"; readonly minLength: 1; }]; readonly description: "The accessible URL slug for the page."; }; readonly state: { readonly type: "string"; readonly enum: ["current", "deprecated"]; readonly default: "current"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["api_config", "basic", "endpoint", "link", "webhook"]; readonly default: "basic"; }; readonly position: { readonly type: "number"; }; }; readonly additionalProperties: false; }; }; }; }; readonly parameters: [{ readonly schema: { readonly type: "string"; readonly pattern: "(v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?"; }; readonly in: "path"; readonly name: "branch"; readonly required: true; readonly description: "Project version number, `stable` for your project's stable version, or a valid branch name."; }, { readonly schema: { readonly type: "string"; readonly pattern: "([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+"; }; readonly in: "path"; readonly name: "slug"; readonly required: true; readonly description: "A URL-safe representation of the resource."; }]; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly allow_crawlers: { readonly type: "string"; readonly enum: ["enabled", "disabled"]; readonly default: "enabled"; readonly description: "Allow indexing by robots."; }; readonly category: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/categories\\/(guides|reference)\\/((.*))"; readonly description: "A URI to the category resource."; }; }; readonly required: ["uri"]; readonly additionalProperties: false; }; readonly content: { readonly type: "object"; readonly properties: { readonly body: { readonly type: "string"; readonly nullable: true; }; readonly excerpt: { readonly type: "string"; readonly nullable: true; }; readonly link: { readonly type: "object"; readonly properties: { readonly url: { readonly type: "string"; readonly nullable: true; }; readonly new_tab: { readonly type: "boolean"; readonly nullable: true; readonly description: "Should this URL be opened up in a new tab?"; }; }; readonly required: ["url", "new_tab"]; readonly additionalProperties: false; readonly description: "Information about where this page should redirect to; only available when `type` is `link`."; }; readonly next: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly pages: { readonly type: "array"; readonly items: { readonly anyOf: [{ readonly type: "object"; readonly properties: { readonly slug: { readonly type: "string"; }; readonly title: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["basic", "endpoint"]; }; }; readonly required: ["slug", "title", "type"]; readonly additionalProperties: false; }, { readonly type: "object"; readonly properties: { readonly title: { readonly type: "string"; readonly nullable: true; }; readonly type: { readonly type: "string"; readonly enum: ["link"]; }; readonly url: { readonly type: "string"; }; }; readonly required: ["title", "type", "url"]; readonly additionalProperties: false; }]; }; }; }; readonly required: ["description", "pages"]; readonly additionalProperties: false; }; }; readonly required: ["body", "excerpt", "link", "next"]; readonly additionalProperties: false; }; readonly metadata: { readonly type: "object"; readonly properties: { readonly description: { readonly type: "string"; readonly nullable: true; }; readonly image: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/images\\/([a-f\\d]{24})"; readonly nullable: true; readonly description: "A URI to the `getImages` endpoint for this image. If the is a legacy image then this `uri` will be `null`. And if you wish to delete this image then you should set this to `null`."; }; readonly url: { readonly type: "string"; readonly format: "uri"; readonly nullable: true; }; }; readonly required: ["uri", "url"]; readonly additionalProperties: false; }; readonly keywords: { readonly type: "string"; readonly nullable: true; readonly description: "A comma-separated list of keywords to place into your page metadata."; }; readonly title: { readonly type: "string"; readonly nullable: true; }; }; readonly required: ["description", "image", "keywords", "title"]; readonly additionalProperties: false; }; readonly parent: { readonly type: "object"; readonly properties: { readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/(guides|reference)\\/(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; readonly nullable: true; readonly description: "A URI to the parent page resource including the page ID or slug."; }; }; readonly required: ["uri"]; readonly additionalProperties: false; }; readonly privacy: { readonly type: "object"; readonly properties: { readonly view: { readonly type: "string"; readonly enum: ["public", "anyone_with_link"]; readonly default: "anyone_with_link"; }; }; readonly additionalProperties: false; }; readonly slug: { readonly allOf: [{ readonly type: "string"; }, { readonly type: "string"; readonly minLength: 1; }]; readonly description: "The accessible URL slug for the page."; }; readonly state: { readonly type: "string"; readonly enum: ["current", "deprecated"]; readonly default: "current"; }; readonly title: { readonly type: "string"; }; readonly type: { readonly type: "string"; readonly enum: ["api_config", "basic", "endpoint", "link", "webhook"]; readonly default: "basic"; }; readonly href: { readonly type: "object"; readonly properties: { readonly dash: { readonly type: "string"; readonly format: "uri"; readonly description: "A URL to this page in your ReadMe Dash."; }; readonly hub: { readonly type: "string"; readonly format: "uri"; readonly description: "A URL to this page on your ReadMe hub."; }; }; readonly required: ["dash", "hub"]; readonly additionalProperties: false; }; readonly project: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; readonly description: "The name of the project."; }; readonly subdomain: { readonly type: "string"; readonly pattern: "[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*"; readonly maxLength: 30; readonly description: "The subdomain of the project."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/projects\\/(me|[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)"; readonly description: "A URI to the project that this page belongs to."; }; }; readonly required: ["name", "subdomain", "uri"]; readonly additionalProperties: false; }; readonly renderable: { readonly type: "object"; readonly properties: { readonly status: { readonly type: "boolean"; readonly default: true; readonly description: "A flag for if the resource is renderable or not."; }; readonly error: { readonly type: "string"; readonly nullable: true; readonly description: "The rendering error."; }; readonly message: { readonly type: "string"; readonly nullable: true; readonly description: "Additional details about the rendering error."; }; }; readonly additionalProperties: false; }; readonly updated_at: { readonly type: "string"; readonly format: "date-time"; readonly description: "An ISO 8601 formatted date for when the page was updated."; }; readonly uri: { readonly type: "string"; readonly pattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/(guides|reference)\\/(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)"; readonly description: "A URI to the page resource."; }; }; readonly required: ["category", "content", "metadata", "parent", "privacy", "slug", "title", "href", "project", "renderable", "updated_at", "uri"]; readonly additionalProperties: false; }; }; readonly required: ["data"]; readonly additionalProperties: false; }; }; }; }; }; }; }; readonly '/outbound_ips': { readonly get: { readonly operationId: "getOutboundIPs"; readonly summary: "Get ReadMe's outbound IP addresses"; readonly tags: ["IP Addresses"]; readonly description: "Get all of ReadMe's IP addresses used for outbound webhook requests and the \"Try It!\" button on the API Explorer.\n\nAlthough ReadMe's outbound IP addresses may change, the IPs in this API response will be valid for at least 7 days. If you configure your API or webhooks to limit access based on these IPs, you should refresh the IP list from this endpoint weekly.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly security: []; readonly responses: { readonly '200': { readonly description: "List of current IP addresses used for webhook and \"Try It!\" proxy requests."; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly ip_address: { readonly type: "string"; readonly description: "The IP address."; }; }; readonly required: ["ip_address"]; readonly additionalProperties: false; }; }; }; readonly required: ["data"]; readonly additionalProperties: false; readonly description: "List of current IP addresses used for webhook and \"Try It!\" proxy requests."; }; }; }; }; }; }; }; readonly '/projects/me': { readonly get: { readonly operationId: "getProject"; readonly summary: "Get project metadata"; readonly tags: ["Projects"]; readonly description: "Returns data about your project.\n\n>🚧 ReadMe's API v2 is currently in beta.\n >This API and its documentation are a work in progress. While we don't expect any major breaking changes, you may encounter occasional issues as we work toward a stable release. Make sure to [check out our API migration guide](https://docs.readme.com/main/reference/api-migration-guide), and [feel free to reach out](mailto:support@readme.io) if you have any questions or feedback!"; readonly responses: { readonly '200': { readonly description: "OK"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly data: { readonly type: "object"; readonly properties: { readonly allow_crawlers: { readonly type: "string"; readonly enum: ["enabled", "disabled"]; readonly default: "enabled"; readonly description: "Allow indexing by robots."; }; readonly api_designer: { readonly type: "object"; readonly properties: { readonly allow_editing: { readonly type: "string"; readonly enum: ["enabled", "disabled"]; readonly default: "enabled"; readonly description: "API Designer is enabled for this project."; }; }; readonly additionalProperties: false; }; readonly appearance: { readonly type: "object"; readonly properties: { readonly brand: { readonly type: "object"; readonly properties: { readonly primary_color: { readonly type: "string"; readonly nullable: true; }; readonly link_color: { readonly type: "string"; readonly nullable: true; }; readonly theme: { readonly type: "string"; readonly enum: ["system", "light", "dark"]; readonly default: "light"; }; }; readonly required: ["primary_color", "link_color"]; readonly additionalProperties: false; }; readonly changelog: { readonly type: "object"; readonly properties: { readonly layout: { readonly type: "string"; readonly enum: ["collapsed", "continuous"]; readonly default: "collapsed"; }; readonly show_author: { readonly type: "boolean"; readonly default: true; readonly description: "Should the changelog author be shown?"; }; readonly show_exact_date: { readonly type: "boolean"; readonly default: false; readonly description: "Should the exact date of the changelog entry be shown, or should it be relative?"; }; }; readonly additionalProperties: false; }; readonly custom_code: { readonly type: "object"; readonly properties: { readonly css: { readonly type: "string"; readonly nullable: true; readonly description: "A chunk of custom CSS that you can use to override default CSS that we provide."; }; readonly js: { readonly type: "string"; readonly nullable: true; readonly description: "A chunk of custom JS that you can use to override or add new behaviors to your documentation. Please note that we do not do any validation on the code that goes in here so you have the potential to negatively impact your users with broken code."; }; readonly html: { readonly type: "object"; readonly properties: { readonly header: { readonly type: "string"; readonly nullable: true; readonly description: "A block of custom HTML that will be added to your `` tag. Good for things like `` tags or loading external CSS."; }; readonly home_footer: { readonly type: "string"; readonly nullable: true; readonly description: "A block of custom HTML that will appear in a `