Contents

Changelog

Changelog

All notable changes to openapi_builder will be documented here.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Categories for changes are: Added, Changed, Deprecated, Removed, Fixed, Security.

Unreleased

Release date:

Version 0.3.0

Release date:

  • Added Docstring parser for property descriptions.

Version 0.2.10

Release date: 2022-04-01

  • Improved test coverage.

Version 0.2.9

Release date: 2022-02-22

  • Fixed bug with halogen class inheritance.

Version 0.2.8

Release date: 2022-02-18

  • Fixed bug with Schema.default when the default value was None.

Version 0.2.7

Release date: 2022-02-16

  • Updated add_documentation arguments:

    • responses is now response, and accepts either a dict or any value. In case any value is passed, it’s converted into {200: <value>}.

    • input_schema renamed into request_data.

    • query_schema renamed into request_query.

Version 0.2.6

Release date: 2022-02-12

  • Updated converters, and how to register them. This can now be done via the Options.

Version 0.2.5

Release date: 2022-02-06

  • Added default converters: openapi_builder.converters.defaults.

  • Added set_resource_options and set_schema_options.

  • Changed specification to use dataclass().

Version 0.2.4

Release date: 2022-01-09

  • Added tag support per endpoint

  • Added configuration page

  • Added support for halogen (including example).

  • Added class decorator for registering converters: openapi_builder.converters.base.register_converter.

  • Removed custom_converters option to add_documentation.

  • Changed loading converters lazily.

  • Added url parameter converters: openapi_builder.converters.parameter.

Version 0.2.0

Release date: 2021-12-09

  • Changed interface to support the standard init_app notation.

  • Fixed broken marshmallow support.

  • Added custom_converters option to add_documentation.

  • Added example.

  • Added documentation.

Version 0.1.0

Release date: 2021-11-17

  • Added Continuous integration (automated tests)

  • Added Continuous delivery (publishing to PyPI)

  • Added Automatically formatting (black and isort)

  • Added Checking formatting errors (flake8)

  • Added Automatic documentation integration and delivery

  • Added Initial code

previous

Exceptions