From 01d20d682bfc33348739ee9c00a8c663cf213ec3 Mon Sep 17 00:00:00 2001 From: Berthier Date: Wed, 29 May 2019 13:40:32 +0200 Subject: [PATCH] fix arguments list --- .../index/refresh-internal/index.md | 23 ++++++++--------- .../index/refresh-internal/index.md | 25 +++++++++---------- .../index/refresh-internal/index.md | 7 +++--- 3 files changed, 26 insertions(+), 29 deletions(-) diff --git a/src/sdk/go/1/controllers/index/refresh-internal/index.md b/src/sdk/go/1/controllers/index/refresh-internal/index.md index fd4cce7df..7a9183d44 100644 --- a/src/sdk/go/1/controllers/index/refresh-internal/index.md +++ b/src/sdk/go/1/controllers/index/refresh-internal/index.md @@ -18,26 +18,25 @@ From [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch "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." ::: -## Signature +## Arguments ```go -RefreshInternal(index string, options types.QueryOptions) error +RefreshInternal(options types.QueryOptions) error ``` -## Arguments +
-| Arguments | Type | Description | Required | -| --------- | ------------ | ------------- | -------- | -| `index` | string | Index name | yes | -| `options` | QueryOptions | Query options | no | +| Arguments | Type | Description | +| --------- | ------------ | ------------- | +| `options` |
QueryOptions
| Query options | -### **Options** +### Options -Additional query options +The `options` arguments can contain the following option properties: -| Option | Type | Description | Default | -| ---------- | ---- | --------------------------------- | ------- | -| `queuable` | bool | Make this request queuable or not | `true` | +| Option | Type (default) | Description | +| ---------- | -------------- | --------------------------------- | +| `queuable` |
bool (true)
| If true, queues the request during downtime, until connected to Kuzzle again | ## Return diff --git a/src/sdk/java/1/controllers/index/refresh-internal/index.md b/src/sdk/java/1/controllers/index/refresh-internal/index.md index 0f67c1ce3..572d5d495 100644 --- a/src/sdk/java/1/controllers/index/refresh-internal/index.md +++ b/src/sdk/java/1/controllers/index/refresh-internal/index.md @@ -19,27 +19,26 @@ From [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch -## Signature +## Arguments ```java -void refreshInternal() throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException; -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; +void refreshInternal() throws io.kuzzle.sdk.KuzzleException; +void refreshInternal(io.kuzzle.sdk.QueryOptions options) throws io.kuzzle.sdk.KuzzleException; ``` -## Arguments +
-| Arguments | Type | Description | Required | -| --------- | -------------------------- | ----------------- | -------- | -| `index` | String | Index name | yes | -| `options` | io.kuzzle.sdk.QueryOptions | The query options | no | +| Arguments | Type | Description | +| --------- | ------------ | ----------------- | +| `options` |
io.kuzzle.sdk.QueryOptions
| Query options | -### **Options** +### Options -Additional query options +The `options` arguments can contain the following option properties: -| Option | Type | Description | Default | -| ---------- | ------- | --------------------------------- | ------- | -| `queuable` | boolean | Make this request queuable or not | `true` | +| Property | Type (default) | Description | +| ---------- | ------- | --------------------------------- | +| `queuable` |
boolean (true)
| If true, queues the request during downtime, until connected to Kuzzle again | ## Exceptions diff --git a/src/sdk/js/6/controllers/index/refresh-internal/index.md b/src/sdk/js/6/controllers/index/refresh-internal/index.md index f8ec74000..2ed97799f 100644 --- a/src/sdk/js/6/controllers/index/refresh-internal/index.md +++ b/src/sdk/js/6/controllers/index/refresh-internal/index.md @@ -19,22 +19,21 @@ From [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch -
+## Arguments ```javascript -refreshInternal(index, [options]); +refreshInternal([options]); ```
| Arguments | Type | Description | | --------- | ----------------- | ------------- | -| `index` |
string
| Index name | | `options` |
object
| Query options | ### options -Additional query options +The `options` arguments can contain the following option properties: | Property | Type
(default) | Description | | ---------- | ------------------------------- | ---------------------------------------------------------------------------- |