asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: fix details of selecting fields and relationships in api reference (#7642)

Browse Source
This commit is contained in:
Shahed Nasser
2024-06-09 15:19:51 +02:00
committed by GitHub
parent 46c5c5fe28
commit 2597990363
2 changed files with 33 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/app/_mdx/admin.mdx
+14 -15
View File
@@ -199,17 +199,7 @@ x-no-compression: true
## Select Fields and Relations
Many API Routes accept a `fields` query that allows you to select which fields and relations should be returned in a record.
<Note type="warning">
When you pass the `fields` query, only specified fields and relations, along with the `id`, are retrieved in the result.
</Note>
### Select Multiple Fields
Separate the fields and relations you want to select with a comma.
Fields and relations are separated by a comma `,`.
For example:
@@ -220,12 +210,21 @@ curl 'localhost:9000/admin/products?fields=title,handle' \
This returns only the `title` and `handle` fields of a product.
### Fields Operator
By default, only the selected fields and relations are returned in the response.
Before every field or relation, you can pass one of the following operators to change the default behavior:
- `+`: Add the field to the fields returned by default. For example, `+title` returns the `title` field along with the fields returned by default.
- `-`: Remove the field from the fields returned by default. For example, `-title` removes the `title` field from the fields returned by default.
### Select Relations
To select a relation, pass to `fields` the relation name prefixed by `.*`. For example:
To select a relation, pass to `fields` the relation name prefixed by `*`. For example:
```bash
curl 'localhost:9000/admin/products?fields=variants.*' \
curl 'localhost:9000/admin/products?fields=*variants' \
-H 'Authorization: Bearer {jwt_token}'
```
@@ -233,9 +232,9 @@ This returns the variants of each product.
### Select Fields in a Relation
The `.*` suffix selects all fields of the relation's data model.
The `*` prefix selects all fields of the relation's data model.
To select a specific field, change the `*` to the field's name.
To select a specific field, pass a `.<field>` suffix instead of the `*` prefix. For example, `variants.title`.
To specify multiple fields, pass each of the fields with the `<relation>.<field>` format, separated by a comma.
www/apps/api-reference/app/_mdx/store.mdx
+19 -26
View File
@@ -213,51 +213,47 @@ x-no-compression: true
## Select Fields and Relations
Many API Routes accept a `fields` query that allows you to select which fields and relations should be returned in a record.
<Note type="warning">
When you pass the `fields` query, only specified fields and relations, along with the `id`, are retrieved in the result.
</Note>
### Select Multiple Fields
Separate the fields and relations you want to select with a comma.
Fields and relations are separated by a comma `,`.
For example:
```bash
curl 'localhost:9000/store/products?fields=title,handle' \
-H 'Authorization: Bearer {jwt_token}'
curl 'localhost:9000/store/products?fields=title,handle'
```
This returns only the `title` and `handle` fields of a product.
### Fields Operator
By default, only the selected fields and relations are returned in the response.
Before every field or relation, you can pass one of the following operators to change the default behavior:
- `+`: Add the field to the fields returned by default. For example, `+title` returns the `title` field along with the fields returned by default.
- `-`: Remove the field from the fields returned by default. For example, `-title` removes the `title` field from the fields returned by default.
### Select Relations
To select a relation, pass to `fields` the relation name prefixed by `.*`. For example:
To select a relation, pass to `fields` the relation name prefixed by `*`. For example:
```bash
curl 'localhost:9000/store/products?fields=variants.*' \
-H 'Authorization: Bearer {jwt_token}'
curl 'localhost:9000/store/products?fields=*variants'
```
This returns the variants of each product.
### Select Fields in a Relation
The `.*` suffix selects all fields of the relation's data model.
The `*` prefix selects all fields of the relation's data model.
To select a specific field, change the `*` to the field's name.
To select a specific field, pass a `.<field>` suffix instead of the `*` prefix. For example, `variants.title`.
To specify multiple fields, pass each of the fields with the `<relation>.<field>` format, separated by a comma.
For example:
```bash
curl 'localhost:9000/store/products?fields=variants.title,variants.sku' \
-H 'Authorization: Bearer {jwt_token}'
curl 'localhost:9000/store/products?fields=variants.title,variants.sku'
```
This returns the variants of each product, but the variants only have their `id`, `title`, and `sku` fields. The `id` is always included.
@@ -435,8 +431,7 @@ Use the `offset` query parameter to change between pages. For example, if the li
For example:
```bash
curl "http://localhost:9000/store/products?limit=5" \
-H 'Authorization: Bearer {jwt_token}'
curl "http://localhost:9000/store/products?limit=5"
```
@@ -465,8 +460,7 @@ sort the retrieved items by a field of that item.
For example, pass the query parameter `order=created_at` to sort products by their `created_at` field:
```bash
curl "http://localhost:9000/store/products?order=created_at" \
-H 'Authorization: Bearer {jwt_token}'
curl "http://localhost:9000/store/products?order=created_at"
```
By default, the sort direction is ascending. To change it to
@@ -475,8 +469,7 @@ descending, pass a dash (`-`) before the field name.
For example:
```bash
curl "http://localhost:9000/store/products?order=-created_at" \
-H 'Authorization: Bearer {jwt_token}'
curl "http://localhost:9000/store/products?order=-created_at"
```