git.iko.soy/typeable/openapi3
on 042c4eb help sign in
typeable/openapi3/src/Data/Swagger/Schema.hs
61 lines 1.3 kB history raw
1-- |
2-- Module: Data.Swagger.Schema
3-- Maintainer: Nickolay Kudasov <nickolay@getshoptv.com>
4-- Stability: experimental
5--
6-- Types and functions for working with Swagger schema.
7module Data.Swagger.Schema (
8 -- * Encoding
9 ToSchema(..),
10 declareSchema,
11 declareSchemaRef,
12 toSchema,
13 toSchemaRef,
14 schemaName,
15 toInlinedSchema,
17 -- * Generic schema encoding
18 genericDeclareNamedSchema,
19 genericDeclareSchema,
20 genericDeclareNamedSchemaNewtype,
21 genericNameSchema,
23 -- ** 'Bounded' 'Integral'
24 genericToNamedSchemaBoundedIntegral,
25 toSchemaBoundedIntegral,
27 -- ** 'Bounded' 'Enum' key mappings
28 declareSchemaBoundedEnumKeyMapping,
29 toSchemaBoundedEnumKeyMapping,
31 -- ** Reusing 'ToParamSchema'
32 paramSchemaToNamedSchema,
33 paramSchemaToSchema,
35 -- ** Unrestricted versions
36 genericDeclareNamedSchemaUnrestricted,
37 genericDeclareSchemaUnrestricted,
39 -- * Schema templates
40 passwordSchema,
41 binarySchema,
42 byteSchema,
44 -- * Sketching @'Schema'@s using @'ToJSON'@
45 sketchSchema,
46 sketchStrictSchema,
48 -- * Inlining @'Schema'@s
49 inlineNonRecursiveSchemas,
50 inlineAllSchemas,
51 inlineSchemas,
52 inlineSchemasWhen,
54 -- * Generic encoding configuration
55 SchemaOptions(..),
56 defaultSchemaOptions,
57 fromAesonOptions,
58) where
60import Data.Swagger.Internal.Schema
61import Data.Swagger.SchemaOptions