@alauda/doom
Version:
Doctor Doom making docs.
26 lines (25 loc) • 1.09 kB
TypeScript
import { type OpenAPIV3_1 } from 'openapi-types';
export interface OpenAPIPathProps {
/**
* The path under the OpenAPI schema `paths` definition.
*/
path: 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 declare const OpenAPIPath: ({ path, openapiPath: openapiPath_, pathPrefix: pathPrefix_, }: OpenAPIPathProps) => import("react/jsx-runtime").JSX.Element | null;
export default OpenAPIPath;