@scalar/api-client
Version:
the open source API testing client
25 lines • 1.1 kB
TypeScript
import type { OperationObject, ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
import type { Request as HarRequest } from 'har-format';
type ProcessedParameters = {
url: string;
headers: HarRequest['headers'];
queryString: HarRequest['queryString'];
cookies: HarRequest['cookies'];
};
/** Ensures we don't have any references in the parameters */
export declare const deReferenceParams: (params: OperationObject["parameters"]) => ParameterObject[];
/**
* Process OpenAPI parameters and return the updated properties.
* Handles path, query, and header parameters with various styles and explode options.
*
* @see https://spec.openapis.org/oas/latest.html#style-values
*/
export declare const processParameters: ({ harRequest, parameters, example, contentType, }: {
harRequest: HarRequest;
parameters: OperationObject["parameters"];
/** The name of the example to use */
example?: string | undefined;
contentType?: string | undefined;
}) => ProcessedParameters;
export {};
//# sourceMappingURL=process-parameters.d.ts.map