@scalar/oas-utils/dist/spec-getters/get-parameters-from-operation.d.ts

Open API spec and Yaml handling utilities

import type { BaseParameter, TransformedOperation } from '@scalar/types/legacy';
/**
 * Get the query parameters from an operation.
 *
 * Example: [ { name: 'foobar', value: '' } ]
 *
 * - OpenAPI 3.x: Possible values are “query”, “header”, “path” or “cookie”.
 * - Swagger 2.0: Possible values are "query", "header", "path", "formData" or "body".
 */
export declare function getParametersFromOperation(operation: Omit<TransformedOperation, 'httpVerb'>, where: 'query' | 'header' | 'path' | 'cookie' | 'formData' | 'body', requiredOnly?: boolean): BaseParameter[];
//# sourceMappingURL=get-parameters-from-operation.d.ts.map