@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
22 lines • 941 B
TypeScript
import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
export type EntryType = 'operation' | 'webhook' | 'model' | 'heading' | 'tag';
export type FuseData = {
type: EntryType;
id: string;
title: string;
description: string;
/** Top-level request-body property names (e.g. `email`, `username`). High-signal field for search. */
body?: string | string[];
/** Descriptions of request-body properties. Verbose prose, weighted lower than `body`. */
bodyDescriptions?: string[];
/** Parameter names (e.g. `userId`, `limit`). High-signal field for search. */
parameters?: string | string[];
/** Descriptions of parameters. Verbose prose, weighted lower than `parameters`. */
parameterDescriptions?: string[];
responseExamples?: string[];
method?: string;
path?: string;
operationId?: string;
entry: TraversedEntry;
};
//# sourceMappingURL=types.d.ts.map