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

Commit 7863ed3

Browse files
committed
Remove name field (#140)
1 parent bba69d4 commit 7863ed3

File tree

2 files changed

+4
-24
lines changed

2 files changed

+4
-24
lines changed

open-api.yaml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ components:
5454
additionalProperties: false
5555
examples:
5656
- uid: movies
57-
name: movies
5857
primaryKey: movie_id
5958
createdAt: '2019-11-20T09:40:33.711324Z'
6059
updatedAt: '2019-11-20T09:40:33.711324Z'
@@ -65,9 +64,6 @@ components:
6564
type: string
6665
example: movies
6766
description: Unique identifier for the index
68-
name:
69-
type: string
70-
description: Name of the index
7167
primaryKey:
7268
type:
7369
- string
@@ -81,7 +77,6 @@ components:
8177
$ref: '#/components/schemas/timestamp'
8278
required:
8379
- uid
84-
- name
8580
- createdAt
8681
- updatedAt
8782
document:
@@ -1044,7 +1039,6 @@ paths:
10441039
value:
10451040
results:
10461041
- uid: movies
1047-
name: movies
10481042
primaryKey: movie_id
10491043
createdAt: '2019-11-20T09:40:33.711324Z'
10501044
updatedAt: '2019-11-20T09:40:33.711324Z'
@@ -1134,7 +1128,6 @@ paths:
11341128
Example:
11351129
value:
11361130
uid: movies
1137-
name: movies
11381131
primaryKey: movie_id
11391132
createdAt: '2019-11-20T09:40:33.711324Z'
11401133
updatedAt: '2019-11-20T09:40:33.711324Z'

text/0132-indexes-api.md

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

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

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

4940
- Type: string
5041
- Required: false
@@ -60,7 +51,7 @@ Specifying this field tells the engine to use the document attribute specified i
6051

6152
When the index is empty, it is possible to modify the `primaryKey`.
6253

63-
#### 3.1.4. `createdAt`
54+
#### 3.1.3. `createdAt`
6455

6556
- Type: string
6657
- Required: false
@@ -71,7 +62,7 @@ Automatically generated by the engine at the creation of an index.
7162

7263
Represented with the `RFC 3339` format.
7364

74-
#### 3.1.5. `updatedAt`
65+
#### 3.1.4. `updatedAt`
7566

7667
- Type: string
7768
- Required: false
@@ -173,13 +164,10 @@ Fetch an index of a Meilisearch instance.
173164
| Field | Type | Required |
174165
|--------------------------|--------------------------|----------|
175166
| `uid` | string | true |
176-
| `name` | string | true |
177167
| `primaryKey` | string / `null` | true |
178168
| `createdAt` | string | true |
179169
| `updatedAt` | string | true |
180170

181-
The `name` field has the same value as the `uid`.
182-
183171
##### 3.2.2.2. Errors
184172

185173
- 🔴 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.
@@ -279,6 +267,5 @@ The auth layer can return the following errors if Meilisearch is secured (a mast
279267
N/A
280268

281269
## 5. Future Possibilities
282-
- Delete `uid` or `name`.
270+
283271
- Rework the `primaryKey` concept
284-
- Paginate `GET` - `/indexes`

0 commit comments

Comments
 (0)