@scalar/api-reference/dist/features/Operation/Operation.vue.d.ts

Generate beautiful API references from OpenAPI documents

import type { ClientOptionGroup } from '@scalar/api-client/v2/blocks/operation-code-sample';
import type { HttpMethod } from '@scalar/helpers/http/http-methods';
import type { Collection, Server } from '@scalar/oas-utils/entities/spec';
import type { WorkspaceStore } from '@scalar/workspace-store/client';
import type { PathItemObject, SecurityRequirementObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
type __VLS_Props = {
    id: string;
    method: HttpMethod;
    /** Key of the operations path in the document.paths object */
    path: string;
    /** OpenAPI path object that will include the operation */
    pathValue: PathItemObject | undefined;
    /** Active server*/
    server: Server | undefined;
    /** Document level security requirements */
    security: SecurityRequirementObject[] | undefined;
    store: WorkspaceStore;
    /** @deprecated Use `document` instead, we just need the selected security scheme uids for now */
    collection: Collection;
    options: {
        layout: 'classic' | 'modern';
        /** Sets some additional display properties when an operation is a webhook */
        isWebhook: boolean;
        showOperationId: boolean | undefined;
        hideTestRequestButton: boolean | undefined;
        expandAllResponses: boolean | undefined;
        clientOptions: ClientOptionGroup[];
        orderRequiredPropertiesFirst: boolean | undefined;
        orderSchemaPropertiesBy: 'alpha' | 'preserve' | undefined;
    };
};
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=Operation.vue.d.ts.map