zgw-consumers-oas

Tooling to deal with OpenAPI specifications, extracted from zgw-consumers.


Keywords
Django, ZGW, Common, Ground, VNG, API, OpenAPI, OAS, mTLS
License
Other
Install
pip install zgw-consumers-oas==1.0.0

Documentation

ZGW Consumers' OAS tooling

Version

1.0.0

Source

https://github.com/maykinmedia/zgw-consumers-oas

Keywords

OpenAPI, Django, zgw-consumers

Run CI Coverage status Code linting

python-versions django-versions pypi-version

Tooling to deal with OpenAPI specifications, extracted from zgw-consumers.

ZGW Consumers used to have a hard requirement on OpenAPI 3.0 specifications for its services. On the way to 1.0, this requirement became obsolete, and it has no need anymore for this kind of tooling.

However, we understand that upgrading to zgw-consumers 1.0 is quite a big breaking change if you rely on this tooling, so it was decided to provide it in a standalone package to ease the transition.

This package is considered "feature complete" and will only receive bugfixes. No new features will be added.

Installation

Requirements

  • Python 3.10 or newer
  • Django 3.2 or newer

Install

  1. Install from PyPI

Usage

  1. Update the relevant zgw_consumers.test.* imports to zgw_consumers_oas.*
  2. You can continue using the ZGW_CONSUMERS_* settings to discover OpenAPI schema files.