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-1.0.4.tar.gz (17.0 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-1.0.4-py2.py3-none-any.whl (10.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pydantic_openapi_helper-1.0.4.tar.gz.

File metadata

  • Download URL: pydantic_openapi_helper-1.0.4.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.12

File hashes

Hashes for pydantic_openapi_helper-1.0.4.tar.gz
Algorithm Hash digest
SHA256 386ce80220bcc459a9bfc1d822888a7f7ad5658f8bf375519c4b6c4e1025e27d
MD5 a67855e7f9dd14c8c9917d6e08d6c974
BLAKE2b-256 171d7ecbc2f4ca3d2798998428d1cfbf1109965fe4b250565429f8c7f1a65640

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pydantic_openapi_helper-1.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 890973af674f6c593835b31888df12afd97110373f4b376cbdb081b1eebf65b1
MD5 d3cafffa6de655d54dbdcf2bfe8dc561
BLAKE2b-256 78ef01fe6f692a8a564f22ebac04bd517bad7fd7945c55d3f60170e88c26dcc5

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