| Copyright | (c) CNRS 2017-Present |
|---|---|
| License | AGPL + CECILL v3 |
| Maintainer | team@gargantext.org |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Gargantext.API.Node.Corpus.New
Description
New corpus means either: - new corpus - new data in existing corpus
Synopsis
- data ApiInfo = ApiInfo {
- api_info :: [ExternalAPIs]
- info :: ApiInfo
- type AddWithQuery = Summary "Add with Query to corpus endpoint" :> ("corpus" :> (Capture "corpus_id" CorpusId :> ("query" :> AsyncJobs JobLog '[JSON] WithQuery JobLog)))
- addToCorpusWithQuery :: (FlowCmdM env err m, MonadJobStatus m, HasNodeStoryImmediateSaver env, HasNodeArchiveStoryImmediateSaver env) => User -> CorpusId -> WithQuery -> Maybe Limit -> JobHandle m -> m ()
- type AddWithForm = Summary "Add with FormUrlEncoded to corpus endpoint" :> ("corpus" :> (Capture "corpus_id" CorpusId :> ("add" :> ("form" :> ("async" :> AsyncJobs JobLog '[FormUrlEncoded] NewWithForm JobLog)))))
- addToCorpusWithForm :: (FlowCmdM env err m, MonadJobStatus m, HasNodeStoryImmediateSaver env, HasNodeArchiveStoryImmediateSaver env) => User -> CorpusId -> NewWithForm -> JobHandle m -> m ()
- type AddWithFile = Summary "Add with FileUrlEncoded to corpus endpoint" :> ("corpus" :> (Capture "corpus_id" CorpusId :> ("add" :> ("file" :> ("async" :> AsyncJobs JobLog '[FormUrlEncoded] NewWithFile JobLog)))))
- addToCorpusWithFile :: (HasSettings env, FlowCmdM env err m, MonadJobStatus m) => User -> CorpusId -> NewWithFile -> JobHandle m -> m ()
- commitCorpus :: (FlowCmdM env err m, HasNodeArchiveStoryImmediateSaver env, HasNodeStoryImmediateSaver env) => ParentId -> User -> m (Versioned NgramsStatePatch')
Documentation
TODO manage several apis TODO-ACCESS TODO this is only the POST
Constructors
| ApiInfo | |
Fields
| |
Instances
| Arbitrary ApiInfo # | |
| FromJSON ApiInfo # | |
| ToJSON ApiInfo # | |
Defined in Gargantext.API.Node.Corpus.New | |
| Generic ApiInfo # | |
| ToSchema ApiInfo # | |
Defined in Gargantext.API.Node.Corpus.New Methods declareNamedSchema :: Proxy ApiInfo -> Declare (Definitions Schema) NamedSchema # | |
| type Rep ApiInfo # | |
Defined in Gargantext.API.Node.Corpus.New type Rep ApiInfo = D1 ('MetaData "ApiInfo" "Gargantext.API.Node.Corpus.New" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "ApiInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "api_info") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ExternalAPIs]))) | |
type AddWithQuery = Summary "Add with Query to corpus endpoint" :> ("corpus" :> (Capture "corpus_id" CorpusId :> ("query" :> AsyncJobs JobLog '[JSON] WithQuery JobLog))) #
addToCorpusWithQuery :: (FlowCmdM env err m, MonadJobStatus m, HasNodeStoryImmediateSaver env, HasNodeArchiveStoryImmediateSaver env) => User -> CorpusId -> WithQuery -> Maybe Limit -> JobHandle m -> m () #
type AddWithForm = Summary "Add with FormUrlEncoded to corpus endpoint" :> ("corpus" :> (Capture "corpus_id" CorpusId :> ("add" :> ("form" :> ("async" :> AsyncJobs JobLog '[FormUrlEncoded] NewWithForm JobLog))))) #
addToCorpusWithForm :: (FlowCmdM env err m, MonadJobStatus m, HasNodeStoryImmediateSaver env, HasNodeArchiveStoryImmediateSaver env) => User -> CorpusId -> NewWithForm -> JobHandle m -> m () #
type AddWithFile = Summary "Add with FileUrlEncoded to corpus endpoint" :> ("corpus" :> (Capture "corpus_id" CorpusId :> ("add" :> ("file" :> ("async" :> AsyncJobs JobLog '[FormUrlEncoded] NewWithFile JobLog))))) #
addToCorpusWithFile :: (HasSettings env, FlowCmdM env err m, MonadJobStatus m) => User -> CorpusId -> NewWithFile -> JobHandle m -> m () #
commitCorpus :: (FlowCmdM env err m, HasNodeArchiveStoryImmediateSaver env, HasNodeStoryImmediateSaver env) => ParentId -> User -> m (Versioned NgramsStatePatch') #