polytropos-openapi3: OpenAPI 3.0 schema generation for polytropos open records and variants

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Automatic OpenAPI 3.0 specification and JSON Schema generation for polytropos open records and variants via openapi3.

Generates Data.OpenApi.Schema.ToSchema instances without GHC.Generics tree explosion: open records yield schema objects with typed properties and required lists, while open variants yield Data.OpenApi.Lens.oneOf tagged-union schemas.

Start at the front door module Polytropos.OpenApi for complete documentation, schema customizing options, and worked examples.


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.0.2
Change log CHANGELOG.md
Dependencies base (>=4.14 && <5), lens (>=5.2 && <5.4), openapi3 (>=3.2 && <3.3), polytropos-core (>=0.1 && <0.2), polytropos-plugin (>=0.1 && <0.2), text (>=1.2 && <2.2) [details]
License (EUPL-1.2 OR Apache-2.0)
Author Nadia Yvette Chambers
Maintainer nadia.yvette.chambers@ik.me
Category Web
Home page https://github.com/NadiaYvette/polytropos
Bug tracker https://github.com/NadiaYvette/polytropos/issues
Source repo head: git clone https://github.com/NadiaYvette/polytropos(packages/polytropos-openapi3)
Uploaded by nyc at 2026-10-17T18:55:20Z

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Readme for polytropos-openapi3-0.1.0.0

[back to package description]

polytropos-openapi3

Automatic OpenAPI 3.0 specification and JSON Schema generation for polytropos open records and variants via openapi3.

Overview

polytropos-openapi3 synthesizes ToSchema instances for open records and variants:

Features

License

Dual-licensed under EUPL-1.2 OR Apache-2.0.