Skip to content

CHANGELOG.md

Latest commit

 

History

History
157 lines (124 loc) · 7.08 KB

CHANGELOG.md

File metadata and controls

157 lines (124 loc) · 7.08 KB

Changelog

All notable changes to this project will be documented in this file.

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

[1.4.1] - 2026-03-??

  • Fix handling of enum without declared type, like reported in #64 by @jan-ldwg.

[1.4.0] - 2026-03-07 :copilot:

  • 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.

[1.3.0] - 2025-11-19

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

[1.2.1] - 2025-07-30

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

[1.2.0] - 2025-04-27

  • 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.

[1.1.1] - 2025-03-20

  • 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.

[1.1.0] - 2025-01-18

  • 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).

[1.0.9] - 2023-11-20

  • 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

[1.0.8] - 2023-07-19 🐱

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

[1.0.7] - 2023-05-01 🧰

[1.0.6] - 2023-03-19 🐌

  • 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).

[1.0.5] - 2022-12-22 🎅

[1.0.4] - 2022-11-06 🐍

  • Fixes #18
  • Workflow maintenance

[1.0.3] - 2022-10-02

  • Changes how httpx version is pinned (<1)

[1.0.2] - 2022-05-08

  • Adds support for OpenAPI specification files split into multiple files Neoteroi/mkdocs-plugins#5
  • Adds support for externalDocs and tags root properties

[1.0.1] - 2022-05-05

  • Adds a new output style, to provide an overview of the API endpoints with PlantUML
  • Fixes two bugs caused by improper handling of OpenAPI Documentation without components Neoteroi/mkdocs-plugins#9

[1.0.0] - 2022-04-20 ✨

  • Adds features and a CLI to generate artifacts from OpenAPI Documentation files (markdown for MkDocs and PyMdown extensions, PlantUML class diagrams from components schemas)
  • Drops support for Python 3.6

[0.1.6] - 2021-11-17 💎

  • Adds py.typed file
  • Add Python 3.10 to the GitHub Workflow

[0.1.5] - 2021-06-27 🏰

  • Applies isort and enforces isort and black checks in CI pipeline
  • Adds support for examples defined using any class declaring a dict callable method, thus including pydantic models
  • Marks the package as Production/Stable

[0.1.4] - 2021-06-19 💧

[0.1.3] - 2021-06-17 💧

  • Corrects a bug forcing camelCase on examples objects handled as dataclasses
  • Adds base64 ValueFormat to the v3 enum

[0.1.2] - 2021-05-03 🎶

  • Adds a changelog
  • Adds a code of conduct
  • Updates PyYAML dependency to version 5.4.1