rdme/dist/lib/types/index.d.ts

ReadMe's official CLI and GitHub Action.

import type { FromSchema } from 'json-schema-to-ts';
import readmeAPIv2Oas from './openapiDoc.js';
export declare const categoryUriRegexPattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/categories\\/(guides|reference)\\/((.*))";
export declare const parentUriRegexPattern: "\\/(versions|branches)\\/((v{0,1})(stable|([0-9]+)(?:\\.([0-9]+))?(?:\\.([0-9]+))?(-.*)?)(_(.*))?)\\/(guides|reference)\\/(([a-z0-9-_ ]|[^\\\\x00-\\\\x7F])+)";
type guidesRequestBodySchema = (typeof readmeAPIv2Oas)['paths']['/branches/{branch}/guides/{slug}']['patch']['requestBody']['content']['application/json']['schema'];
type guidesResponseBodySchema = (typeof readmeAPIv2Oas)['paths']['/branches/{branch}/guides/{slug}']['patch']['responses']['200']['content']['application/json']['schema'];
type projectSchema = (typeof readmeAPIv2Oas)['paths']['/projects/me']['get']['responses']['200']['content']['application/json']['schema'];
type apiKeySchema = (typeof readmeAPIv2Oas)['paths']['/projects/{subdomain}/apikeys/{api_key_id}']['get']['responses']['200']['content']['application/json']['schema'];
/**
 * Derived from our API documentation, this is the schema for the `guides` object
 * as we send it to the ReadMe API.
 *
 * This is only for TypeScript type-checking purposes — we use ajv
 * to validate the user's schema during runtime.
 */
export type GuidesRequestRepresentation = FromSchema<guidesRequestBodySchema, {
    keepDefaultedPropertiesOptional: true;
}>;
/**
 * Derived from our API documentation, this is the schema for the `guides` object
 * as we receive it to the ReadMe API.
 */
export type GuidesResponseRepresentation = FromSchema<guidesResponseBodySchema, {
    keepDefaultedPropertiesOptional: true;
}>;
/**
 * Derived from our API documentation, this is the schema for the `project` object
 * as we receive it to the ReadMe API.
 */
export type ProjectRepresentation = FromSchema<projectSchema, {
    keepDefaultedPropertiesOptional: true;
}>;
/**
 * Derived from our API documentation, this is the schema for the API key object
 * as we receive it to the ReadMe API.
 */
export type APIKeyRepresentation = FromSchema<apiKeySchema, {
    keepDefaultedPropertiesOptional: true;
}>;
export {};