Skip to main content

A small module to add additional post-processing to the OpenAPI schemas that are generated by Pydantic.

Project description

Build Status

Python 3.7

pydantic-openapi-helper

A small module to add additional post-processing to the OpenAPI schemas that are generated by Pydantic.

This module is designed to work with Ladybug Tools schema libraries such as honeybee-schema, dragonfly-schema and queenbee but might be also helpful for other projects.

The most important feature of the library is to generate an OpenAPI schema to use polymorphism. It adds referenced values to subclasses using allOf field as explained in this post: https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism

We are not intending to support the development for make this library work universally but you are more than welcome to fork and make your own version of the library.

installation

python3 -m pip install pydantic-openapi-helper

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydantic-openapi-helper-0.2.2.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pydantic_openapi_helper-0.2.2-py2.py3-none-any.whl (9.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pydantic-openapi-helper-0.2.2.tar.gz.

File metadata

  • Download URL: pydantic-openapi-helper-0.2.2.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.7.1

File hashes

Hashes for pydantic-openapi-helper-0.2.2.tar.gz
Algorithm Hash digest
SHA256 45cddec41a6cad57e20d1e0fe6c3dd937e6aff41e148226509a9157e133b8842
MD5 114e80c885d3f5ba6b55011f641f3599
BLAKE2b-256 2b3b49cd7b264d0f19043b20ba7f857faa97b2b74a02739fad8a821572adf1b4

See more details on using hashes here.

File details

Details for the file pydantic_openapi_helper-0.2.2-py2.py3-none-any.whl.

File metadata

  • Download URL: pydantic_openapi_helper-0.2.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.7.1

File hashes

Hashes for pydantic_openapi_helper-0.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fdbee6f6d7f381b4527c963f27ce608d2161b09e3caed8b54caf4b01e0ffef9e
MD5 ef8c82d57782791a03a582d632bcf53f
BLAKE2b-256 077bae22ff72ca2c313b10e1596278aecbb58a84c46debb5af036d581e91538e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page