@scalar/api-client/dist/v2/blocks/request-block/helpers/is-param-disabled.d.ts

the open source API testing client

import type { ExampleObject, ParameterObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
/**
 * Determines if a parameter is disabled
 *
 * First we explicitly check if its been disabled via the `x-disabled` extension.
 * Then we check if its an optional parameter and not a path parameter.
 *
 * @param param - The parameter to check.
 * @param example - The example to check.
 * @returns true if the parameter is disabled, false otherwise.
 */
export declare const isParamDisabled: (param: ParameterObject, example: ExampleObject | undefined) => boolean;
//# sourceMappingURL=is-param-disabled.d.ts.map