@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
33 lines • 2.19 kB
TypeScript
import type { ClientOptionGroup } from '@scalar/api-client/v2/blocks/operation-code-sample';
import type { MergedSecuritySchemes } from '@scalar/api-client/v2/blocks/scalar-auth-selector-block';
import type { ApiReferenceConfigurationRaw } from '@scalar/types/api-reference';
import type { WorkspaceStore } from '@scalar/workspace-store/client';
import type { WorkspaceEventBus } from '@scalar/workspace-store/events';
import type { WorkspaceDocument } from '@scalar/workspace-store/schemas';
import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
import type { ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
type __VLS_Props = {
/** The level of depth */
level?: number;
/** Traversed entries to render */
entries: TraversedEntry[];
/** The document object */
document: WorkspaceDocument;
/** The http client options for the dropdown */
clientOptions: ClientOptionGroup[];
/** The subset of the configuration object required for the operation component */
options: Pick<ApiReferenceConfigurationRaw, 'expandAllResponses' | 'hideTestRequestButton' | 'layout' | 'orderRequiredPropertiesFirst' | 'orderSchemaPropertiesBy' | 'showOperationId'>;
/** Currently selected server for the document */
selectedServer: ServerObject | null;
/** The merged security schemes for the document and the authentication configuration */
securitySchemes: MergedSecuritySchemes;
/** Currently selected http client for the document */
selectedClient: WorkspaceStore['workspace']['x-scalar-default-client'];
/** Used to determine if an entry is collapsed */
expandedItems: Record<string, boolean>;
/** The event bus for the handling all events. */
eventBus: WorkspaceEventBus;
};
declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, 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