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

File metadata

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

File hashes

Hashes for pydantic_openapi_helper-1.0.5.tar.gz
Algorithm Hash digest
SHA256 25400fe0dcb458fa10a637a0367930a38decb73788ac38cf27c26100c8bbece7
MD5 2b9452cd5d599739d9111f7d0f384544
BLAKE2b-256 6f6984b4096f10d3de88053b8ef5f776c98463d2a50d4f98b377ceaa4df177c3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pydantic_openapi_helper-1.0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5cefc7bb5f8ebcc722db63ceb2723e7b32c541048d9959d7815aeade3611ef04
MD5 6e347f54a95111289ca9dc6d55bd667f
BLAKE2b-256 a020f85c4bac41a7ab513524093007ac502fc0b308bdddfd262b5a7dd1c32947

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