Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Routes.Named.Count

Contents

Routes types
Re-exports

Synopsis

newtype CountAPI mode = CountAPI {
- postCountsEp :: mode :- Post '[JSON] Counts
}
type Error = Text
data Counts = Counts {
- results :: [Either Message Count]
}
data Message = Message Code Errors
type Code = Integer
data Query = Query {
- query_query :: QueryBool
- query_name :: Maybe [Scraper]
}
data Count = Count {
- count_name :: Scraper
- count_count :: Maybe Int
}
type Errors = [Error]
data Scraper
- = Pubmed
- | Hal
- | IsTex
- | Isidore
data QueryBool = QueryBool Text
count :: Monad m => Query -> m Counts
scrapers :: [Scraper]

Routes types

newtype CountAPI mode #

Constructors

CountAPI
Fields postCountsEp :: mode :- Post '[JSON] Counts

Instances

Instances details

Generic (CountAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Count Associated Types type Rep (CountAPI mode) :: Type -> Type # Methods from :: CountAPI mode -> Rep (CountAPI mode) x # to :: Rep (CountAPI mode) x -> CountAPI mode #
type Rep (CountAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Count type Rep (CountAPI mode) = D1 ('MetaData "CountAPI" "Gargantext.API.Routes.Named.Count" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "CountAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "postCountsEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- Post '[JSON] Counts))))

Re-exports

type Error = Text #

data Counts #

Constructors

Counts
Fields results :: [Either Message Count]

Instances

Instances details

