Chores:
- Upgrading cargo dist to 0.21.1
New Features:
- Added support for generating files for responses that do not contain an application/json mimetype. Previously, heave would skip anything that wasn't application/json. However it seems useful to generate files for these and just skip generating any asserts. Chores:
- Fixing some lints after upgrading Rust version
New Features:
--include-operation-ids--include-status-codes--include-paths
Each of these take a regex input to help you filter generation to exactly what you're looking for. Specifying multiple or all of these together can be used to target a single response from an operation. As an example you could run:
heave generate --include-paths '^/pets$' --include-operation-ids 'addPet' --include-status-codes '200' petstore.json output
This would generate a single hurl file for the 200 response of the addPet operation.
Please reference heave generate --help for more examples.
Bug Fixes:
- Fixed a bug where --only-new did not filter outputs at all. This was due to how the matching of the output name and the existing file was implemented. Now we're checking that the existing file ends with the output name instead of checking if they are equal.
New Features:
- Added support for readOnly and writeOnly properties on schemas. This will affect how asserts and request bodies are generated. If a schema is readOnly, it will be absent from the generated request body. If a schema is writeOnly, it will be absent from the generated asserts.
Bug Fixes:
- This release adds cycle detection to response and request bodies. This should prevent infinite loops when a schema references itself or another schema that references the original schema. At this time, the detection only looks for the name of the field so it is possible for false positives to be detected.
New Features:
- Added a new flag (--only-new) prevents this tool from overwriting existing files. This is useful when you write your spec, make changes to the generated files, iterate on the spec, and only want to generate files for the changes.
Chores:
- Updated cargo-dist to 0.18.0
Bug Fixes:
- Fixed a panic when trying to resolve request bodies for anyOf. It was possible for the schemas involved to result in no child request bodies. This happened when an allOf referenced a schema that was
Anybut this could have happened withAnyOf,Not, orOneOfas well. Now the field will be absent from the request body altogether, which matches existing behavior when an unsupported schema type is encountered.
New features:
- Support for the allOf attribute. This should generate a hurl request body as well as asserts.
New features:
- Diagnostics
- Diagnostics allow users to see issues that this application ran into while trying to parse their spec. This may include malformed references, unsupported kinds, and failing to find an application/json media type (among others). Use the new
--show-diagnosticsflag to print them. If they exist bug the flag isn't enabled, a stderr message will appear letting you know that you can re-run the command.
- Diagnostics allow users to see issues that this application ran into while trying to parse their spec. This may include malformed references, unsupported kinds, and failing to find an application/json media type (among others). Use the new
Bug Fixes:
- Fixed an issue where hurl files would not be generated if a request body didn't have an application/json media type
New features:
- Adds support for Media Types that start with "application/json". This was required to support specs that use "application/json;charset=utf-8".
- Add the ability to look up a references Schema inside a Response. Previously this application assumed the schema would be defined inline with the response.
New features:
- Adds support for json specs
Chores:
- Add tests to make sure the output from json specs matches yaml specs
🚨🚨 Breaking change🚨🚨:
- File generation is now behind the
generatesubcommand. - Please use
heave generate <spec> <output>
New features:
templatesubcommandheave templatenow prints the default template
generatesubcommand- takes
--templateoption for custom template
- takes
Chores:
- Add Getting Started section to README
New features:
- Asserts are generated for schemas inside arrays now. Previously the only assert that was created was whether or not it was a collection. Now the schema is analyzed and asserts are generated for the first item in that array.
- Optional response fields are now generated with commented out asserts. This felt like a reasonable compromise since the spec doesn't guarantee that those fields will be present. The behavior works like this:
- If the name of the field is in the objects required attribute, it will generate with a non-commented out assert
- If the name of the field is not in the objects required attribute, it will not generate with a non-commented out assert
- If an object is optional, all of it's children asserts will be commented out
- If generating asserts for the items in an array, all of those will be commented out because the list could be empty
Bug Fixes:
- Better JSON pretty printing for request bodies.
Chores:
- Added cargo-insta for snapshot testing. This should make it easy to accumulate some specs and verify the outputs come out as expected
- Added GitHub action for CI to automate test running.
New features:
- Slight improvement of documentation. This will be helpful when I actually write a decent README.
- Fixed panic
- The request_body generation assumed that Strings, Numbers, Integers, and Booleans would always have a name associated with them. This isn't the case when you have an Array of these types though.
New features:
- Added support for request bodies. The schema should be recursively generated in the hurl file with empty strings or 0.
Initial Release! Here are some things that seem to work:
- Successfully parses OpenAPI parameters for every operation
- Path Parameters are included in hurl files as variables
- Query Parameters are available under the [QueryStringParams] section
- Header Params are also included
- Asserts are included based off schema definition for each response