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

Doctor Doom making docs.

import type { OpenAPIV3_1 } from 'openapi-types';
export interface OpenAPIRefProps {
    /**
     * The schema name under the OpenAPI schema `definitions` (swagger 2.0) or `components/schemas` (openapi 3.x).
     */
    schema: string;
    /**
     * The specific path to the OpenAPI schema, otherwise the first matched will be used.
     */
    openapiPath?: string;
    /**
     * Whether is a common reference, no `uid` will be generated.
     *
     * @default true
     */
    isCommonRef?: boolean;
    /**
     * Whether to collect references from the schema.
     *
     * @default true
     */
    collectRefs?: boolean;
}
export declare const OpenAPIProperty: ({ name, property, openapi, }: {
    name?: string;
    property: OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.SchemaObject;
    openapi: OpenAPIV3_1.Document;
}) => import("react/jsx-runtime").JSX.Element;
export declare const OpenAPIProperties: ({ properties, openapi, }: {
    properties: Record<string, OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.SchemaObject>;
    openapi: OpenAPIV3_1.Document;
}) => import("react/jsx-runtime").JSX.Element;
export declare const OpenAPIRef: ({ schema, openapiPath: openapiPath_, isCommonRef, collectRefs, }: OpenAPIRefProps) => import("react/jsx-runtime").JSX.Element | null;
export default OpenAPIRef;