Skip to content

Releases: Azure/oav

0.4.34

08 Mar 23:31
4d1ec11
Compare
Choose a tag to compare
  • Updating default output level to info.
  • Fixing issue #225, where output verbosity wasn't respected in one case.

0.4.25

30 Jan 21:53
4459e37
Compare
Choose a tag to compare
  • Fixed a typo in the variable name while resolving nullable types #200.

0.4.24

30 Jan 21:50
aafa1f6
Compare
Choose a tag to compare
  • The tool does not error on missing definitions in the swagger spec #194
  • Added support for application/octet-stream or file upload/download scenarios #192

0.4.23

05 Jan 22:40
0e1a460
Compare
Choose a tag to compare
  • Addressing 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.

0.4.22

12 Dec 02:45
67f286b
Compare
Choose a tag to compare
  • Added support to generate class diagram from a given swagger spec #188.
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.

Examples

  1. Generating a full class diagram that contains property definition, allOf references and model references
oav generate-uml <spec-path>
  1. Generating a class diagram that contains only allOf references between models. Helpful for understanding the inheritance relationship.
oav generate-uml -pr <spec-path>
  1. Generating a class diagram that contains only references between models. Helpful for understanding the association between models.
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".

0.4.20

21 Nov 21:34
18461be
Compare
Choose a tag to compare

0.4.19

21 Nov 21:34
28fe64e
Compare
Choose a tag to compare

Added support for validating examples for parameters "in": "formData".

0.4.7

12 Jul 00:50
Compare
Choose a tag to compare

Installation: npm install -g oav

  • Fixed Live validator for reorg branch of azure-rest-api-specs #137

0.4.6

03 Jul 23:43
Compare
Choose a tag to compare

Installation: npm install -g oav

0.4.5

26 Jun 20:59
Compare
Choose a tag to compare

Installation: npm install -g oav

  • Added support to generate wireformat as a YAML doc
  • Improved the format to specify request body for a in a request using curl.