Tools for validating OpenAPI (Swagger) files.
info
.INVALID_TYPE
issues reported by model validation due to nullable types/properties. #155. In order to allow null types, we relax types to be 'oneOf'
null
or its type
, for the cases where properties/models have x-nullable
set or x-nullable
is not defined and property is not required.D:\>oav generate-uml -h
oav generate-uml <spec-path>
Options:
--version Show version number [boolean]
-l, --logLevel Set the logging level for console.
[choices: "off", "json", "error", "warn", "info", "verbose", "debug", "silly"]
[default: "warn"]
-f, --logFilepath Set the log file path. It must be an absolute
filepath. By default the logs will stored in a
timestamp based log file at
"C:\Users\amzavery\oav_output".
-d, --outputDir Output directory where the class diagram will be
stored. [string] [default: "./"]
-p, --disableProperties Should model properties not be generated?
[boolean] [default: false]
-a, --disableAllof Should allOf references not be generated?
[boolean] [default: false]
-r, --disableRefs Should model references not be generated?
[boolean] [default: false]
-i, --direction The direction of the generated diagram:
"TB" - TopToBottom (default),
"LR" - "LeftToRight",
"RL" - "RightToLeft"
[string] [choices: "TB", "LR", "RL"] [default: "TB"]
-h, --help Show help [boolean]
Please open the generated svg in a browser of your choice.
oav generate-uml <spec-path>
allOf
references between models. Helpful for understanding the inheritance relationship.oav generate-uml -pr <spec-path>
oav generate-uml -pa <spec-path>
NOTE: For better visualization you can specify the direction in which the uml should be generated. TopBottom "TB" is the default. Other values are "LR" and "RL".
"x-ms-parameterized-host": {}
extension if present in the 2.0 swagger spec.Added support for validating examples for parameters "in": "formData".