| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
OpenAPI.Generate.Types.Schema
Description
This module specifies the data types from the OpenAPI specification 3.0.3 Schema
For more information see http://spec.openapis.org/oas/v3.0.3 and https://json-schema.org/
All names in this module correspond to the respective OpenAPI types
Synopsis
- type Schema = Referencable SchemaObject
- data SchemaObject = SchemaObject {
- schemaObjectType :: SchemaType
- schemaObjectTitle :: Maybe Text
- schemaObjectMultipleOf :: Maybe Float
- schemaObjectMaximum :: Maybe Float
- schemaObjectExclusiveMaximum :: Bool
- schemaObjectMinimum :: Maybe Float
- schemaObjectExclusiveMinimum :: Bool
- schemaObjectMaxLength :: Maybe Word
- schemaObjectMinLength :: Maybe Word
- schemaObjectPattern :: Maybe Text
- schemaObjectMaxItems :: Maybe Word
- schemaObjectMinItems :: Maybe Word
- schemaObjectUniqueItems :: Bool
- schemaObjectMaxProperties :: Maybe Word
- schemaObjectMinProperties :: Maybe Word
- schemaObjectRequired :: Set Text
- schemaObjectEnum :: [Value]
- schemaObjectAllOf :: [Schema]
- schemaObjectOneOf :: [Schema]
- schemaObjectAnyOf :: [Schema]
- schemaObjectNot :: Maybe Schema
- schemaObjectProperties :: Map Text Schema
- schemaObjectAdditionalProperties :: AdditionalProperties
- schemaObjectDescription :: Maybe Text
- schemaObjectFormat :: Maybe Text
- schemaObjectDefault :: Maybe ConcreteValue
- schemaObjectNullable :: Bool
- schemaObjectDiscriminator :: Maybe DiscriminatorObject
- schemaObjectReadOnly :: Bool
- schemaObjectWriteOnly :: Bool
- schemaObjectXml :: Maybe XMLObject
- schemaObjectExternalDocs :: Maybe ExternalDocumentationObject
- schemaObjectExample :: Maybe Value
- schemaObjectDeprecated :: Bool
- schemaObjectItems :: Maybe Schema
- defaultSchema :: SchemaObject
- isSchemaEmpty :: SchemaObject -> Bool
- data SchemaType
- data DiscriminatorObject = DiscriminatorObject {}
- data ConcreteValue
- data AdditionalProperties
- data XMLObject = XMLObject {}
Documentation
type Schema = Referencable SchemaObject Source #
data SchemaObject Source #
Constructors
Instances
isSchemaEmpty :: SchemaObject -> Bool Source #
Checks if the given schema is an empty object schema (without properties)
data SchemaType Source #
Constructors
| SchemaTypeString | |
| SchemaTypeNumber | |
| SchemaTypeInteger | |
| SchemaTypeBool | |
| SchemaTypeObject | |
| SchemaTypeArray |
Instances
data DiscriminatorObject Source #
Constructors
| DiscriminatorObject | |
Instances
data ConcreteValue Source #
Constructors
| StringDefaultValue Text | |
| NumericDefaultValue Scientific | |
| BoolDefaultValue Bool | |
| OtherDefaultValue Value |
Instances
data AdditionalProperties Source #
Instances
Constructors
| XMLObject | |
Fields | |