Merge pull request #127 from Soostone/haddock-sections

Break up client API into sections
2024-12-04 08:47:36 +03:00 · 2016-08-08 12:30:32 -05:00 · 2016-08-08 12:30:32 -05:00 · 947ad42ac9
commit 947ad42ac9
parent 4a7d9fec51 2c15504227
1 changed files with 11 additions and 0 deletions
--- a/src/Database/Bloodhound/Client.hs
+++ b/src/Database/Bloodhound/Client.hs
@ -23,6 +23,7 @@ module Database.Bloodhound.Client

         -- $setup
         withBH
+       -- ** Indices
       , createIndex
       , deleteIndex
       , updateIndexSettings
@ -32,18 +33,23 @@ module Database.Bloodhound.Client
       , openIndex
       , closeIndex
       , listIndices
+       -- *** Index Aliases
       , updateIndexAliases
       , getIndexAliases
+       -- *** Index Templates
       , putTemplate
       , templateExists
       , deleteTemplate
+       -- ** Mapping
       , putMapping
       , deleteMapping
+       -- ** Documents
       , indexDocument
       , updateDocument
       , getDocument
       , documentExists
       , deleteDocument
+       -- ** Searching
       , searchAll
       , searchByIndex
       , searchByType
@ -59,14 +65,19 @@ module Database.Bloodhound.Client
       , mkShardCount
       , mkReplicaCount
       , getStatus
+       -- ** Snapshot/Restore
+       -- *** Snapshot Repos
       , getSnapshotRepos
       , updateSnapshotRepo
       , verifySnapshotRepo
       , deleteSnapshotRepo
+       -- *** Snapshots
       , createSnapshot
       , getSnapshots
       , deleteSnapshot
+       -- *** Restoring Snapshots
       , restoreSnapshot
+       -- ** Request Utilities
       , encodeBulkOperations
       , encodeBulkOperation
       -- * Authentication