fumadocs-openapi 3.2.0 → 4.0.0

package/dist/playground-D8pYn13F.d.ts

@@ -0,0 +1,52 @@
+interface BaseRequestField {
+    name: string;
+    description?: string;
+}
+interface BaseSchema {
+    description?: string;
+    isRequired: boolean;
+}
+type PrimitiveRequestField = BaseRequestField & PrimitiveSchema;
+interface PrimitiveSchema extends BaseSchema {
+    type: 'boolean' | 'string' | 'number';
+    defaultValue: string;
+}
+interface ReferenceSchema extends BaseSchema {
+    type: 'ref';
+    schema: string;
+}
+interface ArraySchema extends BaseSchema {
+    type: 'array';
+    /**
+     * Reference to item schema or the schema
+     */
+    items: string | RequestSchema;
+}
+interface ObjectSchema extends BaseSchema {
+    type: 'object';
+    properties: Record<string, ReferenceSchema>;
+    /**
+     * Reference to schema, or true if it's `any`
+     */
+    additionalProperties?: boolean | string;
+}
+interface SwitcherSchema extends BaseSchema {
+    type: 'switcher';
+    items: Record<string, ReferenceSchema | RequestSchema>;
+}
+interface NullSchema extends BaseSchema {
+    type: 'null';
+}
+type RequestSchema = PrimitiveSchema | ArraySchema | ObjectSchema | SwitcherSchema | NullSchema;
+interface APIPlaygroundProps {
+    route: string;
+    method: string;
+    authorization?: PrimitiveRequestField;
+    path?: PrimitiveRequestField[];
+    query?: PrimitiveRequestField[];
+    header?: PrimitiveRequestField[];
+    body?: RequestSchema;
+    schemas: Record<string, RequestSchema>;
+}
+
+export type { APIPlaygroundProps as A, PrimitiveRequestField as P, RequestSchema as R, ReferenceSchema as a };