Skip to content

Commit 2a539f7

Browse files
authored
now targets typesense 0.24.1 (#43)
1 parent 468e05d commit 2a539f7

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

.circleci/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ executors:
1313
auth:
1414
username: $DOCKER_LOGIN
1515
password: $DOCKER_ACCESSTOKEN
16-
- image: typesense/typesense:0.24.0 # For integration testing
16+
- image: typesense/typesense:0.24.1 # For integration testing
1717
auth:
1818
username: $DOCKER_LOGIN
1919
password: $DOCKER_ACCESSTOKEN

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Clojars Project](https://img.shields.io/clojars/v/io.github.runeanielsen/typesense-clj.svg)](https://clojars.org/io.github.runeanielsen/typesense-clj)
44

5-
Clojure client for [Typesense 0.24.0](https://github.com/typesense/typesense)
5+
Clojure client for [Typesense 0.24.1](https://github.com/typesense/typesense)
66

77
All of the examples uses the `typesense.client` namespace. The examples shows the simplest way to get started using the client, but all parameters described on Typesense API documentation should work, if that is not the case, please make a pull-request or open an issue.
88

@@ -22,11 +22,11 @@ Example of settings.
2222

2323
## Collection
2424

25-
This section describes how to use the collection, further information can be found [here.](https://typesense.org/docs/0.24.0/api/collections.html#create-a-collection)
25+
This section describes how to use the collection, further information can be found [here.](https://typesense.org/docs/0.24.1/api/collections.html#create-a-collection)
2626

2727
### Create collection
2828

29-
The different `types` for the schema can be found [here](https://typesense.org/docs/0.24.0/api/collections.html#create-a-collection).
29+
The different `types` for the schema can be found [here](https://typesense.org/docs/0.24.1/api/collections.html#create-a-collection).
3030

3131
The examples displays the creation of collection named `companies`.
3232

@@ -78,7 +78,7 @@ The examples displays the creation of collection named `companies`.
7878

7979
### Update collection
8080

81-
The different `types` for the schema can be found [here](https://typesense.org/docs/0.24.0/api/collections.html#update-or-alter-a-collection).
81+
The different `types` for the schema can be found [here](https://typesense.org/docs/0.24.1/api/collections.html#update-or-alter-a-collection).
8282

8383
The examples shows updating the collection named named `companies` with a new field `year_founded`.
8484

@@ -222,7 +222,7 @@ Retrieves the collection on the `collection-name`.
222222

223223
## Documents
224224

225-
This section describes how to use the documents, further information can be found [here.](https://typesense.org/docs/0.24.0/api/documents.html)
225+
This section describes how to use the documents, further information can be found [here.](https://typesense.org/docs/0.24.1/api/documents.html)
226226

227227
### Create document
228228

@@ -300,7 +300,7 @@ Update document in a collection on id. The update can be partial.
300300

301301
## Create/Upsert/Update/Delete Documents
302302

303-
Create/upsert/update documents. All of them takes optional parameters, an example is setting the batch size using `:batch_size 20`. Read more [here.](https://typesense.org/docs/0.24.0/api/documents.html#import-documents)
303+
Create/upsert/update documents. All of them takes optional parameters, an example is setting the batch size using `:batch_size 20`. Read more [here.](https://typesense.org/docs/0.24.1/api/documents.html#import-documents)
304304

305305
### Create documents
306306

@@ -379,7 +379,7 @@ Export documents in collection.
379379

380380
## Search
381381

382-
Search for documents in a collection. You can find all the query arguments [here.](https://typesense.org/docs/0.24.0/api/documents.html#arguments)
382+
Search for documents in a collection. You can find all the query arguments [here.](https://typesense.org/docs/0.24.1/api/documents.html#arguments)
383383

384384
```clojure
385385
(search settings "companies" {:q "Innovation"
@@ -421,7 +421,7 @@ Search for documents in a collection. You can find all the query arguments [here
421421

422422
## Multi search
423423

424-
You can send multiple search requests in a single HTTP request, using the Multi-Search feature. This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can read more about multi-search [here.](https://typesense.org/docs/0.24.0/api/documents.html#federated-multi-search)
424+
You can send multiple search requests in a single HTTP request, using the Multi-Search feature. This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can read more about multi-search [here.](https://typesense.org/docs/0.24.1/api/documents.html#federated-multi-search)
425425

426426
```clojure
427427
(multi-search
@@ -530,7 +530,7 @@ You can send multiple search requests in a single HTTP request, using the Multi-
530530

531531
## Api keys
532532

533-
Typesense allows you to create API Keys with fine-grain access control. You can restrict access on both a per-collection and per-action level, [read more here](https://typesense.org/docs/0.24.0/api/api-keys.html#create-an-api-key)
533+
Typesense allows you to create API Keys with fine-grain access control. You can restrict access on both a per-collection and per-action level, [read more here](https://typesense.org/docs/0.24.1/api/api-keys.html#create-an-api-key)
534534

535535
### Create api key
536536

@@ -593,7 +593,7 @@ Deletes api key on `id`.
593593

594594
## Curation
595595

596-
Using overrides, you can include or exclude specific documents for a given query, read more [here.](https://typesense.org/docs/0.24.0/api/curation.html)
596+
Using overrides, you can include or exclude specific documents for a given query, read more [here.](https://typesense.org/docs/0.24.1/api/curation.html)
597597

598598
### Create or update an override
599599

@@ -664,7 +664,7 @@ Deletes override on name.
664664

665665
## Collection alias
666666

667-
An alias is a virtual collection name that points to a real collection. Read more [here](https://typesense.org/docs/0.24.0/api/collection-alias.html)
667+
An alias is a virtual collection name that points to a real collection. Read more [here](https://typesense.org/docs/0.24.1/api/collection-alias.html)
668668

669669
### Create or update alias
670670

@@ -712,7 +712,7 @@ Delete alias on collection name.
712712

713713
## Synonyms
714714

715-
The synonyms feature allows you to define search terms that should be considered equivalent, read more [here.](https://typesense.org/docs/0.24.0/api/synonyms.html)
715+
The synonyms feature allows you to define search terms that should be considered equivalent, read more [here.](https://typesense.org/docs/0.24.1/api/synonyms.html)
716716

717717
### Create or update synonym
718718

@@ -762,7 +762,7 @@ Delete synonym on synonym-name in collection.
762762

763763
### Typesense API Errors
764764

765-
Typesense API exceptions in the [Typesense-api-errors](https://typesense.org/docs/0.24.0/api/api-errors.html) spec.
765+
Typesense API exceptions in the [Typesense-api-errors](https://typesense.org/docs/0.24.1/api/api-errors.html) spec.
766766

767767
| Type | Description |
768768
|:------------------------------------------|:---------------------------------------------------------------------------|
@@ -792,7 +792,7 @@ bin/kaocha unit
792792
To run the integration tests you can run a local docker instance with the following command. This will start a instance of Typesense on `localhost:8108`. The Typesense instance will be cleaned before starting the integration tests.
793793

794794
```sh
795-
docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.24.0 --data-dir /data --api-key=key
795+
docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.24.1 --data-dir /data --api-key=key
796796
```
797797

798798
The following command runs only the integration tests.

0 commit comments

Comments
 (0)