@scalar/api-reference
Version:
Generate beautiful API references from OpenAPI documents
36 lines • 2.18 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 { HttpMethod } from '@scalar/helpers/http/http-methods';
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 { OpenApiDocument, PathItemObject, ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
/**
* References Operation "block"
*/
declare const _default: import("vue").DefineComponent<OperationProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<OperationProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
export default _default;
export type OperationProps = {
id: string;
method: HttpMethod;
/** The subset of the configuration object required for the operation component */
options: Pick<ApiReferenceConfigurationRaw, 'expandAllResponses' | 'hideTestRequestButton' | 'layout' | 'orderRequiredPropertiesFirst' | 'orderSchemaPropertiesBy' | 'showOperationId'>;
/** Document object */
document: OpenApiDocument;
/** Key of the operations path in the document.paths object */
path: string;
/** OpenAPI path object that will include the operation */
pathValue: PathItemObject | undefined;
/** Currently selected server for the document */
server: ServerObject | null;
/** The merged security schemes for the document and the authentication configuration */
securitySchemes: MergedSecuritySchemes;
/** The http client options for the dropdown */
clientOptions: ClientOptionGroup[];
/** Whether the Classic layout operation is collapsed */
isCollapsed: boolean;
isWebhook: boolean;
selectedClient: WorkspaceStore['workspace']['x-scalar-default-client'];
eventBus: WorkspaceEventBus;
};
//# sourceMappingURL=Operation.vue.d.ts.map