@scalar/api-client
Version:
the open source API testing client
16 lines • 653 B
TypeScript
import type { ParameterObject, ReferenceType } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
type ValidatePathParametersResult = {
ok: true;
} | {
ok: false;
invalidParams: string[];
};
/**
* Validates that all required path parameters have non-empty values.
*
* Path parameters are always required per the OpenAPI specification.
* Returns the names of any path parameters that are missing values.
*/
export declare const validatePathParameters: (parameters?: ReferenceType<ParameterObject>[], exampleKey?: string) => ValidatePathParametersResult;
export {};
//# sourceMappingURL=validate-path-parameters.d.ts.map