From 612eb78c9e245670ae8e35c7c9fee66a104ea4a0 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 16 Dec 2024 18:46:57 +0200 Subject: [PATCH] docs: fix expanding of custom relations in customer and product category routes (#10620) --- .../specs/admin/openapi.full.yaml | 62 +++++++++---------- .../specs/admin/paths/admin_customers.yaml | 12 ++-- .../admin/paths/admin_customers_{id}.yaml | 12 ++-- .../paths/admin_customers_{id}_addresses.yaml | 12 ++-- ...customers_{id}_addresses_{address_id}.yaml | 18 ++++-- .../admin_customers_{id}_customer-groups.yaml | 8 ++- .../admin/paths/admin_product-categories.yaml | 12 ++-- .../paths/admin_product-categories_{id}.yaml | 12 ++-- ...dmin_product-categories_{id}_products.yaml | 6 +- .../commerce-modules/customer/extend/page.mdx | 40 +----------- www/apps/resources/generated/edit-dates.mjs | 2 +- ...n_customers_[id]_addresses_[address_id].ts | 8 +-- .../operations/admin/get_admin_customers.ts | 8 +-- .../admin/get_admin_customers_[id].ts | 8 +-- .../get_admin_customers_[id]_addresses.ts | 8 +-- ...n_customers_[id]_addresses_[address_id].ts | 8 +-- .../admin/get_admin_product-categories.ts | 8 +-- .../get_admin_product-categories_[id].ts | 8 +-- .../operations/admin/post_admin_customers.ts | 8 +-- .../admin/post_admin_customers_[id].ts | 8 +-- .../post_admin_customers_[id]_addresses.ts | 8 +-- ...n_customers_[id]_addresses_[address_id].ts | 8 +-- ...st_admin_customers_[id]_customer-groups.ts | 8 +-- .../admin/post_admin_product-categories.ts | 8 +-- .../post_admin_product-categories_[id].ts | 8 +-- ..._admin_product-categories_[id]_products.ts | 8 +-- 26 files changed, 156 insertions(+), 160 deletions(-) diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index c4ecd80919..50cc874694 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -7055,12 +7055,12 @@ paths: parameters: - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' - name: offset @@ -10440,12 +10440,12 @@ paths: parameters: - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: @@ -10550,12 +10550,12 @@ paths: type: string - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: @@ -10603,12 +10603,12 @@ paths: type: string - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: @@ -10775,12 +10775,12 @@ paths: type: string - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' - name: offset @@ -10984,12 +10984,12 @@ paths: type: string - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: @@ -11143,12 +11143,12 @@ paths: type: string - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: @@ -11203,12 +11203,12 @@ paths: type: string - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: @@ -11361,12 +11361,12 @@ paths: type: string - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: @@ -11440,14 +11440,14 @@ paths: - 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 title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: @@ -23013,12 +23013,12 @@ paths: parameters: - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' - name: offset @@ -23573,12 +23573,12 @@ paths: parameters: - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: @@ -23639,12 +23639,12 @@ paths: type: string - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' - name: include_ancestors_tree @@ -23708,12 +23708,12 @@ paths: type: string - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: @@ -23851,12 +23851,12 @@ paths: type: string - name: fields in: query - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' required: false schema: type: string title: fields - description: 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. + description: '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. NOTE: This route doesn''t allow expanding custom relations.' externalDocs: url: '#select-fields-and-relations' security: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml index 56b843709e..50f04aa9ee 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -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: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml index ec15ac6487..c686997d37 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml @@ -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: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml index 435cbf4822..d64c964009 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml @@ -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: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml index 39ce8fc8b9..22572340ed 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml @@ -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: diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml index 6e0fef0e9f..86249aa9c9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_customer-groups.yaml @@ -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: diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index 9a994d1912..786f1642bf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml @@ -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: diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml index 28aa904ff7..a7c21529a0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml @@ -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: diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml index 2a964233e0..03d9ecd0bf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml @@ -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: diff --git a/www/apps/resources/app/commerce-modules/customer/extend/page.mdx b/www/apps/resources/app/commerce-modules/customer/extend/page.mdx index 3a4b7941f5..a511077780 100644 --- a/www/apps/resources/app/commerce-modules/customer/extend/page.mdx +++ b/www/apps/resources/app/commerce-modules/customer/extend/page.mdx @@ -329,43 +329,7 @@ The request will return the customer's details. You'll learn how to retrieve the When you extend an existing data model through links, you also want to retrieve the custom properties with the data model. -### Retrieve in API Routes - -To retrieve the `custom_name` property when you're retrieving the customer through API routes, such as the [Get Customer API Route](!api!/admin#customers_getcustomersid), pass in the `fields` query parameter `+custom.*`, which retrieves the linked `Custom` record's details. - - - -The `+` prefix in `+custom.*` indicates that the relation should be retrieved with the default customer fields. Learn more about selecting fields and relations in the [API reference](!api!/admin#select-fields-and-relations). - - - -For example: - -```bash -curl 'localhost:9000/admin/customers/{customer_id}?fields=+custom.*' \ --H 'Authorization: Bearer {token}' -``` - -Make sure to replace `{customer_id}` with the customer's ID, and `{token}` with an admin user's JWT token. - -Among the returned `customer` object, you'll find a `custom` property which holds the details of the linked `Custom` record: - -```json -{ - "customer": { - // ... - "custom": { - "id": "01J9NP7ANXDZ0EAYF0956ZE1ZA", - "custom_name": "test", - "created_at": "2024-10-08T09:09:06.877Z", - "updated_at": "2024-10-08T09:09:06.877Z", - "deleted_at": null - } - } -} -``` - -### Retrieve using Query +### Retrieve in API Routes using Query You can also retrieve the `Custom` record linked to a customer in your code using [Query](!docs!/learn/fundamentals/module-links/query). @@ -381,6 +345,8 @@ const { data: [customer] } = await query.graph({ }) ``` +You can use Query in a custom route to retrieve the customer with its linked `Custom` record. + Learn more about how to use Query in [this guide](!docs!/learn/fundamentals/module-links/query). --- diff --git a/www/apps/resources/generated/edit-dates.mjs b/www/apps/resources/generated/edit-dates.mjs index d3167cf270..3b768cff9e 100644 --- a/www/apps/resources/generated/edit-dates.mjs +++ b/www/apps/resources/generated/edit-dates.mjs @@ -2182,7 +2182,7 @@ export const generatedEditDates = { "app/commerce-modules/api-key/links-to-other-modules/page.mdx": "2024-10-08T08:05:36.596Z", "app/commerce-modules/cart/extend/page.mdx": "2024-12-11T09:05:37.041Z", "app/commerce-modules/cart/links-to-other-modules/page.mdx": "2024-10-08T08:22:35.190Z", - "app/commerce-modules/customer/extend/page.mdx": "2024-12-11T09:05:35.368Z", + "app/commerce-modules/customer/extend/page.mdx": "2024-12-16T14:11:47.517Z", "app/commerce-modules/fulfillment/links-to-other-modules/page.mdx": "2024-10-08T14:58:24.935Z", "app/commerce-modules/inventory/links-to-other-modules/page.mdx": "2024-10-08T15:18:30.109Z", "app/commerce-modules/pricing/links-to-other-modules/page.mdx": "2024-10-09T13:51:49.986Z", diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts index e1865fc484..597f33b33c 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts @@ -19,14 +19,14 @@ * type: string * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts index 20d9adc48f..15377f04e3 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts @@ -7,14 +7,14 @@ * parameters: * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * - name: offset diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts index dfd494229d..0e3f54ba86 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts @@ -13,14 +13,14 @@ * type: string * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts index fecc914fc1..29c40a4d04 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts @@ -13,14 +13,14 @@ * type: string * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * - name: offset diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts index be0ca6068b..24683b61cc 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts @@ -19,14 +19,14 @@ * type: string * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts index 36c7b2ca93..fc06cf312c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts @@ -7,14 +7,14 @@ * parameters: * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * - name: offset diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts index 955422f37a..588d2fdc37 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts @@ -13,14 +13,14 @@ * type: string * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * - name: include_ancestors_tree diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts index 391333792a..0ceddd0ffa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts @@ -7,14 +7,14 @@ * parameters: * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts index e22719c07e..3782cc7789 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts @@ -13,14 +13,14 @@ * type: string * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts index bcd78414fe..ce210fc49a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts @@ -14,14 +14,14 @@ * type: string * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts index 3c169622a1..a594f168d4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts @@ -20,14 +20,14 @@ * type: string * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts index 2bb2e28547..64d5218a81 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_customer-groups.ts @@ -14,15 +14,15 @@ * - 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 * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts index b8410af5d5..e7283bce9f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts @@ -7,14 +7,14 @@ * parameters: * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts index 11879a39ba..5f6812aaab 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts @@ -13,14 +13,14 @@ * type: string * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts index 2a73925914..71b819f272 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts @@ -14,14 +14,14 @@ * type: string * - name: fields * in: query - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * required: false * schema: * type: string * title: fields - * description: 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. + * description: "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. NOTE: This route doesn't allow expanding custom relations." * externalDocs: * url: "#select-fields-and-relations" * security: