Skip to main content

A small module to add additional post-processing to the OpenAPI schemas that are generated by Pydantic.

Project description

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.6.tar.gz (13.9 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.6-py2.py3-none-any.whl (9.1 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: pydantic-openapi-helper-0.1.6.tar.gz
  • Upload date:
  • Size: 13.9 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.6.tar.gz
Algorithm Hash digest
SHA256 f19e2255cc628cc84a8b0eec2d074ce871c0ba53d29defb17e05207770fd79af
MD5 169ae3a522e924edebd88f96d1b61363
BLAKE2b-256 1415e179b7143072e6c69b9cd4791a7948b7c48d8ef3a043d75fa67876906643

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pydantic_openapi_helper-0.1.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 9.1 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.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cdeab12858888b8ef916255527052a3f44a0a8d2efbe13bc19e73c95ae87b785
MD5 8836e50aed929c10459918d749e3a2bc
BLAKE2b-256 a43031d2cbaf450d42a5f497fbb24fe2151b65315c0f2b7434dc555970b20c9c

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