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.3.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.3-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.3.tar.gz.

File metadata

  • Download URL: pydantic_openapi_helper-1.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 a8e42b289aa0ab9ab17594c3b8f95f71b4e943d7b5f0a407c039ea753ed23b4b
MD5 4a9d8786882de0e058770611ee58479c
BLAKE2b-256 efa14c70d237c032fd6bef87f0287a23ffc98682a5ba7735f67324ea979bfa18

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pydantic_openapi_helper-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 093d4e1f6b1e6eb72dee4a16d17267869169ea888916e037f2b51f27587fbdae
MD5 4619cafc8353e9792a584855c9c07a61
BLAKE2b-256 73311c152dd6eb781f6c92b07f3ef5bddf896c38e418ac17dd8675c6ad2fd554

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