@scalar/api-client/dist/v2/features/command-palette/helpers/get-operation-from-curl.d.ts

the open source API testing client

import type { HttpMethod } from '@scalar/helpers/http/http-methods';
import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
/**
 * Represents the result of parsing a cURL command into an OpenAPI operation.
 */
type CurlOperationResult = {
    /** The URL path extracted from the cURL command. */
    path: string;
    /** The HTTP method (GET, POST, etc.). */
    method: HttpMethod;
    /** The OpenAPI operation object with parameters, body, and servers. */
    operation: OperationObject;
};
/**
 * Converts a cURL command string into an OpenAPI operation object.
 *
 * This function parses a cURL command and extracts all relevant information
 * (path, method, headers, query parameters, request body) to create a complete
 * OpenAPI operation that can be used to populate a request in the API client.
 *
 * The exampleKey is used to namespace the example values in the operation object,
 * allowing multiple examples to coexist if needed.
 */
export declare const getOperationFromCurl: (curl: string, exampleKey?: string) => CurlOperationResult;
export {};
//# sourceMappingURL=get-operation-from-curl.d.ts.map