@alauda/doom/lib/runtime/components/OpenAPIPath.d.ts

Doctor Doom making docs.

import BananaSlug from '@rspress/shared/github-slugger';
import { type OpenAPIV3_1 } from 'openapi-types';
export interface OpenAPIPathProps {
    /**
     * The path or paths under the OpenAPI schema `paths` definition.
     */
    path: string | string[];
    /**
     * The specific path to the OpenAPI schema, otherwise the first matched will be used.
     */
    openapiPath?: string;
    /**
     * If you have a gateway which adds common path prefix, can be used to override global config level `pathPrefix`.
     */
    pathPrefix?: string;
}
export declare const OpenAPIParameters: ({ parameters, openapi, }: {
    parameters: Array<OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ParameterObject>;
    openapi: OpenAPIV3_1.Document;
}) => import("react/jsx-runtime").JSX.Element;
export declare const OpenAPIResponses: ({ responses, openapi, }: {
    responses: OpenAPIV3_1.ResponsesObject;
    openapi: OpenAPIV3_1.Document;
}) => import("react/jsx-runtime").JSX.Element;
export interface OpenAPIPathBaseProps extends Omit<OpenAPIPathProps, 'openapiPath'> {
    path: string;
    pathItem?: OpenAPIV3_1.PathItemObject;
    openapi?: OpenAPIV3_1.Document;
    slugger: BananaSlug;
}
export declare const OpenAPIPath: ({ path, openapiPath, pathPrefix, }: OpenAPIPathProps) => import("react/jsx-runtime").JSX.Element;
export default OpenAPIPath;