Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Routes.Named.Document

Contents

Routes types
API types
functions and lenses

Synopsis

newtype DocumentsFromWriteNodesAPI mode = DocumentsFromWriteNodesAPI {
- docFromWriteNodesEp :: mode :- (Summary " Documents from Write nodes." :> AsyncJobs JobLog '[JSON] Params JobLog)
}
newtype DocumentUploadAPI mode = DocumentUploadAPI {
- uploadDocAsyncEp :: mode :- (Summary " Document upload" :> ("document" :> ("upload" :> ("async" :> AsyncJobs JobLog '[JSON] DocumentUpload JobLog))))
}
newtype DocumentExportAPI mode = DocumentExportAPI {
- documentExportAPI :: mode :- (Summary "Document Export" :> ("export" :> (("json" :> Get '[JSON] (Headers '[Header "Content-Disposition" Text] DocumentExport)) :<|> (("json.zip" :> Get '[ZIP] (Headers '[Header "Content-Disposition" Text] DocumentExportZIP)) :<|> ("csv" :> Get '[PlainText] (Headers '[Header "Content-Disposition" Text] Text))))))
}
data Params = Params {
- id :: Int
- paragraphs :: Text
- lang :: Lang
- selection :: FlowSocialListWith
}
data DocumentUpload = DocumentUpload {
- _du_abstract :: Text
- _du_authors :: Text
- _du_sources :: Text
- _du_title :: Text
- _du_date :: Text
- _du_language :: Text
}
du_title :: Lens' DocumentUpload Text
du_sources :: Lens' DocumentUpload Text
du_language :: Lens' DocumentUpload Text
du_date :: Lens' DocumentUpload Text
du_authors :: Lens' DocumentUpload Text
du_abstract :: Lens' DocumentUpload Text

Routes types

newtype DocumentsFromWriteNodesAPI mode #

Constructors

DocumentsFromWriteNodesAPI
Fields docFromWriteNodesEp :: mode :- (Summary " Documents from Write nodes." :> AsyncJobs JobLog '[JSON] Params JobLog)

Instances

Instances details

Generic (DocumentsFromWriteNodesAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Document Associated Types type Rep (DocumentsFromWriteNodesAPI mode) :: Type -> Type # Methods from :: DocumentsFromWriteNodesAPI mode -> Rep (DocumentsFromWriteNodesAPI mode) x # to :: Rep (DocumentsFromWriteNodesAPI mode) x -> DocumentsFromWriteNodesAPI mode #
type Rep (DocumentsFromWriteNodesAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Document type Rep (DocumentsFromWriteNodesAPI mode) = D1 ('MetaData "DocumentsFromWriteNodesAPI" "Gargantext.API.Routes.Named.Document" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "DocumentsFromWriteNodesAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "docFromWriteNodesEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary " Documents from Write nodes." :> AsyncJobs JobLog '[JSON] Params JobLog)))))

newtype DocumentUploadAPI mode #

Constructors

DocumentUploadAPI
Fields uploadDocAsyncEp :: mode :- (Summary " Document upload" :> ("document" :> ("upload" :> ("async" :> AsyncJobs JobLog '[JSON] DocumentUpload JobLog))))

Instances

Instances details

Generic (DocumentUploadAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Document Associated Types type Rep (DocumentUploadAPI mode) :: Type -> Type # Methods from :: DocumentUploadAPI mode -> Rep (DocumentUploadAPI mode) x # to :: Rep (DocumentUploadAPI mode) x -> DocumentUploadAPI mode #
type Rep (DocumentUploadAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Document type Rep (DocumentUploadAPI mode) = D1 ('MetaData "DocumentUploadAPI" "Gargantext.API.Routes.Named.Document" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "DocumentUploadAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "uploadDocAsyncEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary " Document upload" :> ("document" :> ("upload" :> ("async" :> AsyncJobs JobLog '[JSON] DocumentUpload JobLog))))))))

newtype DocumentExportAPI mode #

Constructors

