Skip to content

Commit 806f5bd

Browse files
committed
Updated docs and Readme
1 parent 9470c6f commit 806f5bd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+73
-104
lines changed

README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,11 @@ Manticore Search Client
55

66
- API version: 3.3.0
77

8-
- Build date: 2023-04-21T13:25:16.289613Z[Etc/UTC]
8+
- Build date: 2023-04-21T16:12:17.895346Z[Etc/UTC]
99

1010
Сlient for Manticore Search.
1111

1212

13-
For more information, please visit [https://manticoresearch.com/contact-us/](https://manticoresearch.com/contact-us/)
14-
15-
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
16-
1713
## Requirements
1814

1915
Building the API client library requires:
@@ -224,8 +220,3 @@ Authentication schemes defined for the API:
224220
## Recommendation
225221

226222
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
227-
228-
## Author
229-
230-
231-

docs/SearchApi.md

Lines changed: 14 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -19,51 +19,18 @@ The method expects an object with the following mandatory properties:
1919

2020
* the match query object
2121

22-
Here is an example search request:
23-
```
24-
{
25-
'index':'movies',
26-
'query':
27-
{
28-
'bool':
29-
{
30-
'must':
31-
[
32-
{'query_string':' movie'}
33-
]
34-
}
35-
},
36-
'script_fields':
37-
{
38-
'myexpr':
39-
{
40-
'script':
41-
{
42-
'inline':'IF(rating>8,1,0)'
43-
}
44-
}
45-
},
46-
'sort':
47-
[
48-
{'myexpr':'desc'},
49-
{'_score':'desc'}
50-
],
51-
'profile':true
52-
}
53-
```
54-
5522
For details, see the documentation on [**SearchRequest**](SearchRequest.md)
5623

5724
The method returns an object with the following properties:
5825

59-
- took: the time taken to execute the search query.
60-
- timed_out: a boolean indicating whether the query timed out.
6126
- hits: an object with the following properties:
62-
- total: the total number of hits found.
6327
- hits: an array of hit objects, where each hit object represents a matched document. Each hit object has the following properties:
6428
- _id: the ID of the matched document.
6529
- _score: the score of the matched document.
6630
- _source: the source data of the matched document.
31+
- total: the total number of hits found.
32+
- timed_out: a boolean indicating whether the query timed out.
33+
- took: the time taken to execute the search query.
6734

6835
In addition, if profiling is enabled, the response will include an additional array with profiling information attached.
6936

@@ -174,7 +141,17 @@ Expects two parameters: the index name and an object with an array of documents
174141
An example of the documents object:
175142

176143
```
177-
{"query":{"percolate":{"document":{"content":"sample content"}}}}
144+
{"query":
145+
{
146+
"percolate":
147+
{
148+
"document":
149+
{
150+
"content":"sample content"
151+
}
152+
}
153+
}
154+
}
178155
```
179156

180157
Responds with an object with matched stored queries:

docs/SearchRequest.md

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

33
# SearchRequest
44

5-
Payload for search operation
5+
Request object for search operation
66

77
## Properties
88

@@ -381,3 +381,4 @@ System.out.println( searchResponse.toString() );
381381

382382

383383

384+

src/main/java/com/manticoresearch/client/ApiClient.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
/**
7575
* <p>ApiClient class.</p>
7676
*/
77-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T13:25:16.289613Z[Etc/UTC]")
77+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T16:12:17.895346Z[Etc/UTC]")
7878
public class ApiClient extends JavaTimeFormatter {
7979
private static final Pattern JSON_MIME_PATTERN = Pattern.compile("(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$");
8080

src/main/java/com/manticoresearch/client/ApiException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
/**
2020
* API Exception
2121
*/
22-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T13:25:16.289613Z[Etc/UTC]")
22+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T16:12:17.895346Z[Etc/UTC]")
2323
public class ApiException extends Exception {
2424
private int code = 0;
2525
private Map<String, List<String>> responseHeaders = null;

src/main/java/com/manticoresearch/client/Configuration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
package com.manticoresearch.client;
1515

16-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T13:25:16.289613Z[Etc/UTC]")
16+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T16:12:17.895346Z[Etc/UTC]")
1717
public class Configuration {
1818
private static ApiClient defaultApiClient = new ApiClient();
1919

src/main/java/com/manticoresearch/client/JSON.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
import javax.ws.rs.core.GenericType;
1616
import javax.ws.rs.ext.ContextResolver;
1717

18-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T13:25:16.289613Z[Etc/UTC]")
18+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T16:12:17.895346Z[Etc/UTC]")
1919
public class JSON implements ContextResolver<ObjectMapper> {
2020
private ObjectMapper mapper;
2121

src/main/java/com/manticoresearch/client/JavaTimeFormatter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* Class that add parsing/formatting support for Java 8+ {@code OffsetDateTime} class.
2121
* It's generated for java clients when {@code AbstractJavaCodegen#dateLibrary} specified as {@code java8}.
2222
*/
23-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T13:25:16.289613Z[Etc/UTC]")
23+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T16:12:17.895346Z[Etc/UTC]")
2424
public class JavaTimeFormatter {
2525

2626
private DateTimeFormatter offsetDateTimeFormatter = DateTimeFormatter.ISO_OFFSET_DATE_TIME;

src/main/java/com/manticoresearch/client/Pair.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
package com.manticoresearch.client;
1515

16-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T13:25:16.289613Z[Etc/UTC]")
16+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T16:12:17.895346Z[Etc/UTC]")
1717
public class Pair {
1818
private String name = "";
1919
private String value = "";

src/main/java/com/manticoresearch/client/StringUtil.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import java.util.Collection;
1717
import java.util.Iterator;
1818

19-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T13:25:16.289613Z[Etc/UTC]")
19+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-04-21T16:12:17.895346Z[Etc/UTC]")
2020
public class StringUtil {
2121
/**
2222
* Check if the given array contains the given value (with case-insensitive comparison).

0 commit comments

Comments
 (0)