Skip to content

Latest commit

 

History

History
107 lines (75 loc) · 9.81 KB

CHANGES.md

File metadata and controls

107 lines (75 loc) · 9.81 KB

APIFairy Change Log

Release 1.4.0 - 2024-01-15

  • Remove use of deprecated flask.__version__ (commit)
  • Handle breaking changes in webargs.use_args decorator (commit)
  • Option to set the media type for the body explicitly #78 (commit)
  • Update to latest versions of JS and CSS 3rd-party resources #73 (commit) (thanks Frank Yu!)
  • Examples added to the repository (commit #1 commit #2 commit #3)
  • Add Python 3.12 to builds (commit)
  • Migrate Python package metadata to pyproject.toml (commit)

Release 1.3.0 - 2022-11-13

  • Support for documenting webhooks, per OpenAPI 3.1.0 spec (commit)
  • Add Python 3.11 to test builds (commit)
  • Stop testing Python 3.6 (commit)

Release 1.2.0 - 2022-10-06

  • Documentation of request and response headers #63 (commit)

Release 1.1.0 - 2022-09-22

  • Optional schema for error responses listed in the @other_responses decorator #60 (commit)
  • Optional decorators to apply to the apispec and documentation endpoints #58 (commit)
  • Fixing some typos in documentation #53 (commit) (thanks GustavMauler!)
  • Add link to Microblog API example in readme (commit)
  • Updated readme with a screenshot (commit)

Release 1.0.0 - 2022-08-02

  • Document path parameters with string annotations (commit)
  • Support for typing.Annotated in path parameter documentation (commit)
  • Correct handling of custom blueprint ordering (commit)
  • Documentation on how to add manually written documentation (commit)

Release 0.9.2 - 2022-07-20

  • Form and file upload support #35 (commit)
  • Additional unit testing coverage (commit)
  • Add Python 3.10 and PyPy 3.8 to builds (commit)

Release 0.9.1 - 2022-01-11

  • Mark request body as required when @body decorator is used #37 (commit)
  • Set page title in rapidoc and elements templates (commit)

Release 0.9.0 - 2021-12-14

  • Better ordering for authentication schemes (commit)
  • Added rapidoc template (commit)
  • Added Elements template (commit)
  • Documented how to create a custom documentation endpoint (commit)

Release 0.8.2 - 2021-08-30

  • One more change needed to include HTML files in package (commit)

Release 0.8.1 - 2021-08-30

  • Add the documentation templates back into the package #2 (commit)

Release 0.8.0 - 2021-08-07

  • Add servers section (commit)
  • Add operationId for each endpoint (commit)
  • Add default description for responses (commit)
  • Remove indentation spaces from docstrings #30 (commit)
  • Support Flask 2 async views (commit)
  • Support nested blueprints (commit) (thanks Grey Li!)
  • Improved project structure (commit)

Release 0.7.0 - 2021-05-24

  • Correctly handle routes with multiple path arguments #11 (commit) (thanks Grey Li!)
  • Use default status code when route returns a one-element tutple (commit)
  • Update schema name resolver to remove unnecessary List suffix #21 (commit) (thanks Grey Li!)
  • Fix path arguments order (commit) (thanks Grey Li!)
  • Fix path arguments regex #16 (commit) (thanks Grey Li!)
  • Fix detection of view docstring #8 (commit) (thanks Grey Li!)
  • Add missing backtick for inline code #17 (commit) (thanks Grey Li!)
  • Document the process_apispec decorator (commit)
  • Fix typo in Getting Started section #13 (commit) (thanks Grey Li!)
  • Fix typo in exception message #20 (commit) (thanks Grey Li!)
  • Add openapi-spec-validator into tests_require #9 (commit) (thanks Grey Li!)
  • Added missing import statements in documentation examples #7 (commit) (thanks Grey Li!)
  • Move builds to GitHub actions (commit)

Release 0.6.2 - 2020-10-10

  • Documentation updates (commit)

Release 0.6.1 - 2020-10-05

  • Fixed release script to include HTML templates
  • Rename blueprint to apifairy

Release 0.6.0 - 2020-10-03

  • More unit test coverage
  • Configuration through Flask's config object
  • Error handling

Release 0.5.0 - 2020-09-28

  • First public release!