Skip to main content

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

Project description

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.1.5.tar.gz (13.9 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.1.5-py2.py3-none-any.whl (9.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for pydantic-openapi-helper-0.1.5.tar.gz
Algorithm Hash digest
SHA256 de69c3be5e036ebf1ab035b7fd28e3bc2893ddd705af598b726a3a65dd33c022
MD5 e3ed92f263259f115acabfebbcd104ce
BLAKE2b-256 ee1cee58140be4b2f2b8cc27078719c16b2a83b529817d3692061462ce0354cc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pydantic_openapi_helper-0.1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c670d3dfae89c9fa9938a652e43383441759d4dfd0670a273db548b40a9b820a
MD5 f909e6143e295b0b48623f2533f03811
BLAKE2b-256 983d38454d63b9eafa4917d453df93f42b2847d86666693e2fa09ecc6bcd2d06

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