Copyright	(c) CNRS 2017
License	AGPL + CECILL v3
Maintainer	team@gargantext.org
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Gargantext.Core.Text.Corpus.API

Description

Synopsis

data ExternalAPIs
- = All
- | PubMed
- | HAL
- | IsTex
- | Isidore
type Query = Query
type Limit = Limit
get :: ExternalAPIs -> Lang -> Query -> Maybe Limit -> IO [HyperdataDocument]
externalAPIs :: [ExternalAPIs]

Documentation

data ExternalAPIs Source #

Main Types TODO IsidoreAuth

Constructors

All
PubMed
HAL
IsTex
Isidore

Instances

Instances details

Bounded ExternalAPIs Source #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods minBound :: ExternalAPIs # maxBound :: ExternalAPIs #
Enum ExternalAPIs Source #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods succ :: ExternalAPIs -> ExternalAPIs # pred :: ExternalAPIs -> ExternalAPIs # toEnum :: Int -> ExternalAPIs # fromEnum :: ExternalAPIs -> Int # enumFrom :: ExternalAPIs -> [ExternalAPIs] # enumFromThen :: ExternalAPIs -> ExternalAPIs -> [ExternalAPIs] # enumFromTo :: ExternalAPIs -> ExternalAPIs -> [ExternalAPIs] # enumFromThenTo :: ExternalAPIs -> ExternalAPIs -> ExternalAPIs -> [ExternalAPIs] #
Eq ExternalAPIs Source #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods (==) :: ExternalAPIs -> ExternalAPIs -> Bool # (/=) :: ExternalAPIs -> ExternalAPIs -> Bool #
Show ExternalAPIs Source #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods showsPrec :: Int -> ExternalAPIs -> ShowS # show :: ExternalAPIs -> String # showList :: [ExternalAPIs] -> ShowS #
Generic ExternalAPIs Source #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Associated Types type Rep ExternalAPIs :: Type -> Type # Methods from :: ExternalAPIs -> Rep ExternalAPIs x # to :: Rep ExternalAPIs x -> ExternalAPIs #
Arbitrary ExternalAPIs Source #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods arbitrary :: Gen ExternalAPIs # shrink :: ExternalAPIs -> [ExternalAPIs] #
ToJSON ExternalAPIs Source #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods toJSON :: ExternalAPIs -> Value # toEncoding :: ExternalAPIs -> Encoding # toJSONList :: [ExternalAPIs] -> Value # toEncodingList :: [ExternalAPIs] -> Encoding #
FromJSON ExternalAPIs Source #	Main Instances
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods parseJSON :: Value -> Parser ExternalAPIs # parseJSONList :: Value -> Parser [ExternalAPIs] #
ToSchema ExternalAPIs Source #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods declareNamedSchema :: Proxy ExternalAPIs -> Declare (Definitions Schema) NamedSchema #
type Rep ExternalAPIs Source #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types type Rep ExternalAPIs = D1 ('MetaData "ExternalAPIs" "Gargantext.API.Admin.Orchestrator.Types" "gargantext-0.0.4.9.5-IFz7nHafad4HfDNkPsR1x8" 'False) ((C1 ('MetaCons "All" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PubMed" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HAL" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "IsTex" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Isidore" 'PrefixI 'False) (U1 :: Type -> Type))))

type Query = Query Source #

Some Sugar for the documentation

type Limit = Limit Source #

get :: ExternalAPIs -> Lang -> Query -> Maybe Limit -> IO [HyperdataDocument] Source #

Get External API metadata main function

externalAPIs :: [ExternalAPIs] Source #