git.iko.soy/typeable/bloodhound
on master help sign in
Merge pull request #127 from Soostone/haddock-sections

Break up client API into sections

commit947ad42ac99a020e48cc029255418cc48c7350a6 authorChris Allen <cma@bitemyapp.com> dateMon 8 Aug 2016, 12:30 (10 years ago) parent4a7d9fe2c15504
1 file changed+11
src/Database/Bloodhound/Client.hs+11
src/Database/Bloodhound/Client.hs+11
@@ -23,6 +23,7 @@ module Database.Bloodhound.Client
2323
2424 -- $setup
2525 withBH
26+ -- ** Indices
2627 , createIndex
2728 , deleteIndex
2829 , updateIndexSettings
@@ -32,18 +33,23 @@ module Database.Bloodhound.Client
3233 , openIndex
3334 , closeIndex
3435 , listIndices
36+ -- *** Index Aliases
3537 , updateIndexAliases
3638 , getIndexAliases
39+ -- *** Index Templates
3740 , putTemplate
3841 , templateExists
3942 , deleteTemplate
43+ -- ** Mapping
4044 , putMapping
4145 , deleteMapping
46+ -- ** Documents
4247 , indexDocument
4348 , updateDocument
4449 , getDocument
4550 , documentExists
4651 , deleteDocument
52+ -- ** Searching
4753 , searchAll
4854 , searchByIndex
4955 , searchByType
@@ -59,14 +65,19 @@ module Database.Bloodhound.Client
5965 , mkShardCount
6066 , mkReplicaCount
6167 , getStatus
68+ -- ** Snapshot/Restore
69+ -- *** Snapshot Repos
6270 , getSnapshotRepos
6371 , updateSnapshotRepo
6472 , verifySnapshotRepo
6573 , deleteSnapshotRepo
74+ -- *** Snapshots
6675 , createSnapshot
6776 , getSnapshots
6877 , deleteSnapshot
78+ -- *** Restoring Snapshots
6979 , restoreSnapshot
80+ -- ** Request Utilities
7081 , encodeBulkOperations
7182 , encodeBulkOperation
7283 -- * Authentication