backend-0.1.0.0

License	AGPL-3
Maintainer	stu235271@mail.uni-kiel.de stu236925@mail.uni-kiel.de
Safe Haskell	None
Language	Haskell2010

Docs.FullDocument

Description

Synopsis

data FullDocument a = FullDocument {
- header :: Document
- body :: Maybe (TreeRevision a)
}

Documentation

data FullDocument a Source #

A »full« document, with a TreeRevision, where TextElementRevisions are emplaced for all TextElements.

Constructors

FullDocument
Fields header :: Document metadata about the `Document` body :: Maybe (TreeRevision a) a »full« `TreeRevision` for the `Document`

Instances

Instances details

FromJSON a => FromJSON (FullDocument a) Source #

Instance details

Defined in Docs.FullDocument

Methods

parseJSON :: Value -> Parser (FullDocument a)

parseJSONList :: Value -> Parser [FullDocument a]

omittedField :: Maybe (FullDocument a)

ToJSON a => ToJSON (FullDocument a) Source #

Instance details

Defined in Docs.FullDocument

Methods

toJSON :: FullDocument a -> Value

toEncoding :: FullDocument a -> Encoding

toJSONList :: [FullDocument a] -> Value

toEncodingList :: [FullDocument a] -> Encoding

omitField :: FullDocument a -> Bool

Generic (FullDocument a) Source #

Instance details

Defined in Docs.FullDocument

Associated Types

type Rep (FullDocument a)

Instance details

Defined in Docs.FullDocument

type Rep (FullDocument a) = D1 ('MetaData "FullDocument" "Docs.FullDocument" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "FullDocument" 'PrefixI 'True) (S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Document) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (TreeRevision a)))))

Methods

from :: FullDocument a -> Rep (FullDocument a) x #

to :: Rep (FullDocument a) x -> FullDocument a #

ToSchema a => ToSchema (FullDocument a) Source #

Instance details

Defined in Docs.FullDocument

Methods

declareNamedSchema :: Proxy (FullDocument a) -> Declare (Definitions Schema) NamedSchema

type Rep (FullDocument a) Source #

Instance details

Defined in Docs.FullDocument

type Rep (FullDocument a) = D1 ('MetaData "FullDocument" "Docs.FullDocument" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "FullDocument" 'PrefixI 'True) (S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Document) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (TreeRevision a)))))