DocumentExportAPI
Fields documentExportAPI :: mode :- (Summary "Document Export" :> ("export" :> (("json" :> Get '[JSON] (Headers '[Header "Content-Disposition" Text] DocumentExport)) :<\|> (("json.zip" :> Get '[ZIP] (Headers '[Header "Content-Disposition" Text] DocumentExportZIP)) :<\|> ("csv" :> Get '[PlainText] (Headers '[Header "Content-Disposition" Text] Text))))))

Instances

Instances details

Generic (DocumentExportAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Document Associated Types type Rep (DocumentExportAPI mode) :: Type -> Type # Methods from :: DocumentExportAPI mode -> Rep (DocumentExportAPI mode) x # to :: Rep (DocumentExportAPI mode) x -> DocumentExportAPI mode #
type Rep (DocumentExportAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Document type Rep (DocumentExportAPI mode)

API types

data Params #

Constructors

Params
Fields id :: Int paragraphs :: Text lang :: Lang selection :: FlowSocialListWith

Instances

Instances details

FromJSON Params #
Instance details Defined in Gargantext.API.Routes.Named.Document Methods parseJSON :: Value -> Parser Params # parseJSONList :: Value -> Parser [Params] #
ToJSON Params #
Instance details Defined in Gargantext.API.Routes.Named.Document Methods toJSON :: Params -> Value # toEncoding :: Params -> Encoding # toJSONList :: [Params] -> Value # toEncodingList :: [Params] -> Encoding #
Generic Params #
Instance details Defined in Gargantext.API.Routes.Named.Document Associated Types type Rep Params :: Type -> Type # Methods from :: Params -> Rep Params x # to :: Rep Params x -> Params #
Show Params #
Instance details Defined in Gargantext.API.Routes.Named.Document Methods showsPrec :: Int -> Params -> ShowS # show :: Params -> String # showList :: [Params] -> ShowS #
ToSchema Params #
Instance details Defined in Gargantext.API.Routes.Named.Document Methods declareNamedSchema :: Proxy Params -> Declare (Definitions Schema) NamedSchema #
type Rep Params #
Instance details Defined in Gargantext.API.Routes.Named.Document type Rep Params

data DocumentUpload #

Constructors

DocumentUpload
Fields _du_abstract :: Text _du_authors :: Text _du_sources :: Text _du_title :: Text _du_date :: Text _du_language :: Text

Instances

Instances details

FromJSON DocumentUpload #
Instance details Defined in Gargantext.API.Routes.Named.Document Methods parseJSON :: Value -> Parser DocumentUpload # parseJSONList :: Value -> Parser [DocumentUpload] #
ToJSON DocumentUpload #
Instance details Defined in Gargantext.API.Routes.Named.Document Methods toJSON :: DocumentUpload -> Value # toEncoding :: DocumentUpload -> Encoding # toJSONList :: [DocumentUpload] -> Value # toEncodingList :: [DocumentUpload] -> Encoding #
Generic DocumentUpload #
Instance details Defined in Gargantext.API.Routes.Named.Document Associated Types type Rep DocumentUpload :: Type -> Type # Methods from :: DocumentUpload -> Rep DocumentUpload x # to :: Rep DocumentUpload x -> DocumentUpload #
ToSchema DocumentUpload #
Instance details Defined in Gargantext.API.Routes.Named.Document Methods declareNamedSchema :: Proxy DocumentUpload -> Declare (Definitions Schema) NamedSchema #
type Rep DocumentUpload #
Instance details Defined in Gargantext.API.Routes.Named.Document type Rep DocumentUpload = D1 ('MetaData "DocumentUpload" "Gargantext.API.Routes.Named.Document" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "DocumentUpload" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_du_abstract") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "_du_authors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "_du_sources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "_du_title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "_du_date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "_du_language") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

functions and lenses

du_title :: Lens' DocumentUpload Text #

du_sources :: Lens' DocumentUpload Text #

du_language :: Lens' DocumentUpload Text #

du_date :: Lens' DocumentUpload Text #

du_authors :: Lens' DocumentUpload Text #

du_abstract :: Lens' DocumentUpload Text #