Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lalinsky authored Dec 6, 2024
1 parent 53e6a8b commit d00987f
Showing 1 changed file with 28 additions and 10 deletions.
38 changes: 28 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,38 +24,42 @@ Running server:

## HTTP API

### Check if index exists
### Index management

#### Check if index exists

Returns HTTP status 200 if the index exists.

```
HEAD /:indexname
```

### Get index info
#### Get index info

Returns information about an index.

```
GET /:indexname
```
### Create index
#### Create index

Creates a new index.

```
PUT /:indexname
```

### Delete index
#### Delete index

Deletes an index.

```
DELETE /:indexname
```

### Update
### Fingerprint management

#### Update

Performs multiple operations on an index.

Expand All @@ -72,7 +76,7 @@ POST /:indexname/_update
}
```

### Search
#### Search

Searches for a fingerprint in the index.

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

### Check if fingerprint exists
#### Check if fingerprint exists

Returns HTTP status 200 if the fingerprint exists.

```
HEAD /:indexname/:fpid
```

### Get fingerprint info
#### Get fingerprint info

Gets information about a fingeprint.

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

### Update fingerprint
#### Update single fingerprint

Updates a single fingerprint.

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

### Delete fingerprint
#### Delete single fingerprint

Deletes a single fingerprint.

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

### System utilities

#### Healhcheck

```
GET /_health
GET /:indexname/_health
```

#### Prometheus metrics

```
GET /_metrics
```

0 comments on commit d00987f

Please sign in to comment.