From d7359c5d50ed6eafdd10a5d6962fce12ce7375b4 Mon Sep 17 00:00:00 2001 From: jenow Date: Mon, 17 Feb 2020 15:33:09 +0100 Subject: [PATCH 1/2] Add Index controller --- .travis.yml | 8 ++ doc/3/controllers/index/create/index.md | 25 +++++ .../index/create/snippets/create.java | 1 + .../index/create/snippets/create.test.yml | 8 ++ doc/3/controllers/index/delete/index.md | 25 +++++ .../index/delete/snippets/delete.java | 1 + .../index/delete/snippets/delete.test.yml | 8 ++ doc/3/controllers/index/exists/index.md | 29 ++++++ .../index/exists/snippets/exists.java | 1 + .../index/exists/snippets/exists.test.yml | 8 ++ doc/3/controllers/index/index.md | 8 ++ doc/3/controllers/index/list/index.md | 25 +++++ .../controllers/index/list/snippets/list.java | 1 + .../index/list/snippets/list.test.yml | 10 ++ doc/3/controllers/index/m-delete/index.md | 29 ++++++ .../index/m-delete/snippets/mDelete.java | 3 + .../index/m-delete/snippets/mDelete.test.yml | 8 ++ .../sdk/API/Controllers/IndexController.java | 98 +++++++++++++++++++ .../sdk/Exceptions/KuzzleExceptionCode.java | 2 +- src/main/java/io/kuzzle/sdk/Kuzzle.java | 13 ++- .../API/Controllers/IndexControllerTest.java | 98 +++++++++++++++++++ 21 files changed, 407 insertions(+), 2 deletions(-) create mode 100644 doc/3/controllers/index/create/index.md create mode 100644 doc/3/controllers/index/create/snippets/create.java create mode 100644 doc/3/controllers/index/create/snippets/create.test.yml create mode 100644 doc/3/controllers/index/delete/index.md create mode 100644 doc/3/controllers/index/delete/snippets/delete.java create mode 100644 doc/3/controllers/index/delete/snippets/delete.test.yml create mode 100644 doc/3/controllers/index/exists/index.md create mode 100644 doc/3/controllers/index/exists/snippets/exists.java create mode 100644 doc/3/controllers/index/exists/snippets/exists.test.yml create mode 100644 doc/3/controllers/index/index.md create mode 100644 doc/3/controllers/index/list/index.md create mode 100644 doc/3/controllers/index/list/snippets/list.java create mode 100644 doc/3/controllers/index/list/snippets/list.test.yml create mode 100644 doc/3/controllers/index/m-delete/index.md create mode 100644 doc/3/controllers/index/m-delete/snippets/mDelete.java create mode 100644 doc/3/controllers/index/m-delete/snippets/mDelete.test.yml create mode 100644 src/main/java/io/kuzzle/sdk/API/Controllers/IndexController.java create mode 100644 src/test/java/io/kuzzle/test/API/Controllers/IndexControllerTest.java diff --git a/.travis.yml b/.travis.yml index 1dd7a360..3baa35ce 100644 --- a/.travis.yml +++ b/.travis.yml @@ -23,6 +23,14 @@ jobs: - gem install typhoeus - HYDRA_MAX_CONCURRENCY=20 npm run --prefix $TRAVIS_BUILD_DIR/doc/framework dead-links + - stage: Tests + name: Documentation Snippets + if: type = pull_request OR type = push AND branch =~ /^master|[0-9]+-dev$/ OR type = cron + language: node_js + node_js: 10 + script: + - docker-compose -f .ci/doc/docker-compose.yml run doc-tests index + - stage: Deployment Doc Dev name: Deploy next-docs.kuzzle.io if: type = push AND branch =~ /^[0-9]+-dev$/ diff --git a/doc/3/controllers/index/create/index.md b/doc/3/controllers/index/create/index.md new file mode 100644 index 00000000..9cb1b347 --- /dev/null +++ b/doc/3/controllers/index/create/index.md @@ -0,0 +1,25 @@ +--- +code: true +type: page +title: Create +description: Creates an index. +--- + +# Create + +Creates a new index in Kuzzle + +## Arguments + +```java +CompletableFuture create(final String index) + throws NotConnectedException, InternalException +``` + +| Argument | Type | Description | +|----------|-------------------|-------------| +| `index` | 
String
| Index name | + +## Usage + +<<< ./snippets/create.java diff --git a/doc/3/controllers/index/create/snippets/create.java b/doc/3/controllers/index/create/snippets/create.java new file mode 100644 index 00000000..5fa80ccf --- /dev/null +++ b/doc/3/controllers/index/create/snippets/create.java @@ -0,0 +1 @@ +kuzzle.getIndexController().create("nyc-open-data").get(); diff --git a/doc/3/controllers/index/create/snippets/create.test.yml b/doc/3/controllers/index/create/snippets/create.test.yml new file mode 100644 index 00000000..dd0311dc --- /dev/null +++ b/doc/3/controllers/index/create/snippets/create.test.yml @@ -0,0 +1,8 @@ +--- +name: Index#CreateAsync +description: Creates a new index. +hooks: + before: curl -X DELETE kuzzle:7512/nyc-open-data + after: +template: default +expected: Success \ No newline at end of file diff --git a/doc/3/controllers/index/delete/index.md b/doc/3/controllers/index/delete/index.md new file mode 100644 index 00000000..8541d655 --- /dev/null +++ b/doc/3/controllers/index/delete/index.md @@ -0,0 +1,25 @@ +--- +code: true +type: page +title: Delete +description: Deletes an index. +--- + +# Delete + +Deletes an entire index from Kuzzle. + +## Arguments + +```java +CompletableFuture delete(final String index) + throws NotConnectedException, InternalException +``` + +| Argument | Type | Description | +|----------|-------------------|-------------| +| `index` | 
String
| Index name | + +## Usage + +<<< ./snippets/delete.java diff --git a/doc/3/controllers/index/delete/snippets/delete.java b/doc/3/controllers/index/delete/snippets/delete.java new file mode 100644 index 00000000..b126d403 --- /dev/null +++ b/doc/3/controllers/index/delete/snippets/delete.java @@ -0,0 +1 @@ +kuzzle.getIndexController().delete("nyc-open-data").get(); diff --git a/doc/3/controllers/index/delete/snippets/delete.test.yml b/doc/3/controllers/index/delete/snippets/delete.test.yml new file mode 100644 index 00000000..5f055e24 --- /dev/null +++ b/doc/3/controllers/index/delete/snippets/delete.test.yml @@ -0,0 +1,8 @@ +--- +name: Index#Delete +description: Delete an index. +hooks: + before: curl -X POST kuzzle:7512/nyc-open-data/_create + after: +template: default +expected: Success \ No newline at end of file diff --git a/doc/3/controllers/index/exists/index.md b/doc/3/controllers/index/exists/index.md new file mode 100644 index 00000000..871d778b --- /dev/null +++ b/doc/3/controllers/index/exists/index.md @@ -0,0 +1,29 @@ +--- +code: true +type: page +title: Exists +description: Check for index existence. +--- + +# Exists + +Checks if the given index exists in Kuzzle. + +## Arguments + +```java +CompletableFuture exists(final String index) + throws NotConnectedException, InternalException +``` + +| Argument | Type | Description | +|----------|-------------------|-------------| +| `index` | 
String
| Index name | + +## Return + +Returns a `boolean` that indicates whether the index exists or not. + +## Usage + +<<< ./snippets/exists.java diff --git a/doc/3/controllers/index/exists/snippets/exists.java b/doc/3/controllers/index/exists/snippets/exists.java new file mode 100644 index 00000000..557cb953 --- /dev/null +++ b/doc/3/controllers/index/exists/snippets/exists.java @@ -0,0 +1 @@ +Boolean result = kuzzle.getIndexController().exists("nyc-open-data").get(); diff --git a/doc/3/controllers/index/exists/snippets/exists.test.yml b/doc/3/controllers/index/exists/snippets/exists.test.yml new file mode 100644 index 00000000..d32f6f3a --- /dev/null +++ b/doc/3/controllers/index/exists/snippets/exists.test.yml @@ -0,0 +1,8 @@ +--- +name: Index#ExistsAsync +description: Test if an index exists. +hooks: + before: curl -X POST kuzzle:7512/nyc-open-data/_create + after: +template: print-result +expected: true \ No newline at end of file diff --git a/doc/3/controllers/index/index.md b/doc/3/controllers/index/index.md new file mode 100644 index 00000000..8d74e9c0 --- /dev/null +++ b/doc/3/controllers/index/index.md @@ -0,0 +1,8 @@ +--- +code: true +type: branch +title: Index +description: Index Controller +--- + +# Index Controller diff --git a/doc/3/controllers/index/list/index.md b/doc/3/controllers/index/list/index.md new file mode 100644 index 00000000..c99054f8 --- /dev/null +++ b/doc/3/controllers/index/list/index.md @@ -0,0 +1,25 @@ +--- +code: true +type: page +title: List +description: List the indexes. +--- + +# List + +Gets the complete list of indexes handled by Kuzzle. + +## Arguments + +```java +CompletableFuture> list() + throws NotConnectedException, InternalException +``` + +## Return + +Returns an `ArrayList` containing the list of index names handled by Kuzzle. + +## Usage + +<<< ./snippets/list.java diff --git a/doc/3/controllers/index/list/snippets/list.java b/doc/3/controllers/index/list/snippets/list.java new file mode 100644 index 00000000..eb4c1cc4 --- /dev/null +++ b/doc/3/controllers/index/list/snippets/list.java @@ -0,0 +1 @@ +ArrayList result = kuzzle.getIndexController().list().get(); diff --git a/doc/3/controllers/index/list/snippets/list.test.yml b/doc/3/controllers/index/list/snippets/list.test.yml new file mode 100644 index 00000000..4c703391 --- /dev/null +++ b/doc/3/controllers/index/list/snippets/list.test.yml @@ -0,0 +1,10 @@ +--- +name: Index#ListAsync +description: List indexes handled by Kuzzle. +hooks: + before: | + curl -X POST kuzzle:7512/admin/_resetDatabase + curl -X POST kuzzle:7512/nyc-open-data/_create + after: +template: print-result +expected: ["nyc-open-data"] diff --git a/doc/3/controllers/index/m-delete/index.md b/doc/3/controllers/index/m-delete/index.md new file mode 100644 index 00000000..20fdf05f --- /dev/null +++ b/doc/3/controllers/index/m-delete/index.md @@ -0,0 +1,29 @@ +--- +code: true +type: page +title: MDelete +description: Deletes multiple indexes. +--- + +# MDelete + +Deletes multiple indexes. + +## Arguments + +```java +CompletableFuture> mDelete(final ArrayList indexes) + throws NotConnectedException, InternalException +``` + +| Argument | Type | Description | +|-----------|-------------------|-----------------------| +| `indexes` | 
ArrayList
| List of indexes names | + +## Return + +Returns an `ArrayList` containing the list of indexes names deleted. + +## Usage + +<<< ./snippets/mDelete.java diff --git a/doc/3/controllers/index/m-delete/snippets/mDelete.java b/doc/3/controllers/index/m-delete/snippets/mDelete.java new file mode 100644 index 00000000..9ac9c0be --- /dev/null +++ b/doc/3/controllers/index/m-delete/snippets/mDelete.java @@ -0,0 +1,3 @@ +ArrayList indexes = new ArrayList<>(); + indexes.add("nyc-open-data"); +ArrayList result = kuzzle.getIndexController().mDelete(indexes).get(); diff --git a/doc/3/controllers/index/m-delete/snippets/mDelete.test.yml b/doc/3/controllers/index/m-delete/snippets/mDelete.test.yml new file mode 100644 index 00000000..00423931 --- /dev/null +++ b/doc/3/controllers/index/m-delete/snippets/mDelete.test.yml @@ -0,0 +1,8 @@ +--- +name: Index#MDeleteAsync +description: Delete multiple indexes. +hooks: + before: curl -X POST kuzzle:7512/nyc-open-data/_create ; curl -X POST kuzzle:7512/mtp-open-data/_create + after: +template: print-result +expected: ["nyc-open-data"] \ No newline at end of file diff --git a/src/main/java/io/kuzzle/sdk/API/Controllers/IndexController.java b/src/main/java/io/kuzzle/sdk/API/Controllers/IndexController.java new file mode 100644 index 00000000..71c529c9 --- /dev/null +++ b/src/main/java/io/kuzzle/sdk/API/Controllers/IndexController.java @@ -0,0 +1,98 @@ +package io.kuzzle.sdk.API.Controllers; + +import io.kuzzle.sdk.CoreClasses.Maps.KuzzleMap; +import io.kuzzle.sdk.Exceptions.InternalException; +import io.kuzzle.sdk.Exceptions.NotConnectedException; +import io.kuzzle.sdk.Kuzzle; + +import java.util.ArrayList; +import java.util.concurrent.CompletableFuture; + +public class IndexController extends BaseController { + public IndexController(final Kuzzle kuzzle) { + super(kuzzle); + } + + /** + * Creates a new index in Kuzzle via the persistence engine. + * + * @param index + * @return A CompletableFuture + * @throws NotConnectedException + * @throws InternalException + */ + public CompletableFuture create(final String index) throws NotConnectedException, InternalException { + return kuzzle + .query(new KuzzleMap() + .put("controller", "index") + .put("action", "create") + .put("index", index)) + .thenApplyAsync((response) -> null); + } + + /** + * Deletes an index in Kuzzle via the persistence engine. + * + * @param index + * @return A CompletableFuture + * @throws NotConnectedException + * @throws InternalException + */ + public CompletableFuture delete(final String index) throws NotConnectedException, InternalException { + return kuzzle + .query(new KuzzleMap() + .put("controller", "index") + .put("action", "delete") + .put("index", index)) + .thenApplyAsync((response) -> null); + } + + /** + * Checks if an index exists in the Kuzzle persistence engine. + * + * @param index + * @return A CompletableFuture + * @throws NotConnectedException + * @throws InternalException + */ + public CompletableFuture exists(final String index) throws NotConnectedException, InternalException { + return kuzzle + .query(new KuzzleMap() + .put("controller", "index") + .put("action", "exists") + .put("index", index)) + .thenApplyAsync((response) -> (Boolean) response.result); + } + + /** + * Lists indexes from the Kuzzle persistence engine. + * + * @return A CompletableFuture> + * @throws NotConnectedException + * @throws InternalException + */ + public CompletableFuture> list() throws NotConnectedException, InternalException { + return kuzzle + .query(new KuzzleMap() + .put("controller", "index") + .put("action", "list")) + .thenApplyAsync((response) -> (((KuzzleMap) response.result).getArrayList("indexes"))); + } + + /** + * Deletes multiple indexes from the Kuzzle persistence engine. + * + * @param indexes + * @return A CompletableFuture> + * @throws NotConnectedException + * @throws InternalException + */ + public CompletableFuture> mDelete(final ArrayList indexes) throws NotConnectedException, InternalException { + return kuzzle + .query(new KuzzleMap() + .put("controller", "index") + .put("action", "mDelete") + .put("body", new KuzzleMap().put("indexes", indexes))) + .thenApplyAsync((response) -> (((KuzzleMap) response.result).getArrayList("deleted"))); + } +} diff --git a/src/main/java/io/kuzzle/sdk/Exceptions/KuzzleExceptionCode.java b/src/main/java/io/kuzzle/sdk/Exceptions/KuzzleExceptionCode.java index c490c9ec..a4edf6f1 100644 --- a/src/main/java/io/kuzzle/sdk/Exceptions/KuzzleExceptionCode.java +++ b/src/main/java/io/kuzzle/sdk/Exceptions/KuzzleExceptionCode.java @@ -2,7 +2,7 @@ public enum KuzzleExceptionCode { MISSING_REQUESTID(0, "Missing field requestId"), - MSSING_QUERY(400, "You must provide a query"), + MISSING_QUERY(400, "You must provide a query"), NOT_CONNECTED(500, "Not connected."), CONNECTION_LOST(500, "Connection lost"), WRONG_VOLATILE_TYPE( diff --git a/src/main/java/io/kuzzle/sdk/Kuzzle.java b/src/main/java/io/kuzzle/sdk/Kuzzle.java index 3acb9446..745ccc65 100644 --- a/src/main/java/io/kuzzle/sdk/Kuzzle.java +++ b/src/main/java/io/kuzzle/sdk/Kuzzle.java @@ -1,5 +1,6 @@ package io.kuzzle.sdk; +import io.kuzzle.sdk.API.Controllers.IndexController; import io.kuzzle.sdk.CoreClasses.Json.JsonSerializer; import io.kuzzle.sdk.CoreClasses.Maps.KuzzleMap; import io.kuzzle.sdk.API.Controllers.AuthController; @@ -66,10 +67,20 @@ public Kuzzle(final AbstractProtocol networkProtocol) this(networkProtocol, new KuzzleOptions()); } + /** + * @return The AuthController + */ public AuthController getAuthController() { return new AuthController(this); } + /** + * @return The IndexController + */ + public IndexController getIndexController() { + return new IndexController(this); + } + /** * Initialize a new instance of Kuzzle * @@ -184,7 +195,7 @@ public CompletableFuture query( final ConcurrentHashMap query) throws InternalException, NotConnectedException { if (query == null) { - throw new InternalException(KuzzleExceptionCode.MSSING_QUERY); + throw new InternalException(KuzzleExceptionCode.MISSING_QUERY); } if (networkProtocol.getState() == ProtocolState.CLOSE) { diff --git a/src/test/java/io/kuzzle/test/API/Controllers/IndexControllerTest.java b/src/test/java/io/kuzzle/test/API/Controllers/IndexControllerTest.java new file mode 100644 index 00000000..23d79f4f --- /dev/null +++ b/src/test/java/io/kuzzle/test/API/Controllers/IndexControllerTest.java @@ -0,0 +1,98 @@ +package io.kuzzle.test.API.Controllers; + +import io.kuzzle.sdk.CoreClasses.Maps.KuzzleMap; +import io.kuzzle.sdk.CoreClasses.Responses.Response; +import io.kuzzle.sdk.Events.Event; +import io.kuzzle.sdk.Exceptions.InternalException; +import io.kuzzle.sdk.Exceptions.NotConnectedException; +import io.kuzzle.sdk.Kuzzle; +import io.kuzzle.sdk.Protocol.AbstractProtocol; +import io.kuzzle.sdk.Protocol.WebSocket; +import org.junit.Test; +import org.mockito.ArgumentCaptor; +import org.mockito.Mockito; + +import java.util.ArrayList; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ConcurrentHashMap; + +import static org.junit.Assert.assertEquals; +import static org.mockito.Mockito.*; + +public class IndexControllerTest { + private AbstractProtocol networkProtocol = Mockito.mock(WebSocket.class); + + @Test + public void createTest() throws NotConnectedException, InternalException { + Kuzzle kuzzleSpy = spy(new Kuzzle(networkProtocol)); + + ArgumentCaptor arg = ArgumentCaptor.forClass(KuzzleMap.class); + + kuzzleSpy.getIndexController().create("my-index"); + verify(kuzzleSpy, times(1)).query((KuzzleMap) arg.capture()); + + assertEquals("index", ((KuzzleMap) arg.getValue()).getString("controller")); + assertEquals("create", ((KuzzleMap) arg.getValue()).getString("action")); + assertEquals("my-index", ((KuzzleMap) arg.getValue()).getString("index")); + } + + @Test + public void deleteTest() throws NotConnectedException, InternalException { + Kuzzle kuzzleSpy = spy(new Kuzzle(networkProtocol)); + + ArgumentCaptor arg = ArgumentCaptor.forClass(KuzzleMap.class); + + kuzzleSpy.getIndexController().delete("my-index"); + verify(kuzzleSpy, times(1)).query((KuzzleMap) arg.capture()); + + assertEquals("index", ((KuzzleMap) arg.getValue()).getString("controller")); + assertEquals("delete", ((KuzzleMap) arg.getValue()).getString("action")); + assertEquals("my-index", ((KuzzleMap) arg.getValue()).getString("index")); + } + + @Test + public void existsTest() throws NotConnectedException, InternalException { + Kuzzle kuzzleSpy = spy(new Kuzzle(networkProtocol)); + + ArgumentCaptor arg = ArgumentCaptor.forClass(KuzzleMap.class); + + kuzzleSpy.getIndexController().exists("my-index"); + verify(kuzzleSpy, times(1)).query((KuzzleMap) arg.capture()); + + assertEquals("index", ((KuzzleMap) arg.getValue()).getString("controller")); + assertEquals("exists", ((KuzzleMap) arg.getValue()).getString("action")); + assertEquals("my-index", ((KuzzleMap) arg.getValue()).getString("index")); + } + + @Test + public void listTest() throws NotConnectedException, InternalException { + Kuzzle kuzzleSpy = spy(new Kuzzle(networkProtocol)); + + ArgumentCaptor arg = ArgumentCaptor.forClass(KuzzleMap.class); + + kuzzleSpy.getIndexController().list(); + verify(kuzzleSpy, times(1)).query((KuzzleMap) arg.capture()); + + assertEquals("index", ((KuzzleMap) arg.getValue()).getString("controller")); + assertEquals("list", ((KuzzleMap) arg.getValue()).getString("action")); + } + + @Test + public void mDeleteTest() throws NotConnectedException, InternalException { + Kuzzle kuzzleSpy = spy(new Kuzzle(networkProtocol)); + + ArgumentCaptor arg = ArgumentCaptor.forClass(KuzzleMap.class); + + ArrayList indexes = new ArrayList<>(); + indexes.add("index1"); + indexes.add("index2"); + + kuzzleSpy.getIndexController().mDelete(indexes); + verify(kuzzleSpy, times(1)).query((KuzzleMap) arg.capture()); + + assertEquals("index", ((KuzzleMap) arg.getValue()).getString("controller")); + assertEquals("mDelete", ((KuzzleMap) arg.getValue()).getString("action")); + assertEquals("index1", ((ArrayList)((ConcurrentHashMap)(((KuzzleMap) arg.getValue()).get("body"))).get("indexes")).get(0)); + assertEquals("index2", ((ArrayList)((ConcurrentHashMap)(((KuzzleMap) arg.getValue()).get("body"))).get("indexes")).get(1)); + } +} From 3fa0723c59adb3a75d3376a044b7f3730915270c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Blondel?= Date: Mon, 24 Feb 2020 13:28:31 +0100 Subject: [PATCH 2/2] Apply suggestions from code review Co-Authored-By: Adrien Maret --- .travis.yml | 2 +- doc/3/controllers/index/create/index.md | 4 ++-- doc/3/controllers/index/delete/index.md | 4 ++-- doc/3/controllers/index/exists/index.md | 4 ++-- doc/3/controllers/index/list/index.md | 6 +++--- doc/3/controllers/index/m-delete/index.md | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.travis.yml b/.travis.yml index 3baa35ce..7ebf0f8b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -27,7 +27,7 @@ jobs: name: Documentation Snippets if: type = pull_request OR type = push AND branch =~ /^master|[0-9]+-dev$/ OR type = cron language: node_js - node_js: 10 + node_js: 12 script: - docker-compose -f .ci/doc/docker-compose.yml run doc-tests index diff --git a/doc/3/controllers/index/create/index.md b/doc/3/controllers/index/create/index.md index 9cb1b347..8f4d03d6 100644 --- a/doc/3/controllers/index/create/index.md +++ b/doc/3/controllers/index/create/index.md @@ -1,11 +1,11 @@ --- code: true type: page -title: Create +title: create description: Creates an index. --- -# Create +# create Creates a new index in Kuzzle diff --git a/doc/3/controllers/index/delete/index.md b/doc/3/controllers/index/delete/index.md index 8541d655..821b3603 100644 --- a/doc/3/controllers/index/delete/index.md +++ b/doc/3/controllers/index/delete/index.md @@ -1,11 +1,11 @@ --- code: true type: page -title: Delete +title: delete description: Deletes an index. --- -# Delete +# delete Deletes an entire index from Kuzzle. diff --git a/doc/3/controllers/index/exists/index.md b/doc/3/controllers/index/exists/index.md index 871d778b..69e9c014 100644 --- a/doc/3/controllers/index/exists/index.md +++ b/doc/3/controllers/index/exists/index.md @@ -1,11 +1,11 @@ --- code: true type: page -title: Exists +title: exists description: Check for index existence. --- -# Exists +# exists Checks if the given index exists in Kuzzle. diff --git a/doc/3/controllers/index/list/index.md b/doc/3/controllers/index/list/index.md index c99054f8..ddf5ee86 100644 --- a/doc/3/controllers/index/list/index.md +++ b/doc/3/controllers/index/list/index.md @@ -1,11 +1,11 @@ --- code: true type: page -title: List -description: List the indexes. +title: list +description: Lists the indexes. --- -# List +# list Gets the complete list of indexes handled by Kuzzle. diff --git a/doc/3/controllers/index/m-delete/index.md b/doc/3/controllers/index/m-delete/index.md index 20fdf05f..212edebc 100644 --- a/doc/3/controllers/index/m-delete/index.md +++ b/doc/3/controllers/index/m-delete/index.md @@ -1,11 +1,11 @@ --- code: true type: page -title: MDelete +title: mDelete description: Deletes multiple indexes. --- -# MDelete +# mDelete Deletes multiple indexes.