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

docs: fix expanding of custom relations in customer and product category routes (#10620)

Browse Source
This commit is contained in:
Shahed Nasser
2024-12-16 18:46:57 +02:00
committed by GitHub
parent e8b7035ba0
commit 612eb78c9e
26 changed files with 156 additions and 160 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
www/apps/api-reference/specs/admin/paths/admin_customers.yaml
View File

@@ -12,7 +12,8 @@ get:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -21,7 +22,8 @@ get:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
@@ -4221,7 +4223,8 @@ post:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -4230,7 +4233,8 @@ post:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security:

12
www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml
View File

@@ -18,7 +18,8 @@ get:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -27,7 +28,8 @@ get:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security:
@@ -78,7 +80,8 @@ post:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -87,7 +90,8 @@ post:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security:

12
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml
View File

@@ -18,7 +18,8 @@ get:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -27,7 +28,8 @@ get:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
@@ -249,7 +251,8 @@ post:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -258,7 +261,8 @@ post:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security:

18
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml
View File

@@ -24,7 +24,8 @@ get:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -33,7 +34,8 @@ get:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security:
@@ -92,7 +94,8 @@ post:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -101,7 +104,8 @@ post:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security:
@@ -250,7 +254,8 @@ delete:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -259,7 +264,8 @@ delete:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security:

8
www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml
View File

@@ -13,12 +13,13 @@ post:
- name: fields
in: query
description: >-
Comma-separated fields that should be included in the returned data.
"Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields.
without prefix it will replace the entire default fields.
without prefix it will replace the entire default fields. NOTE: This
route doesn't allow expanding custom relations."
required: false
schema:
type: string
@@ -27,7 +28,8 @@ post:
Comma-separated fields that should be included in the returned data.
If a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. Without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security:

12
www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml
View File

@@ -13,7 +13,8 @@ get:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -22,7 +23,8 @@ get:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
@@ -677,7 +679,8 @@ post:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -686,7 +689,8 @@ post:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security:

12
www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml
View File

@@ -18,7 +18,8 @@ get:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -27,7 +28,8 @@ get:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
- name: include_ancestors_tree
@@ -118,7 +120,8 @@ post:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -127,7 +130,8 @@ post:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security:

6
www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml
View File

@@ -17,7 +17,8 @@ post:
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
replace the entire default fields. NOTE: This route doesn't allow
expanding custom relations.
required: false
schema:
type: string
@@ -26,7 +27,8 @@ post:
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
prefix it will replace the entire default fields. NOTE: This route
doesn't allow expanding custom relations.
externalDocs:
url: '#select-fields-and-relations'
security: