Safe Haskell	None
Language	Haskell2010

Data.API.Tools.Example

Description

Tool for generating documentation-friendly examples

Synopsis

class Example a where
- example :: Gen a
exampleTool :: APITool
samplesTool :: Name -> APITool

Documentation

class Example a where Source #

The Example class is used to generate a documentation-friendly example for each type in the model

Minimal complete definition

Nothing

Methods

example :: Gen a Source #

Generator for example values; defaults to arbitrary if not specified

default example :: Arbitrary a => Gen a Source #

Instances

Instances details

Example Bool Source #
Instance details Defined in Data.API.Tools.Example Methods example :: Gen Bool Source #
Example Int Source #
Instance details Defined in Data.API.Tools.Example Methods example :: Gen Int Source #
Example Text Source #
Instance details Defined in Data.API.Tools.Example Methods example :: Gen Text Source #
Example UTCTime Source #
Instance details Defined in Data.API.Tools.Example Methods example :: Gen UTCTime Source #
Example Value Source #
Instance details Defined in Data.API.Tools.Example Methods example :: Gen Value Source #
Example Binary Source #
Instance details Defined in Data.API.Tools.Example Methods example :: Gen Binary Source #
Example DefaultValue Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen DefaultValue Source #
Example BasicType Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen BasicType Source #
Example TypeRef Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen TypeRef Source #
Example APIType Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen APIType Source #
Example Field Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen Field Source #
Example Conversion Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen Conversion Source #
Example UTCRange Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen UTCRange Source #
Example IntRange Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen IntRange Source #
Example RegularExpression Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen RegularExpression Source #
Example Filter Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen Filter Source #
Example SpecNewtype Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen SpecNewtype Source #
Example Spec Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen Spec Source #
Example APINode Source #
Instance details Defined in Data.API.API.Gen Methods example :: Gen APINode Source #
Example a => Example [a] Source #
Instance details Defined in Data.API.Tools.Example Methods example :: Gen [a] Source #
Example a => Example (Maybe a) Source #
Instance details Defined in Data.API.Tools.Example Methods example :: Gen (Maybe a) Source #

exampleTool :: APITool Source #

Tool to generate Example instances for types generated by datatypesTool. This depends on quickCheckTool.

samplesTool :: Name -> APITool Source #

Generate a list of (type name, sample generator) pairs corresponding to each type in the API, with samples encoded as JSON. This depends on the Example instances generated by exampleTool. It generates something like this:

samples :: [(String, Gen Value)]
samples = [("Foo", fmap toJSON (example :: Gen Foo)), ... ]