OpenAPI.Generate.Model

Defines functionality for the generation of models from OpenAPI schemas

Documentation

getSchemaType :: Flags -> SchemaObject -> Name

Extracts the Name of a SchemaObject which should be used for primitive types

resolveSchemaReferenceWithoutWarning :: Schema -> Generator (Maybe SchemaObject)

Transforms a Schema (either a reference or a concrete object) to Maybe SchemaObject If a reference is found it is resolved. If it is not found, no log message is generated.

getConstraintDescriptionsOfSchema :: Maybe SchemaObject -> [Text]

Extracts the constraints of a SchemaObject as human readable text

defineModelForSchemaNamed :: Text -> Schema -> Generator TypeWithDeclaration

Defines all the models for a schema and returns the declarations with the type of the root model

defineModelForSchema :: Text -> Schema -> Generator ModelWithDependencies

Defines all the models for a schema

type TypeWithDeclaration = (Q Type, ModelContentWithDependencies)

The type of a model and the declarations needed for defining it