[](https://travis-ci.com/ladybug-tools/pydantic-openapi-helper)
[](https://www.python.org/downloads/release/python-370/)
# 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](https://github.com/ladybug-tools/honeybee-schema/),
[dragonfly-schema](https://github.com/ladybug-tools/dragonfly-schema/) and
[queenbee](https://github.com/ladybug-tools/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`
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/pydantic-openapi-helper",
"name": "pydantic-openapi-helper",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Ladybug Tools",
"author_email": "info@ladybug.tools",
"download_url": "https://files.pythonhosted.org/packages/31/5d/caa5b19d00ef8cf6620adb51e61901e7fb4fb077641f2b411f92a9aa68a7/pydantic-openapi-helper-0.2.11.tar.gz",
"platform": null,
"description": "[](https://travis-ci.com/ladybug-tools/pydantic-openapi-helper)\n\n[](https://www.python.org/downloads/release/python-370/)\n\n# pydantic-openapi-helper\n\nA small module to add additional post-processing to the OpenAPI schemas that are generated\nby Pydantic.\n\nThis module is designed to work with Ladybug Tools schema libraries such as\n[honeybee-schema](https://github.com/ladybug-tools/honeybee-schema/),\n[dragonfly-schema](https://github.com/ladybug-tools/dragonfly-schema/) and\n[queenbee](https://github.com/ladybug-tools/queenbee/) but might be also helpful for\nother projects.\n\nThe most important feature of the library is to generate an OpenAPI schema to use\npolymorphism. It adds referenced values to subclasses using allOf field as explained in\nthis post: https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism\n\nWe are not intending to support the development for make this library work universally\nbut you are more than welcome to fork and make your own version of the library.\n\n\n## installation\n\n`python3 -m pip install pydantic-openapi-helper`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A small module to add additional post-processing to the OpenAPI schemas that are generated by Pydantic.",
"version": "0.2.11",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/pydantic-openapi-helper"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b91cd5fef2e9be5d3a1469420c672f374dafac1701158f7b79ae151f9fd53303",
"md5": "db370142fca99588f3d4633077bebd20",
"sha256": "28752a7a079987c64800dc35acf09fda9e3b4dbdf487c5b19298b3a63a842904"
},
"downloads": -1,
"filename": "pydantic_openapi_helper-0.2.11-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "db370142fca99588f3d4633077bebd20",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 9742,
"upload_time": "2023-06-30T20:11:10",
"upload_time_iso_8601": "2023-06-30T20:11:10.214379Z",
"url": "https://files.pythonhosted.org/packages/b9/1c/d5fef2e9be5d3a1469420c672f374dafac1701158f7b79ae151f9fd53303/pydantic_openapi_helper-0.2.11-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "315dcaa5b19d00ef8cf6620adb51e61901e7fb4fb077641f2b411f92a9aa68a7",
"md5": "8be189758f8d6678765003d144b72a7a",
"sha256": "d1dd47304ed3e9ceeff7067f85cc8462d6a6b598839a4b30161b1ed064b20e90"
},
"downloads": -1,
"filename": "pydantic-openapi-helper-0.2.11.tar.gz",
"has_sig": false,
"md5_digest": "8be189758f8d6678765003d144b72a7a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15271,
"upload_time": "2023-06-30T20:11:11",
"upload_time_iso_8601": "2023-06-30T20:11:11.641038Z",
"url": "https://files.pythonhosted.org/packages/31/5d/caa5b19d00ef8cf6620adb51e61901e7fb4fb077641f2b411f92a9aa68a7/pydantic-openapi-helper-0.2.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-30 20:11:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "pydantic-openapi-helper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pydantic-openapi-helper"
}
JSON
