Skip to content

v0.28: Changes to /documents #1736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 30, 2022
Merged

v0.28: Changes to /documents #1736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
936ebb4
update GET /documents response object
guimachiavelli Jun 16, 2022
a22ef1f
rename /documents `attributesToRetrieve` to `fields`
guimachiavelli Jun 16, 2022
ad9b84f
improve wording
guimachiavelli Jun 16, 2022
ab1c001
/documents API reference: address review feedback
guimachiavelli Jun 22, 2022
32b82c7
Update reference/api/documents.md
guimachiavelli Jun 29, 2022
ae3eff9
rollback change to meilisearch-collection.json
guimachiavelli Jun 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .code-samples.meilisearch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ delete_an_index_1: |-
-X DELETE 'http://localhost:7700/indexes/movies'
get_one_document_1: |-
curl \
-X GET 'http://localhost:7700/indexes/movies/documents/25684'
-X GET 'http://localhost:7700/indexes/movies/documents/25684?fields=id,title,poster,release_date'
get_documents_1: |-
curl \
-X GET 'http://localhost:7700/indexes/movies/documents?limit=2'
Expand Down
60 changes: 38 additions & 22 deletions reference/api/documents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ The `/documents` route allows you to create, manage, and delete documents.

Get one [document](/learn/core_concepts/documents.md) using its unique id. Both the index [`uid`](/learn/core_concepts/indexes.md#index-uid) and [document id](/learn/core_concepts/primary_key.md#document-id) are required.

You can use the optional `fields` query parameter to specify which document fields Meilisearch should include in the response body. `fields` accepts a case-sensitive list of document fields separated by a comma.

#### Query parameters

| Query Parameter | Description | Default Value |
| ------------------------ | ------------------------------ | :-----------: |
| **fields** | Document attributes to show | \* |

### Example

<CodeSamples id="get_one_document_1" />
Expand All @@ -21,7 +29,6 @@ Get one [document](/learn/core_concepts/documents.md) using its unique id. Both
"id": 25684,
"title": "American Ninja 5",
"poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
"overview": "When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja.",
"release_date": "1993-01-01"
}
```
Expand All @@ -40,11 +47,11 @@ Documents are ordered by Meilisearch depending on the hash of their id.

#### Query parameters

| Query Parameter | Description | Default Value |
| ------------------------ | --------------------------- | :-----------: |
| **offset** | number of documents to skip | 0 |
| **limit** | number of documents to take | 20 |
| **attributesToRetrieve** | document attributes to show | \* |
| Query Parameter | Description | Default Value |
| ------------------------ | ------------------------------ | :-----------: |
| **offset** | Number of documents to skip | 0 |
| **limit** | Number of documents to return | 20 |
| **fields** | Document attributes to show | \* |

### Example

Expand All @@ -53,24 +60,33 @@ Documents are ordered by Meilisearch depending on the hash of their id.
#### Response: `200 Ok`

```json
[
{
"id": 25684,
"release_date": "1993-01-01",
"poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
"title": "American Ninja 5",
"overview": "When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja."
},
{
"id": 468219,
"title": "Dead in a Week (Or Your Money Back)",
"release_date": "2018-09-12",
"poster": "https://image.tmdb.org/t/p/w1280/f4ANVEuEaGy2oP5M0Y2P1dwxUNn.jpg",
"overview": "William has failed to kill himself so many times that he outsources his suicide to aging assassin Leslie. But with the contract signed and death assured within a week (or his money back), William suddenly discovers reasons to live... However Leslie is under pressure from his boss to make sure the contract is completed."
}
]
{
"results": [
{
"id": 25684,
"release_date": "1993-01-01",
"poster": "https://image.tmdb.org/t/p/w1280/iuAQVI4mvjI83wnirpD8GVNRVuY.jpg",
"title": "American Ninja 5",
"overview": "When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja."
},
{
"id": 468219,
"title": "Dead in a Week (Or Your Money Back)",
"release_date": "2018-09-12",
"poster": "https://image.tmdb.org/t/p/w1280/f4ANVEuEaGy2oP5M0Y2P1dwxUNn.jpg",
"overview": "William has failed to kill himself so many times that he outsources his suicide to aging assassin Leslie. But with the contract signed and death assured within a week (or his money back), William suddenly discovers reasons to live... However Leslie is under pressure from his boss to make sure the contract is completed."
}
],
"offset": 0,
"limit": 2,
"total": 500134
}
```

::: note
The response's `total` value response indicates the total number of documents in the queried index.
:::

## Add or replace documents

<RouteHighlighter method="POST" route="/indexes/{index_uid}/documents"/>
Expand Down