From 44245b0bcf415226238e00ee301879f4199c35c2 Mon Sep 17 00:00:00 2001 From: scottinet Date: Wed, 17 Apr 2019 11:31:47 +0200 Subject: [PATCH] [SDK] fix index:refreshInternal arguments list --- .../go/1/index/refresh-internal/index.md | 23 ++++++++--------- .../java/1/index/refresh-internal/index.md | 25 +++++++++---------- .../js/6/index/refresh-internal/index.md | 7 +++--- 3 files changed, 26 insertions(+), 29 deletions(-) diff --git a/src/sdk-reference/go/1/index/refresh-internal/index.md b/src/sdk-reference/go/1/index/refresh-internal/index.md index ffab64145..bd94c40f9 100644 --- a/src/sdk-reference/go/1/index/refresh-internal/index.md +++ b/src/sdk-reference/go/1/index/refresh-internal/index.md @@ -17,26 +17,25 @@ The `refreshInternal` action forces a [refresh]({{ ../site_base_path }}/sdk-refe "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-reference/java/1/index/refresh-internal/index.md b/src/sdk-reference/java/1/index/refresh-internal/index.md index c6028c29a..3d7be5f0f 100644 --- a/src/sdk-reference/java/1/index/refresh-internal/index.md +++ b/src/sdk-reference/java/1/index/refresh-internal/index.md @@ -17,27 +17,26 @@ The `refreshInternal` action forces a [refresh]({{ ../site_base_path }}/sdk-refe "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 ```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-reference/js/6/index/refresh-internal/index.md b/src/sdk-reference/js/6/index/refresh-internal/index.md index cdcc92117..8d4306b84 100644 --- a/src/sdk-reference/js/6/index/refresh-internal/index.md +++ b/src/sdk-reference/js/6/index/refresh-internal/index.md @@ -17,22 +17,21 @@ The `refreshInternal` action forces a [refresh]({{ ../site_base_path }}/sdk-refe "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." -
+## 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 | | -------------- | --------- | ------------- |