Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Routes.Named.Table

Contents

Routes types
API types (appears in the routes)

Synopsis

data TableAPI mode = TableAPI {
- getTableEp :: mode :- (Summary "Table API" :> (QueryParam "tabType" TabType :> (QueryParam "limit" Limit :> (QueryParam "offset" Offset :> (QueryParam "orderBy" OrderBy :> (QueryParam "query" RawQuery :> (QueryParam "year" Text :> Get '[JSON] (HashedResponse FacetTableResult))))))))
- postTableEp :: mode :- (Summary "Table API (POST)" :> (ReqBody '[JSON] TableQuery :> Post '[JSON] FacetTableResult))
- hashTableEp :: mode :- ("hash" :> (Summary "Hash Table" :> (QueryParam "tabType" TabType :> Get '[JSON] Text)))
}
data TableNgramsAPI mode = TableNgramsAPI {
- tableNgramsGetAPI :: mode :- NamedRoutes TableNgramsApiGet
- tableNgramsPutAPI :: mode :- NamedRoutes TableNgramsApiPut
- recomputeScoresEp :: mode :- NamedRoutes RecomputeScoresNgramsApiGet
- tableNgramsGetVersionEp :: mode :- ("version" :> NamedRoutes TableNgramsApiGetVersion)
- tableNgramsAsyncAPI :: mode :- NamedRoutes TableNgramsAsyncAPI
}
data TableNgramsApiGet mode = TableNgramsApiGet {
- getNgramsTableEp :: mode :- (Summary " Table Ngrams API Get" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> (QueryParamR "limit" Limit :> (QueryParam "offset" Offset :> (QueryParam "listType" ListType :> (QueryParam "minTermSize" MinSize :> (QueryParam "maxTermSize" MaxSize :> (QueryParam "orderBy" OrderBy :> (QueryParam "search" Text :> Get '[JSON] (VersionedWithCount NgramsTable)))))))))))
}
data TableNgramsApiPut mode = TableNgramsApiPut {
- putNgramsTableEp :: mode :- (Summary " Table Ngrams API Change" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> (ReqBody '[JSON] (Versioned NgramsTablePatch) :> Put '[JSON] (Versioned NgramsTablePatch)))))
}
data RecomputeScoresNgramsApiGet mode = RecomputeScoresNgramsApiGet {
- recomputeNgramsEp :: mode :- (Summary " Recompute scores for ngrams table" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> ("recompute" :> Post '[JSON] Int))))
}
data TableNgramsApiGetVersion mode = TableNgramsApiGetVersion {
- getTableNgramsVersion :: mode :- (Summary " Table Ngrams API Get Version" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> Get '[JSON] Version)))
}
data TableNgramsAsyncAPI mode = TableNgramsAsyncAPI {
- updateTableNgramsChartsEp :: mode :- (Summary "Table Ngrams Async API" :> ("async" :> ("charts" :> ("update" :> AsyncJobs JobLog '[JSON] UpdateTableNgramsCharts JobLog))))
}
data TableQuery = TableQuery {
- tq_offset :: Offset
- tq_limit :: Limit
- tq_orderBy :: OrderBy
- tq_view :: TabType
- tq_query :: RawQuery
}
type FacetTableResult = TableResult FacetDoc

Routes types

data TableAPI mode #

Constructors

TableAPI

Fields

getTableEp :: mode :- (Summary "Table API" :> (QueryParam "tabType" TabType :> (QueryParam "limit" Limit :> (QueryParam "offset" Offset :> (QueryParam "orderBy" OrderBy :> (QueryParam "query" RawQuery :> (QueryParam "year" Text :> Get '[JSON] (HashedResponse FacetTableResult))))))))
postTableEp :: mode :- (Summary "Table API (POST)" :> (ReqBody '[JSON] TableQuery :> Post '[JSON] FacetTableResult))
hashTableEp :: mode :- ("hash" :> (Summary "Hash Table" :> (QueryParam "tabType" TabType :> Get '[JSON] Text)))

Instances

Instances details

Generic (TableAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table Associated Types type Rep (TableAPI mode) :: Type -> Type # Methods from :: TableAPI mode -> Rep (TableAPI mode) x # to :: Rep (TableAPI mode) x -> TableAPI mode #
type Rep (TableAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table type Rep (TableAPI mode) = D1 ('MetaData "TableAPI" "Gargantext.API.Routes.Named.Table" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "TableAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTableEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary "Table API" :> (QueryParam "tabType" TabType :> (QueryParam "limit" Limit :> (QueryParam "offset" Offset :> (QueryParam "orderBy" OrderBy :> (QueryParam "query" RawQuery :> (QueryParam "year" Text :> Get '[JSON] (HashedResponse FacetTableResult)))))))))) :: (S1 ('MetaSel ('Just "postTableEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary "Table API (POST)" :> (ReqBody '[JSON] TableQuery :> Post '[JSON] FacetTableResult)))) :: S1 ('MetaSel ('Just "hashTableEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("hash" :> (Summary "Hash Table" :> (QueryParam "tabType" TabType :> Get '[JSON] Text))))))))

data TableNgramsAPI mode #

Constructors

TableNgramsAPI
Fields tableNgramsGetAPI :: mode :- NamedRoutes TableNgramsApiGet tableNgramsPutAPI :: mode :- NamedRoutes TableNgramsApiPut recomputeScoresEp :: mode :- NamedRoutes RecomputeScoresNgramsApiGet tableNgramsGetVersionEp :: mode :- ("version" :> NamedRoutes TableNgramsApiGetVersion) tableNgramsAsyncAPI :: mode :- NamedRoutes TableNgramsAsyncAPI

Instances

Instances details

Generic (TableNgramsAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table Associated Types type Rep (TableNgramsAPI mode) :: Type -> Type # Methods from :: TableNgramsAPI mode -> Rep (TableNgramsAPI mode) x # to :: Rep (TableNgramsAPI mode) x -> TableNgramsAPI mode #
type Rep (TableNgramsAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table type Rep (TableNgramsAPI mode) = D1 ('MetaData "TableNgramsAPI" "Gargantext.API.Routes.Named.Table" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "TableNgramsAPI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tableNgramsGetAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes TableNgramsApiGet)) :: S1 ('MetaSel ('Just "tableNgramsPutAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes TableNgramsApiPut))) :: (S1 ('MetaSel ('Just "recomputeScoresEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes RecomputeScoresNgramsApiGet)) :: (S1 ('MetaSel ('Just "tableNgramsGetVersionEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("version" :> NamedRoutes TableNgramsApiGetVersion))) :: S1 ('MetaSel ('Just "tableNgramsAsyncAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes TableNgramsAsyncAPI))))))

data TableNgramsApiGet mode #

Constructors

TableNgramsApiGet

Fields

getNgramsTableEp :: mode :- (Summary " Table Ngrams API Get" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> (QueryParamR "limit" Limit :> (QueryParam "offset" Offset :> (QueryParam "listType" ListType :> (QueryParam "minTermSize" MinSize :> (QueryParam "maxTermSize" MaxSize :> (QueryParam "orderBy" OrderBy :> (QueryParam "search" Text :> Get '[JSON] (VersionedWithCount NgramsTable)))))))))))

Instances

Instances details

Generic (TableNgramsApiGet mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table Associated Types type Rep (TableNgramsApiGet mode) :: Type -> Type # Methods from :: TableNgramsApiGet mode -> Rep (TableNgramsApiGet mode) x # to :: Rep (TableNgramsApiGet mode) x -> TableNgramsApiGet mode #
type Rep (TableNgramsApiGet mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table type Rep (TableNgramsApiGet mode) = D1 ('MetaData "TableNgramsApiGet" "Gargantext.API.Routes.Named.Table" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "TableNgramsApiGet" 'PrefixI 'True) (S1 ('MetaSel ('Just "getNgramsTableEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary " Table Ngrams API Get" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> (QueryParamR "limit" Limit :> (QueryParam "offset" Offset :> (QueryParam "listType" ListType :> (QueryParam "minTermSize" MinSize :> (QueryParam "maxTermSize" MaxSize :> (QueryParam "orderBy" OrderBy :> (QueryParam "search" Text :> Get '[JSON] (VersionedWithCount NgramsTable)))))))))))))))

data TableNgramsApiPut mode #

Constructors

TableNgramsApiPut
Fields putNgramsTableEp :: mode :- (Summary " Table Ngrams API Change" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> (ReqBody '[JSON] (Versioned NgramsTablePatch) :> Put '[JSON] (Versioned NgramsTablePatch)))))

Instances

Instances details

Generic (TableNgramsApiPut mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table Associated Types type Rep (TableNgramsApiPut mode) :: Type -> Type # Methods from :: TableNgramsApiPut mode -> Rep (TableNgramsApiPut mode) x # to :: Rep (TableNgramsApiPut mode) x -> TableNgramsApiPut mode #
type Rep (TableNgramsApiPut mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table type Rep (TableNgramsApiPut mode) = D1 ('MetaData "TableNgramsApiPut" "Gargantext.API.Routes.Named.Table" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "TableNgramsApiPut" 'PrefixI 'True) (S1 ('MetaSel ('Just "putNgramsTableEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary " Table Ngrams API Change" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> (ReqBody '[JSON] (Versioned NgramsTablePatch) :> Put '[JSON] (Versioned NgramsTablePatch)))))))))

data RecomputeScoresNgramsApiGet mode #

Constructors

RecomputeScoresNgramsApiGet
Fields recomputeNgramsEp :: mode :- (Summary " Recompute scores for ngrams table" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> ("recompute" :> Post '[JSON] Int))))

Instances

Instances details

Generic (RecomputeScoresNgramsApiGet mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table Associated Types type Rep (RecomputeScoresNgramsApiGet mode) :: Type -> Type # Methods from :: RecomputeScoresNgramsApiGet mode -> Rep (RecomputeScoresNgramsApiGet mode) x # to :: Rep (RecomputeScoresNgramsApiGet mode) x -> RecomputeScoresNgramsApiGet mode #
type Rep (RecomputeScoresNgramsApiGet mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table type Rep (RecomputeScoresNgramsApiGet mode) = D1 ('MetaData "RecomputeScoresNgramsApiGet" "Gargantext.API.Routes.Named.Table" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "RecomputeScoresNgramsApiGet" 'PrefixI 'True) (S1 ('MetaSel ('Just "recomputeNgramsEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary " Recompute scores for ngrams table" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> ("recompute" :> Post '[JSON] Int))))))))

data TableNgramsApiGetVersion mode #

Constructors

TableNgramsApiGetVersion
Fields getTableNgramsVersion :: mode :- (Summary " Table Ngrams API Get Version" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> Get '[JSON] Version)))

Instances

Instances details

Generic (TableNgramsApiGetVersion mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table Associated Types type Rep (TableNgramsApiGetVersion mode) :: Type -> Type # Methods from :: TableNgramsApiGetVersion mode -> Rep (TableNgramsApiGetVersion mode) x # to :: Rep (TableNgramsApiGetVersion mode) x -> TableNgramsApiGetVersion mode #
type Rep (TableNgramsApiGetVersion mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table type Rep (TableNgramsApiGetVersion mode) = D1 ('MetaData "TableNgramsApiGetVersion" "Gargantext.API.Routes.Named.Table" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "TableNgramsApiGetVersion" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTableNgramsVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary " Table Ngrams API Get Version" :> (QueryParamR "ngramsType" TabType :> (QueryParamR "list" ListId :> Get '[JSON] Version)))))))

data TableNgramsAsyncAPI mode #

Constructors

TableNgramsAsyncAPI
Fields updateTableNgramsChartsEp :: mode :- (Summary "Table Ngrams Async API" :> ("async" :> ("charts" :> ("update" :> AsyncJobs JobLog '[JSON] UpdateTableNgramsCharts JobLog))))

Instances

Instances details

Generic (TableNgramsAsyncAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table Associated Types type Rep (TableNgramsAsyncAPI mode) :: Type -> Type # Methods from :: TableNgramsAsyncAPI mode -> Rep (TableNgramsAsyncAPI mode) x # to :: Rep (TableNgramsAsyncAPI mode) x -> TableNgramsAsyncAPI mode #
type Rep (TableNgramsAsyncAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Table type Rep (TableNgramsAsyncAPI mode) = D1 ('MetaData "TableNgramsAsyncAPI" "Gargantext.API.Routes.Named.Table" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "TableNgramsAsyncAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "updateTableNgramsChartsEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary "Table Ngrams Async API" :> ("async" :> ("charts" :> ("update" :> AsyncJobs JobLog '[JSON] UpdateTableNgramsCharts JobLog))))))))

API types (appears in the routes)

data TableQuery #

Constructors

TableQuery
Fields tq_offset :: Offset tq_limit :: Limit tq_orderBy :: OrderBy tq_view :: TabType tq_query :: RawQuery

Instances

Instances details

Arbitrary TableQuery #
Instance details Defined in Gargantext.API.Routes.Named.Table Methods arbitrary :: Gen TableQuery # shrink :: TableQuery -> [TableQuery] #
FromJSON TableQuery #
Instance details Defined in Gargantext.API.Routes.Named.Table Methods parseJSON :: Value -> Parser TableQuery # parseJSONList :: Value -> Parser [TableQuery] #
ToJSON TableQuery #
Instance details Defined in Gargantext.API.Routes.Named.Table Methods toJSON :: TableQuery -> Value # toEncoding :: TableQuery -> Encoding # toJSONList :: [TableQuery] -> Value # toEncodingList :: [TableQuery] -> Encoding #
Generic TableQuery #
Instance details Defined in Gargantext.API.Routes.Named.Table Associated Types type Rep TableQuery :: Type -> Type # Methods from :: TableQuery -> Rep TableQuery x # to :: Rep TableQuery x -> TableQuery #
ToSchema TableQuery #
Instance details Defined in Gargantext.API.Routes.Named.Table Methods declareNamedSchema :: Proxy TableQuery -> Declare (Definitions Schema) NamedSchema #
type Rep TableQuery #
Instance details Defined in Gargantext.API.Routes.Named.Table type Rep TableQuery = D1 ('MetaData "TableQuery" "Gargantext.API.Routes.Named.Table" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "TableQuery" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tq_offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Offset) :: S1 ('MetaSel ('Just "tq_limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Limit)) :: (S1 ('MetaSel ('Just "tq_orderBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OrderBy) :: (S1 ('MetaSel ('Just "tq_view") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TabType) :: S1 ('MetaSel ('Just "tq_query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RawQuery)))))

type FacetTableResult = TableResult FacetDoc #