Skip to content

Commit d00987f

Browse files
authored
Update README.md
1 parent 53e6a8b commit d00987f

File tree

1 file changed

+28
-10
lines changed

1 file changed

+28
-10
lines changed

README.md

+28-10
Original file line numberDiff line numberDiff line change
@@ -24,38 +24,42 @@ Running server:
2424

2525
## HTTP API
2626

27-
### Check if index exists
27+
### Index management
28+
29+
#### Check if index exists
2830

2931
Returns HTTP status 200 if the index exists.
3032

3133
```
3234
HEAD /:indexname
3335
```
3436

35-
### Get index info
37+
#### Get index info
3638

3739
Returns information about an index.
3840

3941
```
4042
GET /:indexname
4143
```
42-
### Create index
44+
#### Create index
4345

4446
Creates a new index.
4547

4648
```
4749
PUT /:indexname
4850
```
4951

50-
### Delete index
52+
#### Delete index
5153

5254
Deletes an index.
5355

5456
```
5557
DELETE /:indexname
5658
```
5759

58-
### Update
60+
### Fingerprint management
61+
62+
#### Update
5963

6064
Performs multiple operations on an index.
6165

@@ -72,7 +76,7 @@ POST /:indexname/_update
7276
}
7377
```
7478

75-
### Search
79+
#### Search
7680

7781
Searches for a fingerprint in the index.
7882

@@ -84,15 +88,15 @@ POST /:indexname/_search
8488
{"query": [100, 200, 300], "timeout": 10}
8589
```
8690

87-
### Check if fingerprint exists
91+
#### Check if fingerprint exists
8892

8993
Returns HTTP status 200 if the fingerprint exists.
9094

9195
```
9296
HEAD /:indexname/:fpid
9397
```
9498

95-
### Get fingerprint info
99+
#### Get fingerprint info
96100

97101
Gets information about a fingeprint.
98102

@@ -102,7 +106,7 @@ There is no way to get back the original hashes, they are not stored in a way th
102106
GET /:indexname/:fpid
103107
```
104108

105-
### Update fingerprint
109+
#### Update single fingerprint
106110

107111
Updates a single fingerprint.
108112

@@ -116,7 +120,7 @@ PUT /:indexname/:fpid
116120
{"hashes": [100, 200, 300]}
117121
```
118122

119-
### Delete fingerprint
123+
#### Delete single fingerprint
120124

121125
Deletes a single fingerprint.
122126

@@ -126,3 +130,17 @@ Prefer using `/_update` for bulk operations.
126130
DELETE /:indexname/:fpid
127131
```
128132

133+
### System utilities
134+
135+
#### Healhcheck
136+
137+
```
138+
GET /_health
139+
GET /:indexname/_health
140+
```
141+
142+
#### Prometheus metrics
143+
144+
```
145+
GET /_metrics
146+
```

0 commit comments

Comments
 (0)