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

Gargantext.Core.Viz.Phylo.API

Contents

Orphan instances

Description

Synopsis

type PhyloAPI = (Summary "Phylo API" :> GetPhylo) :<|> PostPhylo
phyloAPI :: PhyloId -> GargServer PhyloAPI
newtype SVG = SVG ByteString
data PhyloData = PhyloData {
- pd_corpusId :: NodeId
- pd_listId :: NodeId
- pd_data :: GraphData
- pd_config :: PhyloConfig
}
type GetPhylo = QueryParam "listId" ListId :> (QueryParam "level" Level :> (QueryParam "minSizeBranch" MinSizeBranch :> Get '[JSON] PhyloData))
getPhylo :: PhyloId -> GargServer GetPhylo
getPhyloDataJson :: PhyloId -> GargNoServer (GraphData, PhyloConfig)
type PostPhylo = QueryParam "listId" ListId :> Post '[JSON] NodeId
postPhylo :: PhyloId -> GargServer PostPhylo

Documentation

type PhyloAPI = (Summary "Phylo API" :> GetPhylo) :<|> PostPhylo #

phyloAPI :: PhyloId -> GargServer PhyloAPI #

newtype SVG #

Constructors

SVG ByteString

Instances

Instances details

Show SVG #
Instance details Defined in Gargantext.Core.Viz.Phylo.API Methods showsPrec :: Int -> SVG -> ShowS # show :: SVG -> String # showList :: [SVG] -> ShowS #
ToSchema SVG #
Instance details Defined in Gargantext.Core.Viz.Phylo.API Methods declareNamedSchema :: Proxy SVG -> Declare (Definitions Schema) NamedSchema #
Accept SVG #
Instance details Defined in Gargantext.Core.Viz.Phylo.API Methods contentType :: Proxy SVG -> MediaType # contentTypes :: Proxy SVG -> NonEmpty MediaType #
MimeRender SVG SVG #
Instance details Defined in Gargantext.Core.Viz.Phylo.API Methods mimeRender :: Proxy SVG -> SVG -> ByteString #
MimeUnrender SVG SVG #
Instance details Defined in Gargantext.Core.Viz.Phylo.API Methods mimeUnrender :: Proxy SVG -> ByteString -> Either String SVG # mimeUnrenderWithType :: Proxy SVG -> MediaType -> ByteString -> Either String SVG #

data PhyloData #

This type is emitted by the backend and the frontend expects to deserialise it as a PhyloJSON. see module JSON of the 'purescript-gargantext' package.

Constructors

PhyloData
Fields pd_corpusId :: NodeId pd_listId :: NodeId pd_data :: GraphData pd_config :: PhyloConfig

Instances

Instances details

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

type GetPhylo = QueryParam "listId" ListId :> (QueryParam "level" Level :> (QueryParam "minSizeBranch" MinSizeBranch :> Get '[JSON] PhyloData)) #

getPhylo :: PhyloId -> GargServer GetPhylo #

TODO Add real text processing Fix Filter parameters TODO fix parameters to default config that should be in Node

getPhyloDataJson :: PhyloId -> GargNoServer (GraphData, PhyloConfig) #

type PostPhylo = QueryParam "listId" ListId :> Post '[JSON] NodeId #

postPhylo :: PhyloId -> GargServer PostPhylo #

Orphan instances

ToSchema Value #
Instance details Methods declareNamedSchema :: Proxy Value -> Declare (Definitions Schema) NamedSchema #