Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Routes.Named.Search

Contents

Routes types
API types (appears in the routes)

Synopsis

data SearchAPI results mode = SearchAPI {
- searchEp :: mode :- (Summary "Search endpoint" :> (ReqBody '[JSON] SearchQuery :> (QueryParam "offset" Offset :> (QueryParam "limit" Limit :> (QueryParam "order" OrderBy :> Post '[JSON] results)))))
}
data SearchType
- = SearchDoc
- | SearchContact
- | SearchDocWithNgrams
data SearchQuery = SearchQuery {
- query :: !RawQuery
- expected :: !SearchType
}
newtype SearchResult = SearchResult {
- result :: SearchResultTypes
}
data SearchResultTypes
- = SearchResultDoc {
  - docs :: ![Row]
  }
- | SearchResultContact {
  - contacts :: ![Row]
  }
- | SearchNoResult {
  - message :: !Text
  }

Routes types

data SearchAPI results mode #

Constructors

SearchAPI
Fields searchEp :: mode :- (Summary "Search endpoint" :> (ReqBody '[JSON] SearchQuery :> (QueryParam "offset" Offset :> (QueryParam "limit" Limit :> (QueryParam "order" OrderBy :> Post '[JSON] results)))))

Instances

Instances details

Generic (SearchAPI results mode) #
Instance details Defined in Gargantext.API.Routes.Named.Search Associated Types type Rep (SearchAPI results mode) :: Type -> Type # Methods from :: SearchAPI results mode -> Rep (SearchAPI results mode) x # to :: Rep (SearchAPI results mode) x -> SearchAPI results mode #
type Rep (SearchAPI results mode) #
Instance details Defined in Gargantext.API.Routes.Named.Search type Rep (SearchAPI results mode) = D1 ('MetaData "SearchAPI" "Gargantext.API.Routes.Named.Search" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "SearchAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "searchEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary "Search endpoint" :> (ReqBody '[JSON] SearchQuery :> (QueryParam "offset" Offset :> (QueryParam "limit" Limit :> (QueryParam "order" OrderBy :> Post '[JSON] results)))))))))

API types (appears in the routes)

data SearchType #

Constructors

SearchDoc
SearchContact
SearchDocWithNgrams

Instances

Instances details

Arbitrary SearchType #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods arbitrary :: Gen SearchType # shrink :: SearchType -> [SearchType] #
FromJSON SearchType #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods parseJSON :: Value -> Parser SearchType # parseJSONList :: Value -> Parser [SearchType] #
ToJSON SearchType #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods toJSON :: SearchType -> Value # toEncoding :: SearchType -> Encoding # toJSONList :: [SearchType] -> Value # toEncodingList :: [SearchType] -> Encoding #
Generic SearchType #
Instance details Defined in Gargantext.API.Routes.Named.Search Associated Types type Rep SearchType :: Type -> Type # Methods from :: SearchType -> Rep SearchType x # to :: Rep SearchType x -> SearchType #
ToSchema SearchType #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods declareNamedSchema :: Proxy SearchType -> Declare (Definitions Schema) NamedSchema #
type Rep SearchType #
Instance details Defined in Gargantext.API.Routes.Named.Search type Rep SearchType = D1 ('MetaData "SearchType" "Gargantext.API.Routes.Named.Search" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "SearchDoc" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SearchContact" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SearchDocWithNgrams" 'PrefixI 'False) (U1 :: Type -> Type)))

data SearchQuery #

Constructors

SearchQuery
Fields query :: !RawQuery expected :: !SearchType

Instances

Instances details

Arbitrary SearchQuery #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods arbitrary :: Gen SearchQuery # shrink :: SearchQuery -> [SearchQuery] #
FromJSON SearchQuery #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods parseJSON :: Value -> Parser SearchQuery # parseJSONList :: Value -> Parser [SearchQuery] #
ToJSON SearchQuery #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods toJSON :: SearchQuery -> Value # toEncoding :: SearchQuery -> Encoding # toJSONList :: [SearchQuery] -> Value # toEncodingList :: [SearchQuery] -> Encoding #
Generic SearchQuery #
Instance details Defined in Gargantext.API.Routes.Named.Search Associated Types type Rep SearchQuery :: Type -> Type # Methods from :: SearchQuery -> Rep SearchQuery x # to :: Rep SearchQuery x -> SearchQuery #
ToSchema SearchQuery #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods declareNamedSchema :: Proxy SearchQuery -> Declare (Definitions Schema) NamedSchema #
type Rep SearchQuery #
Instance details Defined in Gargantext.API.Routes.Named.Search type Rep SearchQuery = D1 ('MetaData "SearchQuery" "Gargantext.API.Routes.Named.Search" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "SearchQuery" 'PrefixI 'True) (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RawQuery) :*: S1 ('MetaSel ('Just "expected") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SearchType)))

newtype SearchResult #

Constructors

SearchResult
Fields result :: SearchResultTypes

Instances

Instances details

Arbitrary SearchResult #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods arbitrary :: Gen SearchResult # shrink :: SearchResult -> [SearchResult] #
FromJSON SearchResult #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods parseJSON :: Value -> Parser SearchResult # parseJSONList :: Value -> Parser [SearchResult] #
ToJSON SearchResult #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods toJSON :: SearchResult -> Value # toEncoding :: SearchResult -> Encoding # toJSONList :: [SearchResult] -> Value # toEncodingList :: [SearchResult] -> Encoding #
Generic SearchResult #
Instance details Defined in Gargantext.API.Routes.Named.Search Associated Types type Rep SearchResult :: Type -> Type # Methods from :: SearchResult -> Rep SearchResult x # to :: Rep SearchResult x -> SearchResult #
ToSchema SearchResult #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods declareNamedSchema :: Proxy SearchResult -> Declare (Definitions Schema) NamedSchema #
type Rep SearchResult #
Instance details Defined in Gargantext.API.Routes.Named.Search type Rep SearchResult = D1 ('MetaData "SearchResult" "Gargantext.API.Routes.Named.Search" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "SearchResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "result") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SearchResultTypes)))

data SearchResultTypes #

Constructors

SearchResultDoc
Fields docs :: ![Row]
SearchResultContact
Fields contacts :: ![Row]
SearchNoResult
Fields message :: !Text

Instances

Instances details

Arbitrary SearchResultTypes #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods arbitrary :: Gen SearchResultTypes # shrink :: SearchResultTypes -> [SearchResultTypes] #
FromJSON SearchResultTypes #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods parseJSON :: Value -> Parser SearchResultTypes # parseJSONList :: Value -> Parser [SearchResultTypes] #
ToJSON SearchResultTypes #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods toJSON :: SearchResultTypes -> Value # toEncoding :: SearchResultTypes -> Encoding # toJSONList :: [SearchResultTypes] -> Value # toEncodingList :: [SearchResultTypes] -> Encoding #
Generic SearchResultTypes #
Instance details Defined in Gargantext.API.Routes.Named.Search Associated Types type Rep SearchResultTypes :: Type -> Type # Methods from :: SearchResultTypes -> Rep SearchResultTypes x # to :: Rep SearchResultTypes x -> SearchResultTypes #
ToSchema SearchResultTypes #
Instance details Defined in Gargantext.API.Routes.Named.Search Methods declareNamedSchema :: Proxy SearchResultTypes -> Declare (Definitions Schema) NamedSchema #
type Rep SearchResultTypes #
Instance details Defined in Gargantext.API.Routes.Named.Search type Rep SearchResultTypes