@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
36 lines • 1.93 kB
TypeScript
import type { ClientOptionGroup } from '@scalar/api-client/v2/blocks/operation-code-sample';
import type { Collection, Server } from '@scalar/oas-utils/entities/spec';
import type { WorkspaceStore } from '@scalar/workspace-store/client';
import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
import type { PathsObject, SecurityRequirementObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
type __VLS_Props = {
level?: number;
hash: string;
rootIndex: number;
entries: TraversedEntry[];
/** The path entries from the document `document.paths` */
paths: PathsObject;
/** The webhook path entries from the document `document.webhooks` */
webhooks: PathsObject;
/** The security requirements from the document `document.security` */
security: SecurityRequirementObject[] | undefined;
activeCollection: Collection;
activeServer: Server | undefined;
store: WorkspaceStore;
options: {
layout: 'classic' | 'modern';
showOperationId: boolean | undefined;
hideTestRequestButton: boolean | undefined;
expandAllResponses: boolean | undefined;
clientOptions: ClientOptionGroup[];
orderRequiredPropertiesFirst: boolean | undefined;
orderSchemaPropertiesBy: 'alpha' | 'preserve' | undefined;
onShowMore: ((id: string) => void) | undefined;
};
};
declare const _default: import("vue").DefineComponent<__VLS_Props, {
currentIndex: import("vue").ComputedRef<number>;
isLazy: (entry: TraversedEntry, index: number) => "after" | "prev" | null;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
export default _default;
//# sourceMappingURL=TraversedEntry.vue.d.ts.map