Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Routes.Named.Metrics

Contents

Routes types

Synopsis

data TreeAPI mode = TreeAPI {
- treeChartEp :: mode :- (Summary " Tree API" :> (QueryParam "from" UTCTime :> (QueryParam "to" UTCTime :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParamR "listType" ListType :> Get '[JSON] (HashedResponse (ChartMetrics (Vector NgramsTree)))))))))
- treeChartUpdateEp :: mode :- (Summary "Tree Chart update" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParamR "listType" ListType :> Post '[JSON] ()))))
- treeHashEp :: mode :- ("hash" :> (Summary "Tree Hash" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParamR "listType" ListType :> Get '[JSON] Text)))))
}
data ScatterAPI mode = ScatterAPI {
- sepGenEp :: mode :- (Summary "SepGen IncExc metrics" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParam "limit" Limit :> Get '[JSON] (HashedResponse Metrics)))))
- scatterUpdateEp :: mode :- (Summary "Scatter update" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParam "limit" Limit :> Post '[JSON] ()))))
- scatterHashEp :: mode :- ("hash" :> (Summary "Scatter Hash" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> Get '[JSON] Text))))
}
data ChartAPI mode = ChartAPI {
- getChartEp :: mode :- (Summary " Chart API" :> (QueryParam "from" UTCTime :> (QueryParam "to" UTCTime :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> Get '[JSON] (HashedResponse (ChartMetrics Histo)))))))
- updateChartEp :: mode :- (Summary "Chart update" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParam "limit" Limit :> Post '[JSON] ()))))
- chartHashEp :: mode :- ("hash" :> (Summary "Chart Hash" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> Get '[JSON] Text))))
}
data PieAPI mode = PieAPI {
- getPieChartEp :: mode :- (Summary "Pie Chart" :> (QueryParam "from" UTCTime :> (QueryParam "to" UTCTime :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> Get '[JSON] (HashedResponse (ChartMetrics Histo)))))))
- pieChartUpdateEp :: mode :- (Summary "Pie Chart update" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParam "limit" Limit :> Post '[JSON] ()))))
- pieHashEp :: mode :- ("hash" :> (Summary "Pie Hash" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> Get '[JSON] Text))))
}

Routes types

data TreeAPI mode #

Constructors

TreeAPI

Fields

treeChartEp :: mode :- (Summary " Tree API" :> (QueryParam "from" UTCTime :> (QueryParam "to" UTCTime :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParamR "listType" ListType :> Get '[JSON] (HashedResponse (ChartMetrics (Vector NgramsTree)))))))))
treeChartUpdateEp :: mode :- (Summary "Tree Chart update" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParamR "listType" ListType :> Post '[JSON] ()))))
treeHashEp :: mode :- ("hash" :> (Summary "Tree Hash" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParamR "listType" ListType :> Get '[JSON] Text)))))

Instances

Instances details

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

data ScatterAPI mode #

Constructors

ScatterAPI

Fields

sepGenEp :: mode :- (Summary "SepGen IncExc metrics" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParam "limit" Limit :> Get '[JSON] (HashedResponse Metrics)))))
scatterUpdateEp :: mode :- (Summary "Scatter update" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParam "limit" Limit :> Post '[JSON] ()))))
scatterHashEp :: mode :- ("hash" :> (Summary "Scatter Hash" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> Get '[JSON] Text))))

Instances

Instances details

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

data ChartAPI mode #

Constructors

ChartAPI

Fields

getChartEp :: mode :- (Summary " Chart API" :> (QueryParam "from" UTCTime :> (QueryParam "to" UTCTime :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> Get '[JSON] (HashedResponse (ChartMetrics Histo)))))))
updateChartEp :: mode :- (Summary "Chart update" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParam "limit" Limit :> Post '[JSON] ()))))
chartHashEp :: mode :- ("hash" :> (Summary "Chart Hash" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> Get '[JSON] Text))))

Instances

Instances details

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

data PieAPI mode #

Constructors

PieAPI

Fields

getPieChartEp :: mode :- (Summary "Pie Chart" :> (QueryParam "from" UTCTime :> (QueryParam "to" UTCTime :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> Get '[JSON] (HashedResponse (ChartMetrics Histo)))))))
pieChartUpdateEp :: mode :- (Summary "Pie Chart update" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> (QueryParam "limit" Limit :> Post '[JSON] ()))))
pieHashEp :: mode :- ("hash" :> (Summary "Pie Hash" :> (QueryParam "list" ListId :> (QueryParamR "ngramsType" TabType :> Get '[JSON] Text))))

Instances

Instances details

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