backend-0.1.0.0
LicenseAGPL-3
Maintainerstu235271@mail.uni-kiel.de stu236925@mail.uni-kiel.de
Safe HaskellNone
LanguageHaskell2010

Docs.Document

Description

This module contains the definition of a Document datatype as well as related datatypes

Synopsis

Documentation

newtype DocumentID Source #

ID for a document

Constructors

DocumentID 

Fields

Instances

Instances details
FromJSON DocumentID Source # 
Instance details

Defined in Docs.Document

Methods

parseJSON :: Value -> Parser DocumentID

parseJSONList :: Value -> Parser [DocumentID]

omittedField :: Maybe DocumentID

ToJSON DocumentID Source # 
Instance details

Defined in Docs.Document

Methods

toJSON :: DocumentID -> Value

toEncoding :: DocumentID -> Encoding

toJSONList :: [DocumentID] -> Value

toEncodingList :: [DocumentID] -> Encoding

omitField :: DocumentID -> Bool

Show DocumentID Source # 
Instance details

Defined in Docs.Document

Eq DocumentID Source # 
Instance details

Defined in Docs.Document

FromHttpApiData DocumentID Source # 
Instance details

Defined in Docs.Document

ToParamSchema DocumentID Source # 
Instance details

Defined in Docs.Document

Methods

toParamSchema :: Proxy DocumentID -> Schema

ToSchema DocumentID Source # 
Instance details

Defined in Docs.Document

Methods

declareNamedSchema :: Proxy DocumentID -> Declare (Definitions Schema) NamedSchema

data Document Source #

Document metadata

Instances

Instances details
FromJSON Document Source # 
Instance details

Defined in Docs.Document

Methods

parseJSON :: Value -> Parser Document

parseJSONList :: Value -> Parser [Document]

omittedField :: Maybe Document

ToJSON Document Source # 
Instance details

Defined in Docs.Document

Methods

toJSON :: Document -> Value

toEncoding :: Document -> Encoding

toJSONList :: [Document] -> Value

toEncodingList :: [Document] -> Encoding

omitField :: Document -> Bool

Generic Document Source # 
Instance details

Defined in Docs.Document

Methods

from :: Document -> Rep Document x #

to :: Rep Document x -> Document #

Show Document Source # 
Instance details

Defined in Docs.Document

Eq Document Source # 
Instance details

Defined in Docs.Document

ToSchema Document Source # 
Instance details

Defined in Docs.Document

Methods

declareNamedSchema :: Proxy Document -> Declare (Definitions Schema) NamedSchema

type Rep Document Source # 
Instance details

Defined in Docs.Document