Skip to content

Commit f613c71

Browse files
berthierestebanAschen
authored andcommitted
fix arguments list (#307)
1 parent 1a56747 commit f613c71

File tree

3 files changed

+26
-29
lines changed
  • src/sdk
    • go/1/controllers/index/refresh-internal
    • java/1/controllers/index/refresh-internal
    • js/6/controllers/index/refresh-internal

3 files changed

+26
-29
lines changed

src/sdk/go/1/controllers/index/refresh-internal/index.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,25 @@ From [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch
1818
"While a refresh is much lighter than a commit, it still has a performance cost. A manual refresh can be useful when writing tests, but don’t do a manual refresh every time you index a document in production; it will hurt your performance. Instead, your application needs to be aware of the near real-time nature of Elasticsearch and make allowances for it."
1919
:::
2020

21-
## Signature
21+
## Arguments
2222

2323
```go
24-
RefreshInternal(index string, options types.QueryOptions) error
24+
RefreshInternal(options types.QueryOptions) error
2525
```
2626

27-
## Arguments
27+
<br/>
2828

29-
| Arguments | Type | Description | Required |
30-
| --------- | ------------ | ------------- | -------- |
31-
| `index` | string | Index name | yes |
32-
| `options` | QueryOptions | Query options | no |
29+
| Arguments | Type | Description |
30+
| --------- | ------------ | ------------- |
31+
| `options` | <pre>QueryOptions</pre> | Query options |
3332

34-
### **Options**
33+
### Options
3534

36-
Additional query options
35+
The `options` arguments can contain the following option properties:
3736

38-
| Option | Type | Description | Default |
39-
| ---------- | ---- | --------------------------------- | ------- |
40-
| `queuable` | bool | Make this request queuable or not | `true` |
37+
| Option | Type (default) | Description |
38+
| ---------- | -------------- | --------------------------------- |
39+
| `queuable` | <pre>bool (true)</pre> | If true, queues the request during downtime, until connected to Kuzzle again |
4140

4241
## Return
4342

src/sdk/java/1/controllers/index/refresh-internal/index.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,27 +19,26 @@ From [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch
1919

2020
</div>
2121

22-
## Signature
22+
## Arguments
2323

2424
```java
25-
void refreshInternal() throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException;
26-
void refreshInternal(io.kuzzle.sdk.QueryOptions options) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException;
25+
void refreshInternal() throws io.kuzzle.sdk.KuzzleException;
26+
void refreshInternal(io.kuzzle.sdk.QueryOptions options) throws io.kuzzle.sdk.KuzzleException;
2727
```
2828

29-
## Arguments
29+
<br/>
3030

31-
| Arguments | Type | Description | Required |
32-
| --------- | -------------------------- | ----------------- | -------- |
33-
| `index` | String | Index name | yes |
34-
| `options` | io.kuzzle.sdk.QueryOptions | The query options | no |
31+
| Arguments | Type | Description |
32+
| --------- | ------------ | ----------------- |
33+
| `options` | <pre>io.kuzzle.sdk.QueryOptions</pre> | Query options |
3534

36-
### **Options**
35+
### Options
3736

38-
Additional query options
37+
The `options` arguments can contain the following option properties:
3938

40-
| Option | Type | Description | Default |
41-
| ---------- | ------- | --------------------------------- | ------- |
42-
| `queuable` | boolean | Make this request queuable or not | `true` |
39+
| Property | Type (default) | Description |
40+
| ---------- | ------- | --------------------------------- |
41+
| `queuable` | <pre>boolean (true)</pre> | If true, queues the request during downtime, until connected to Kuzzle again |
4342

4443
## Exceptions
4544

src/sdk/js/6/controllers/index/refresh-internal/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,21 @@ From [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch
1919

2020
</div>
2121

22-
<br/>
22+
## Arguments
2323

2424
```javascript
25-
refreshInternal(index, [options]);
25+
refreshInternal([options]);
2626
```
2727

2828
<br/>
2929

3030
| Arguments | Type | Description |
3131
| --------- | ----------------- | ------------- |
32-
| `index` | <pre>string</pre> | Index name |
3332
| `options` | <pre>object</pre> | Query options |
3433

3534
### options
3635

37-
Additional query options
36+
The `options` arguments can contain the following option properties:
3837

3938
| Property | Type<br/>(default) | Description |
4039
| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |

0 commit comments

Comments
 (0)