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.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

pydantic_openapi_helper-0.2.0-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.0.tar.gz.

File metadata

  • Download URL: pydantic-openapi-helper-0.2.0.tar.gz
  • Upload date:
  • Size: 14.4 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.2.0.tar.gz
Algorithm Hash digest
SHA256 9b194d9367c9ed94ed0a455f08b21a4542c7f78c5c4f7f013732fd983a6dab2c
MD5 fc1f66ede4aa21eb068bb30b489f273f
BLAKE2b-256 24fe6f53bb222a2f7c71cef18a3712d0410067c839d2c208d3ad4ab2f01d7a55

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pydantic_openapi_helper-0.2.0-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.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.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 423b264743251fb1bb04cb2f6e7ac02ccea84a2b2df965975307dc1989df8f4d
MD5 ba8bb5c96ffbad43148eea6ab2e6a7e7
BLAKE2b-256 6e685b121909edbe5e70d6de00913d1577aae8443358947f576132a433bffd5e

See more details on using hashes here.

Supported by

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