@scalar/api-reference/dist/helpers/openapi.d.ts

Generate beautiful API references from OpenAPI documents

import type { OpenApiDocument, OperationObject, ParameterObject, ReferenceType } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
/**
 * Extracts the request body from an operation.
 */
export declare function extractRequestBody(operation: OperationObject): string[] | null;
/**
 * Extracts parameters from an operation into searchable strings.
 */
export declare function extractParameters(parameters: ReferenceType<ParameterObject>[]): string[] | null;
/**
 * Deep merge for objects
 */
export declare function deepMerge(source: Record<any, any>, target: Record<any, any>): Record<any, any>;
/**
 * Creates an empty specification object.
 * The returning object has the same structure as a valid OpenAPI specification, but everything is empty.
 */
export declare function createEmptySpecification(partialSpecification?: Partial<OpenApiDocument>): OpenApiDocument;
//# sourceMappingURL=openapi.d.ts.map