Skip to content
This repository was archived by the owner on Mar 21, 2024. It is now read-only.

Commit 74c010f

Browse files
committed
Remove name field
1 parent dc6cc4d commit 74c010f

File tree

2 files changed

+4
-23
lines changed

2 files changed

+4
-23
lines changed

open-api.yaml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ components:
3434
additionalProperties: false
3535
examples:
3636
- uid: movies
37-
name: movies
3837
primaryKey: movie_id
3938
createdAt: '2019-11-20T09:40:33.711324Z'
4039
updatedAt: '2019-11-20T09:40:33.711324Z'
@@ -45,9 +44,6 @@ components:
4544
type: string
4645
example: movies
4746
description: Unique identifier for the index
48-
name:
49-
type: string
50-
description: Name of the index
5147
primaryKey:
5248
type:
5349
- string
@@ -61,7 +57,6 @@ components:
6157
$ref: '#/components/schemas/timestamp'
6258
required:
6359
- uid
64-
- name
6560
- createdAt
6661
- updatedAt
6762
document:
@@ -993,7 +988,6 @@ paths:
993988
Example:
994989
value:
995990
- uid: movies
996-
name: movies
997991
primaryKey: movie_id
998992
createdAt: '2019-11-20T09:40:33.711324Z'
999993
updatedAt: '2019-11-20T09:40:33.711324Z'
@@ -1077,7 +1071,6 @@ paths:
10771071
Example:
10781072
value:
10791073
uid: movies
1080-
name: movies
10811074
primaryKey: movie_id
10821075
createdAt: '2019-11-20T09:40:33.711324Z'
10831076
updatedAt: '2019-11-20T09:40:33.711324Z'

text/0132-indexes-api.md

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,7 @@ This field is mandatory when creating an index and cannot be changed afterwards.
3737

3838
The field `uid` can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).
3939

40-
#### 3.1.2. `name`
41-
42-
- Type: string
43-
- Required: false
44-
45-
This field is automatically generated by the engine when creating an index and is equal to the value of `uid`.
46-
47-
It is not possible to give a custom value to `name` when creating or updating an index.
48-
49-
#### 3.1.3. `primaryKey`
40+
#### 3.1.2. `primaryKey`
5041

5142
- Type: string
5243
- Required: false
@@ -62,7 +53,7 @@ Specifying this field tells the engine to use the document attribute specified i
6253

6354
When the index is empty, it is possible to modify the `primaryKey`.
6455

65-
#### 3.1.4. `createdAt`
56+
#### 3.1.3. `createdAt`
6657

6758
- Type: string
6859
- Required: false
@@ -73,7 +64,7 @@ Automatically generated by the engine at the creation of an index.
7364

7465
Represented with the `RFC 3339` format.
7566

76-
#### 3.1.5. `updatedAt`
67+
#### 3.1.4. `updatedAt`
7768

7869
- Type: string
7970
- Required: false
@@ -111,13 +102,10 @@ Fetch an index of a Meilisearch instance.
111102
| Field | Type | Required |
112103
|--------------------------|--------------------------|----------|
113104
| `uid` | string | true |
114-
| `name` | string | true |
115105
| `primaryKey` | string / `null` | true |
116106
| `createdAt` | string | true |
117107
| `updatedAt` | string | true |
118108

119-
The `name` field has the same value as the `uid`.
120-
121109
##### 3.2.2.2. Errors
122110

123111
- 🔴 If the requested `index_uid` does not exist, the API returns an [index_not_found](0061-error-format-and-definitions.md#index_not_found) error.
@@ -217,5 +205,5 @@ The auth layer can return the following errors if Meilisearch is secured (a mast
217205
N/A
218206

219207
## 5. Future Possibilities
220-
- Delete `uid` or `name`.
208+
221209
- Rework the `primaryKey` concept

0 commit comments

Comments
 (0)