0.15.4 • Published 6 months ago
@types/ibm-openapi-validator v0.15.4
Installation
npm install --save @types/ibm-openapi-validator
Summary
This package contains type definitions for ibm-openapi-validator (https://github.com/IBM/openapi-validator#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ibm-openapi-validator.
index.d.ts
// Type definitions for ibm-openapi-validator 0.15
// Project: https://github.com/IBM/openapi-validator#readme
// Definitions by: Rifa Achrinza <https://github.com/achrinza>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.0
interface validatorResultItem {
path: string;
message: string;
}
interface validatorResult {
errors: [] | [ validatorResultItem ];
warnings: [] | [ validatorResultItem ];
}
/**
* @default false
*/
type validatorParameterDefaultMode = boolean;
/**
* OpenAPI document validator
* @param openApiDoc - OpenAPI document object
* @param defaultMode - If set to true, the validator will ignore the .validaterc file and will use the [configuration defaults](https://github.com/IBM/openapi-validator#default-values).
* @returns Validation results
*/
declare function validator(openApiDoc: {[property: string]: any}, defaultMode?: validatorParameterDefaultMode): Promise<validatorResult>;
export = validator;
Additional Details
- Last updated: Thu, 08 Jul 2021 22:41:05 GMT
- Dependencies: none
- Global values: none
Credits
These definitions were written by Rifa Achrinza.