Skip to content

Releases: Neoteroi/essentials-openapi

v1.4.0

07 Mar 09:32
fda4c0e

Choose a tag to compare

  • Add OAS 3.1 support, cross-version warnings, and fix nullable spacing, by @dcode.
  • Fix MARKDOWN style table separators to use minimum 3 hyphens (issue #39), reported by @michael-nok.
  • Fix #45: add support for displaying descriptions of schema properties, reported by @Maia-Everett.
  • Fix #30: raise an error when trying to generate output from an older Swagger v2 specification file (these were never supported as there was never a /mk/v2/ namespace, intentionally).
  • Fix #35: group response codes in a tab group on MkDocs output, reported by @Andre601.
  • Fix #47: remove wordwrap filters from all templates as they break links and mermaid chart code blocks in descriptions, reported by @ElementalWarrior.
  • Fix #49: support $ref values of the form file.yaml#/fragment/path (external file with JSON Pointer fragment), reported by @mbklein.
  • Fix #55: jsonSchemaDialect is not required and should not have a default value.
  • Fix #60: resolve $ref values in response headers pointing to #/components/headers/... to avoid UndefinedError when rendering response tables, reported by @copiousfreetime.
  • Fix #64: use examples array (JSON Schema draft 6+) as a fallback for auto-generated response examples; also use enum values as examples for all scalar types (integer, number, boolean), reported by @jan-ldwg.

v1.3.0

19 Nov 20:40
1a8047e

Choose a tag to compare

  • Add support for passing custom Jinja2 templates as an argument, by @sindrehan.

v1.2.1

30 Jul 17:13
fa5d0df

Choose a tag to compare

  • Add support for using the current working directory (CWD) as an option when handling OpenAPI links, by @joewlambeth.

v1.2.0

27 Apr 16:56
151ef04

Choose a tag to compare

  • Update objects to the OpenAPI Specification v3.1, by @tyzhnenko.
  • Add docstrings to all v3 classes.
  • Upgrade the v3.OpenAPI class from OpenAPI version 3.0.3 to 3.1.0.

v1.1.1

20 Mar 20:27
43ad8a2

Choose a tag to compare

  • Fix bug in MARKDOWN view for servers (displaying twice the description instead of description and url).
  • Fix bug happening when a path item includes properties that are not of kind operation item (Neoteroi/mkdocs-plugins#5).
  • Add support for handling parameters defined on path items (common parameters for all operation under a certain path).
    Refer to the Path Item specification.
  • Fix bug happening when a parameter has a non-str name property.
  • Add Python 3.13 to the build matrix.

v1.1.0

18 Jan 08:36
6d0e5bf

Choose a tag to compare

  • Add additionalProperties to Schema object, by @tyzhnenko.
  • Upgrade package MarkupSafe to 3.0.1, by @stollero.
  • Remove Python 3.8 from the build matrix (EOF at the end of 2024).

v1.0.9

20 Nov 23:06
4ffc7b1

Choose a tag to compare

  • Adds support for Python 3.12.
  • Adds MarkupSafe among required dependencies (and not optional).
  • Adds support for latest function model_dump in Pydantic 2 (for examples
    defined using Pydantic models).
  • Upgrades development dependencies.
  • Fix bug with missing items entry #36 by @mh7d and @mh-at-fujitsu

v1.0.8

19 Jul 14:26
6bbd8c5

Choose a tag to compare

  • Fixes example generation breaks on explicitly enumerated array elements #31, by @jjedele

v1.0.7

01 May 08:58

Choose a tag to compare

v1.0.6

19 Mar 07:00
c70519b

Choose a tag to compare

  • Fixes a bug happening when trying to serialize examples in JSON, when they
    contain datetimes and are provided in YAML;
    (bug report).
  • Fixes a bug related to missing resolution of references for requestBody;
    (bug report).
  • Fixes support for code fences (disables by default autoescape, since the
    source of OpenAPI Specification files is supposed to be trusted anyway.
    Those who still wants to have autoescape enabled with Jinja can do so
    setting an environment variable: SELECT_AUTOESCAPE=1;
    (bug report).