releases.md

Release notes

OpenApiTools v2.0.1

Bugfixes

• Moved header sanitazion to ensure it's always applied.
  • This closes issue #137: Error on DataValidationError.

Previous versions

OpenApiTools v2.0.0

Major changes and new features

• Request bodies now support all JSON types, not just objects (dicts).
  • This closes issue #9: No body generated when root is a list.
  • Some of the Relations still need to be reworked to (fully) align with this change.
• Refactored retrieving / loading of the OpenAPI spec.
  • This closes issue #93: SSL error even if cert / verify is set.
• Added keywords to make it easier to work with the RequestValues object:
  • Get Request Values Object can be used to create a RequestValues instance from pre-defined values (where Get Request Values generates all values automatically).
  • Perform Authorized Request is functionally the same as exisiting Authorized Request keyword, but it accepts a RequestValues instance as argument.
  • Validated Request is functionally the same as the existing Perform Validated Request keyword, but it accepts the data as separate arguments instead of the RequestValues.
  • Convert Request Values To Dict can be used to get a (Python) dict represenation of a RequestValues object that can be used with e.g. the Collections keywords for working with dictionaries.
  • This closes issue #98: Add keywords to simplify using Authorized Request and Perform Validated Request.
• Get Valid Id For Path now supports the Location response header.
  • This closes issue #112: Support the Location response header in Get Valid Id For Path.
• The IdDependency is now taken into account if the value of the property to which is applies is a list / ArraySchema.
  • This closes issue #122: Support get_dependent_id for properties where the property_schema is an ArraySchema
• Relations have been made more flexible:
  • Added support for using IGNORE as invalid_value on a PropertyValueConstraint.
  • Improved handling of treat_as_mandatory on a PropertyValueConstraint.
  • IGNORE as values (instead of a list) on a PropertyValueConstraint allows only error value mapping while using regular (random) value generation.
    • This closes issue #124: Support PropertyValueConstraint only for error codes.
  • Support an empty string as value for property_name of a PropertyValueConstraint to apply it to list / array (body) items.
    • This closes issue #118: Support PropertyValueConstraint on Array request bodies.
  • Support an empty string as value for the path of a PathPropertyConstraint to allow only error value mapping while using regular path generation otherwise.
    • This closes issue #120: Support empty path in PathPropertiesConstraint to allow specific error scenarios.
  • The custom transformer for ID_MAPPING was made more flexible.
    • This closes issue #114: Make the transformer support for the ID_MAPPING more flexible.
• The Test Endpoint keyword of OpenApiDriver now also support error codes from a PathPropertiesConstraint.
  • This closes issue #126: Path invalidation based on error code not supported by OpenApiDriver.

Bugfixes

• Added support for the nullable property in OAS 3.0 schemas when generating data.
  • This closes issue #81: nullable not taken into account in get_valid_value.
• Support added for multiple instances of OpenApiLibCore within the same suite.
  • This closes issue #96: Multiple keywords with same name error when using multiple generated libraries.
• Fixed a KeyError issue in Get Valid Id For Path.
  • This closes issue #110: KeyError in Get Valid Id For Path.
• Parameter generation did not take the IdDependency Relation into account.
  • This closes issue #115: IdDependency is not supported in parameters.
• A PathPropertiesConstraint mapping could be overridden by another Relations mapping during model generation.
  • This closes issue #129: Path mappings get overridden by relation mappings in model post-init.
• Fixed validation errors caused by Content-Type not being handled case-insensitive.
• Fixed an exception during validation caused by charset being included in the Content-Type header for application/json.

Breaking changes

• Addressing issue #95: Refactor: better name for Dto introduces a number breaking renames:
  • Dto has been renamed to RelationsMapping.
  • constraint_mapping has been renamed to relations_mapping in a number of places.
  • DTO_MAPPING has been renamed to RELATIONS_MAPPING.
• The RequestData class that is returned by a number of keywords has been changed:
  • The dto property was removed.
  • The valid_data property was added.
  • The relations_mapping property was added.
• invalid_property_default_response library parameter renamed to invalid_data_default_response.

Additional changes

• Special handling of "format": "byte" for "type": "string" (OAS 3.0) was removed.
  • While some logic related to this worked, the result was never JSON-serializable.
• The devcontainer setup was updated.
• The GitHub pipeline was updated to include Python 3.14.
• Updated minimum version markers for many dependencies.
• Annotations are now complete (as far as possible under Python 3.10).

Notes

• The documentation is not yet updated with many of the changes / improvements detailed above.
• While some tests have been updated to check / demonstrate the above changes, more tests need to be added.

---

OpenApiTools v1.0.5

Bugfixes

• parameters at path level are not taken into account at operation level.

---

OpenApiTools v1.0.4

Bugfixes

• Prevent runtime exception for unsupported regex patterns in OAS.
• Prevent trailing underscores in generated keyword method names.

Additional changes

• generate-library CLI interaction now prompts for behavior that was previously only available by setting the environment variables USE_SUMMARY_AS_KEYWORD_NAME and EXPAND_BODY_ARGUMENTS.

---

OpenApiTools v1.0.3

Bugfixes

• Fix runtime exception on ObjectSchemas without properties defined in the OAS.

Additional changes

• Python 3.14 compatibility tested and lock file updated.

---

OpenApiTools v1.0.2

Bugfixes

• Multiple PropertyValueConstraint instances for the same property_name caused an exception.
• Get Invalidated Parameters now properly handles situations where invalid_value is set to IGNORE.

---

OpenApiTools v1.0.1

Bugfixes

• openapitools_docs was missing from package distribution.

---

OpenApiTools v1.0.0 (yanked)

Major changes and new features

• Added a CLI tool for library generation. See the OpenApiLibGen documentation for all the details.
• Support for nested Dtos in Relation constraints (issue #49).
• The core logic has been rewritten to use Pydantic models under the hood. This rewrite has made the addition of the library generator possible and allows feature implementations in future releases that were previously (too) hard to implement.
• The documentation has been restructured / rewritten and should now be much more coherent and accessible.

Bugfixes

• No specific bugfixes have been made, but the core refactor of the application has solved a number of undocumented issues.

Breaking changes

• PathPropertiesConstraint is now a separate type of Relation. See the Advanced Use documentation for details.
• In a number of places, the terms url, path and endpoint were not correctly and / or consistently used. This has been corrected.
  • A url is a complete url which can be use e.g. in a browser or http request.
  • A path is a portion of an url. In the scope of OpenApiTools, a path corresponds to an entry in the paths section of an OpenAPI specification document.
  • From a standards / definition point of view "all endpoints are URLs, not all URLs are endpoints". An endpoint represents a specific function offered by an API. Due to this subtle difference, when the term endpoint is used in the OpenApiTools documentation, it refers to the combination of an url and a corresponding HTTP operation / verb as they are found under the path entries in an OpenAPI specification document.