Skip to content

Commit ed61b90

Browse files
committed
Update README
1 parent 97497be commit ed61b90

File tree

1 file changed

+46
-2
lines changed

1 file changed

+46
-2
lines changed

README.md

+46-2
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,21 @@ Running server:
2424

2525
## HTTP API
2626

27-
### Get index
27+
### Check if index exists
28+
29+
Returns HTTP status 200 if the index exists.
30+
31+
```
32+
HEAD /:indexname
33+
```
34+
35+
### Get index info
2836

2937
Returns information about an index.
3038

3139
```
3240
GET /:indexname
3341
```
34-
3542
### Create index
3643

3744
Creates a new index.
@@ -76,3 +83,40 @@ POST /:indexname/_search
7683
```json
7784
{"query": [100, 200, 300], "timeout": 10}
7885
```
86+
87+
### Check if fingerprint exists
88+
89+
Returns HTTP status 200 if the fingerprint exists.
90+
91+
```
92+
HEAD /:indexname/:fpid
93+
```
94+
95+
### Get fingerprint info
96+
97+
```
98+
GET /:indexname/:fpid
99+
```
100+
101+
### Update fingerprint
102+
103+
```
104+
PUT /:indexname/:fpid
105+
```
106+
107+
```json
108+
{"hashes": [100, 200, 300]}
109+
```
110+
111+
Prefer using `/_update` for bulk operations.
112+
113+
### Delete fingerprint
114+
115+
Deletes a single fingerprint.
116+
117+
```
118+
DELETE /:indexname/:fpid
119+
```
120+
121+
Prefer using `/_update` for bulk operations.
122+

0 commit comments

Comments
 (0)