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.1.8.tar.gz (14.3 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.8-py2.py3-none-any.whl (9.2 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: pydantic-openapi-helper-0.1.8.tar.gz
  • Upload date:
  • Size: 14.3 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.8.tar.gz
Algorithm Hash digest
SHA256 46782ffbea45da95c5238b154f4706d61ca86d3bfd8123c38619fdf40eec3dff
MD5 488420a3a7957d426202c3d9399f04a6
BLAKE2b-256 f8420e7f03566308cab0b41c8e9190f757cd06db2734ea3e7c291f08986d5230

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pydantic_openapi_helper-0.1.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.2 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.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d23358eeedffd5b2f6507356e5f7b541eb48661c360e3a379a400de029c8cc3a
MD5 c89456756ba17d533b1084d9773f0cdf
BLAKE2b-256 f760729dae0d994f123eb20ac5b8759e50338a6a5336d1e7d79c56f0f9d099c9

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