@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
33 lines • 1.44 kB
TypeScript
import type { DiscriminatorObject, SchemaObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
import { type Component } from 'vue';
import type { SchemaOptions } from '../../../components/Content/Schema/types';
/**
* Note: We're taking in a prop called `value` which should be a JSON Schema.
*
* We're using `optimizeValueForDisplay` to merge null types in compositions (anyOf, allOf, oneOf, not).
* So you should basically use the optimizedValue everywhere in the component.
*/
type __VLS_Props = {
is?: string | Component;
schema: SchemaObject | undefined;
noncollapsible?: boolean;
level?: number;
name?: string;
required?: boolean;
compact?: boolean;
discriminator?: DiscriminatorObject;
description?: string;
hideModelNames?: boolean;
hideHeading?: boolean;
variant?: 'additionalProperties' | 'patternProperties';
breadcrumb?: string[];
options: SchemaOptions;
};
declare const _default_1: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
level: number;
required: boolean;
compact: boolean;
hideModelNames: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
export default _default_1;
//# sourceMappingURL=SchemaProperty.vue.d.ts.map