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

1interface validatorResultItem {
2    path: string;
3    message: string;
4}
5
6interface validatorResult {
7    errors: [] | [validatorResultItem];
8    warnings: [] | [validatorResultItem];
9}
10
11/**
12 * @default false
13 */
14type validatorParameterDefaultMode = boolean;
15
16/**
17 * OpenAPI document validator
18 * @param openApiDoc - OpenAPI document object
19 * @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).
20 * @returns Validation results
21 */
22declare function validator(
23    openApiDoc: { [property: string]: any },
24    defaultMode?: validatorParameterDefaultMode,
25): Promise<validatorResult>;
26
27export = validator;
28

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: none

Credits

These definitions were written by Rifa Achrinza.