Arbitrary Counts #
Instance details Defined in Gargantext.API.Count Methods arbitrary :: Gen Counts # shrink :: Counts -> [Counts] #
FromJSON Counts #
Instance details Defined in Gargantext.API.Count Methods parseJSON :: Value -> Parser Counts # parseJSONList :: Value -> Parser [Counts] #
ToJSON Counts #
Instance details Defined in Gargantext.API.Count Methods toJSON :: Counts -> Value # toEncoding :: Counts -> Encoding # toJSONList :: [Counts] -> Value # toEncodingList :: [Counts] -> Encoding #
Generic Counts #
Instance details Defined in Gargantext.API.Count Associated Types type Rep Counts :: Type -> Type # Methods from :: Counts -> Rep Counts x # to :: Rep Counts x -> Counts #
Show Counts #
Instance details Defined in Gargantext.API.Count Methods showsPrec :: Int -> Counts -> ShowS # show :: Counts -> String # showList :: [Counts] -> ShowS #
Eq Counts #
Instance details Defined in Gargantext.API.Count Methods (==) :: Counts -> Counts -> Bool # (/=) :: Counts -> Counts -> Bool #
ToSchema Counts #
Instance details Defined in Gargantext.API.Count Methods declareNamedSchema :: Proxy Counts -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
type Rep Counts #
Instance details Defined in Gargantext.API.Count type Rep Counts = D1 ('MetaData "Counts" "Gargantext.API.Count" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "Counts" 'PrefixI 'True) (S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Either Message Count])))

data Message #

Constructors

Message Code Errors

Instances

Instances details

Arbitrary Message #
Instance details Defined in Gargantext.API.Count Methods arbitrary :: Gen Message # shrink :: Message -> [Message] #
FromJSON Message #
Instance details Defined in Gargantext.API.Count Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] #
ToJSON Message #
Instance details Defined in Gargantext.API.Count Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding #
Generic Message #
Instance details Defined in Gargantext.API.Count Associated Types type Rep Message :: Type -> Type # Methods from :: Message -> Rep Message x # to :: Rep Message x -> Message #
Show Message #
Instance details Defined in Gargantext.API.Count Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Eq Message #
Instance details Defined in Gargantext.API.Count Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
ToSchema Message #
Instance details Defined in Gargantext.API.Count Methods declareNamedSchema :: Proxy Message -> Declare (Definitions Schema) NamedSchema #
type Rep Message #
Instance details Defined in Gargantext.API.Count type Rep Message = D1 ('MetaData "Message" "Gargantext.API.Count" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "Message" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Code) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Errors)))

type Code = Integer #

data Query #

Constructors

Query
Fields query_query :: QueryBool query_name :: Maybe [Scraper]

Instances

Instances details

Arbitrary Query #
Instance details Defined in Gargantext.API.Count Methods arbitrary :: Gen Query # shrink :: Query -> [Query] #
FromJSON Query #
Instance details Defined in Gargantext.API.Count Methods parseJSON :: Value -> Parser Query # parseJSONList :: Value -> Parser [Query] #
ToJSON Query #
Instance details Defined in Gargantext.API.Count Methods toJSON :: Query -> Value # toEncoding :: Query -> Encoding # toJSONList :: [Query] -> Value # toEncodingList :: [Query] -> Encoding #
Generic Query #
Instance details Defined in Gargantext.API.Count Associated Types type Rep Query :: Type -> Type # Methods from :: Query -> Rep Query x # to :: Rep Query x -> Query #
Show Query #
Instance details Defined in Gargantext.API.Count Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #
Eq Query #
Instance details Defined in Gargantext.API.Count Methods (==) :: Query -> Query -> Bool # (/=) :: Query -> Query -> Bool #
ToSchema Query #
Instance details Defined in Gargantext.API.Count Methods declareNamedSchema :: Proxy Query -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
type Rep Query #
Instance details Defined in Gargantext.API.Count type Rep Query = D1 ('MetaData "Query" "Gargantext.API.Count" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "Query" 'PrefixI 'True) (S1 ('MetaSel ('Just "query_query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 QueryBool) :*: S1 ('MetaSel ('Just "query_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Scraper]))))

data Count #

Constructors

Count
Fields count_name :: Scraper count_count :: Maybe Int

Instances

Instances details

FromJSON Count #
Instance details Defined in Gargantext.API.Count Methods parseJSON :: Value -> Parser Count # parseJSONList :: Value -> Parser [Count] #
ToJSON Count #
Instance details Defined in Gargantext.API.Count Methods toJSON :: Count -> Value # toEncoding :: Count -> Encoding # toJSONList :: [Count] -> Value # toEncodingList :: [Count] -> Encoding #
Generic Count #
Instance details Defined in Gargantext.API.Count Associated Types type Rep Count :: Type -> Type # Methods from :: Count -> Rep Count x # to :: Rep Count x -> Count #
Show Count #
Instance details Defined in Gargantext.API.Count Methods showsPrec :: Int -> Count -> ShowS # show :: Count -> String # showList :: [Count] -> ShowS #
Eq Count #
Instance details Defined in Gargantext.API.Count Methods (==) :: Count -> Count -> Bool # (/=) :: Count -> Count -> Bool #
ToSchema Count #
Instance details Defined in Gargantext.API.Count Methods declareNamedSchema :: Proxy Count -> Declare (Definitions Schema) NamedSchema #
type Rep Count #
Instance details Defined in Gargantext.API.Count type Rep Count = D1 ('MetaData "Count" "Gargantext.API.Count" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "Count" 'PrefixI 'True) (S1 ('MetaSel ('Just "count_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scraper) :*: S1 ('MetaSel ('Just "count_count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))

type Errors = [Error] #

data Scraper #

Constructors

Pubmed
Hal
IsTex
Isidore

Instances

Instances details

Arbitrary Scraper #
Instance details Defined in Gargantext.API.Count Methods arbitrary :: Gen Scraper # shrink :: Scraper -> [Scraper] #
FromJSON Scraper #
Instance details Defined in Gargantext.API.Count Methods parseJSON :: Value -> Parser Scraper # parseJSONList :: Value -> Parser [Scraper] #
ToJSON Scraper #
Instance details Defined in Gargantext.API.Count Methods toJSON :: Scraper -> Value # toEncoding :: Scraper -> Encoding # toJSONList :: [Scraper] -> Value # toEncodingList :: [Scraper] -> Encoding #
Bounded Scraper #
Instance details Defined in Gargantext.API.Count Methods minBound :: Scraper # maxBound :: Scraper #
Enum Scraper #
Instance details Defined in Gargantext.API.Count Methods succ :: Scraper -> Scraper # pred :: Scraper -> Scraper # toEnum :: Int -> Scraper # fromEnum :: Scraper -> Int # enumFrom :: Scraper -> [Scraper] # enumFromThen :: Scraper -> Scraper -> [Scraper] # enumFromTo :: Scraper -> Scraper -> [Scraper] # enumFromThenTo :: Scraper -> Scraper -> Scraper -> [Scraper] #
Generic Scraper #
Instance details Defined in Gargantext.API.Count Associated Types type Rep Scraper :: Type -> Type # Methods from :: Scraper -> Rep Scraper x # to :: Rep Scraper x -> Scraper #
Show Scraper #
Instance details Defined in Gargantext.API.Count Methods showsPrec :: Int -> Scraper -> ShowS # show :: Scraper -> String # showList :: [Scraper] -> ShowS #
Eq Scraper #
Instance details Defined in Gargantext.API.Count Methods (==) :: Scraper -> Scraper -> Bool # (/=) :: Scraper -> Scraper -> Bool #
ToSchema Scraper #
Instance details Defined in Gargantext.API.Count Methods declareNamedSchema :: Proxy Scraper -> Declare (Definitions Schema) NamedSchema #
type Rep Scraper #
Instance details Defined in Gargantext.API.Count type Rep Scraper = D1 ('MetaData "Scraper" "Gargantext.API.Count" "gargantext-0.0.7.1.5.3-inplace" 'False) ((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)))

data QueryBool #

Constructors

QueryBool Text

Instances

Instances details

Arbitrary QueryBool #
Instance details Defined in Gargantext.API.Count Methods arbitrary :: Gen QueryBool # shrink :: QueryBool -> [QueryBool] #
FromJSON QueryBool #
Instance details Defined in Gargantext.API.Count Methods parseJSON :: Value -> Parser QueryBool # parseJSONList :: Value -> Parser [QueryBool] #
ToJSON QueryBool #
Instance details Defined in Gargantext.API.Count Methods toJSON :: QueryBool -> Value # toEncoding :: QueryBool -> Encoding # toJSONList :: [QueryBool] -> Value # toEncodingList :: [QueryBool] -> Encoding #
Generic QueryBool #
Instance details Defined in Gargantext.API.Count Associated Types type Rep QueryBool :: Type -> Type # Methods from :: QueryBool -> Rep QueryBool x # to :: Rep QueryBool x -> QueryBool #
Show QueryBool #
Instance details Defined in Gargantext.API.Count Methods showsPrec :: Int -> QueryBool -> ShowS # show :: QueryBool -> String # showList :: [QueryBool] -> ShowS #
Eq QueryBool #
Instance details Defined in Gargantext.API.Count Methods (==) :: QueryBool -> QueryBool -> Bool # (/=) :: QueryBool -> QueryBool -> Bool #
ToSchema QueryBool #
Instance details Defined in Gargantext.API.Count Methods declareNamedSchema :: Proxy QueryBool -> Declare (Definitions Schema) NamedSchema #
type Rep QueryBool #
Instance details Defined in Gargantext.API.Count type Rep QueryBool = D1 ('MetaData "QueryBool" "Gargantext.API.Count" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "QueryBool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

count :: Monad m => Query -> m Counts #

scrapers :: [Scraper] #