Merge #193

193: Lazy index r=bidoubiwa a=bidoubiwa

# Breaking changes:

## Index is now a public Class required for most of the indexes related methods

In MeiliSearch some actions are about to the whole instance. For example `GET /stats` but most are specific actions on indexes, for exemple `GET indexes/myIndex/documents`.
All specific actions linked to an index are now available through an instance of the `Indexes` class.

### Before

```swift
client.addDocuments(documents)
```

### After

Now, these methods are only available in the `Indexes` class.

```swift
let index = client.index("myIndex")
index.getDocuments().
```

Or

```swift
client.index(myIndex").getDocuments()
```

The following method are still available in a Client instance and return an `Index` instance:

- `client.index("myIndex")`
- `createIndex(uid: "myIndex")`
- `getOrCreateIndex(uid: "myIndex")`
- `getindex("myIndex")`
- `getindexes("myIndex")` -> returns an array of Indexes()

## Breaking methods

Every method related to a specific `index` are now only available in an Index instance.

These are the methods that you will not find on a `Client` instance anymore:

- `client.index("myIndex").addDocuments`
- `client.index("myIndex").updateDocuments`
- `client.index("myIndex").updateDocuments`
- `client.index("myIndex").getDocument`
- `client.index("myIndex").getDocument`
- `client.index("myIndex").getDocuments`
- `client.index("myIndex").deleteDocument`
- `client.index("myIndex").deleteAllDocuments`
- `client.index("myIndex").deleteBatchDocuments`
- `client.index("myIndex").search`
- `client.index("myIndex").getUpdate`
- `client.index("myIndex").getAllUpdates`
- `client.index("myIndex").waitForPendingUpdate`
- `client.index("myIndex").getSettings`
- `client.index("myIndex").updateSettings`
- `client.index("myIndex").resetSettings`
- `client.index("myIndex").getSynonyms`
- `client.index("myIndex").updateSynonyms`
- `client.index("myIndex").resetSynonyms`
- `client.index("myIndex").getStopWords`
- `client.index("myIndex").updateStopWords`
- `client.index("myIndex").resetStopWords`
- `client.index("myIndex").getRankingRules`
- `client.index("myIndex").updateRankingRules`
- `client.index("myIndex").resetRankingRules`
- `client.index("myIndex").getDistinctAttribute`
- `client.index("myIndex").updateDistinctAttribute`
- `client.index("myIndex").resetDistinctAttribute`
- `client.index("myIndex").getSearchableAttributes`
- `client.index("myIndex").updateSearchableAttributes`
- `client.index("myIndex").resetSearchableAttributes`
- `client.index("myIndex").getDisplayedAttributes`
- `client.index("myIndex").updateDisplayedAttributes`
- `client.index("myIndex").resetDisplayedAttributes`
- `client.index("myIndex").getFilterableAttributes`
- `client.index("myIndex").updateFilterableAttributes`
- `client.index("myIndex").resetFilterableAttributes`
- `client.index("myIndex").getSortableAttributes`
- `client.index("myIndex").updateSortableAttributes`
- `client.index("myIndex").resetSortableAttributes`
- `client.index("myIndex").stats`

## Parameters label removed/added/renamed

Some method saw there parameter declaration changed to make the usage more explicit and to add some needed data.

Example:
`createIndex(UID: String, _ completion: ...)`
Became:
`createIndex(uid: String, primaryKey: String? = nil, _ completion: ...)`

All required `UID` labels became `uid`. As seen in the example above.


Co-authored-by: Charlotte Vermandel <charlottevermandel@gmail.com>
Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com>

Author: bors[bot]

.code-samples.meilisearch.yaml

@@ -32,12 +32,6 @@ private struct Movie: Codable, Equatable {
   let title: String
   let comment: String?
 
-  enum CodingKeys: String, CodingKey {
-    case id
-    case title
-    case comment
-  }
-
   init(id: Int, title: String, comment: String? = nil) {
     self.id = id
     self.title = title
@@ -62,7 +56,7 @@ func index(request: HTTPRequest, response: HTTPResponse) {
     return
   }
 
-  client.getIndex(UID: uid) { result in
+  client.getIndex(uid) { result in
 
     switch result {
     case .success(let index):
@@ -112,7 +106,7 @@ func search(request: HTTPRequest, response: HTTPResponse) {
 
   let searchParameters = SearchParameters.query(query)
 
-  client.search(UID: "books_test", searchParameters) { (result: Result<SearchResult<Movie>, Swift.Error>) in
+  client.index("books_test").search(searchParameters) { (result: Result<SearchResult<Movie>, Swift.Error>) in
 
     switch result {
     case .success(let searchResult):

Demos/PerfectDemo/Sources/PerfectTemplate/main.swift

@@ -9,12 +9,6 @@ private struct Movie: Codable, Equatable {
   let title: String
   let comment: String?
 
-  enum CodingKeys: String, CodingKey {
-    case id
-    case title
-    case comment
-  }
-
   init(id: Int, title: String, comment: String? = nil) {
     self.id = id
     self.title = title
@@ -43,7 +37,7 @@ func routes(_ app: Application) throws {
         return
       }
 
-      client.getIndex(UID: uid) { result in
+      client.getIndex(uid) { result in
 
         switch result {
         case .success(let index):
@@ -83,7 +77,7 @@ func routes(_ app: Application) throws {
 
       let searchParameters = SearchParameters.query(query)
 
-      client.search(UID: "movies", searchParameters) { (result: Result<SearchResult<Movie>, Swift.Error>) in
+      client.index("movies").search(searchParameters) { (result: Result<SearchResult<Movie>, Swift.Error>) in
         switch result {
         case .success(let searchResult):
           if let jsonData = try? JSONSerialization.data(withJSONObject: searchResult.hits, options: []) {

Demos/VaporDemo/Sources/App/routes.swift

@@ -117,11 +117,10 @@ To do a simply search using the client, you can create a Swift script like this:
 
     // An index is where the documents are stored.
     // The uid is the unique identifier to that index.
-    let indexUid = "movies"
+    let index = client.index("movies")
 
     // If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
-    client.addDocuments(
-        UID: indexUid,
+    client.index.addDocuments(
         documents: movies,
         primaryKey: nil
     ) { result in
@@ -139,6 +138,7 @@ To do a simply search using the client, you can create a Swift script like this:
 With the `updateId`, you can check the status (`enqueued`, `processing`, `processed` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
 
 #### Basic Search <!-- omit in toc -->
+
 ```swift
 
 let semaphore = DispatchSemaphore(value: 0)
@@ -147,7 +147,7 @@ let semaphore = DispatchSemaphore(value: 0)
 typealias MeiliResult = Result<SearchResult<Movie>, Swift.Error>
 
 // Call the function search and wait for the closure result.
-client.search(UID: "movies", SearchParameters( query: "philoudelphia" )) { (result: MeiliResult) in
+client.index("movies").search(SearchParameters( query: "philoudelphia" )) { (result: MeiliResult) in
     switch result {
     case .success(let searchResult):
         dump(searchResult)
@@ -208,8 +208,8 @@ If you want to know more about the development workflow or want to contribute, p
 
 To try out a demo you will need to go to its directory in `Demos/`. In that directory you can either:
 
- - Open the SwiftPM project in Xcode and press run, or
- - Run `swift build` or `swift run` in the terminal.
+- Open the SwiftPM project in Xcode and press run, or
+- Run `swift build` or `swift run` in the terminal.
 
 ### Vapor <!-- omit in toc -->