From 13855e9167d6f31602299f24ad191a9410ec9e9b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 25 Jul 2024 07:02:12 +0000 Subject: [PATCH] chore(docs): Updated API Reference (v2) (#8273) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action --- .../schemas/AdminPostCancelReturnReqSchema.yaml | 5 ----- .../api-reference/specs/admin/openapi.full.yaml | 15 ++------------- .../specs/admin/paths/admin_products_import.yaml | 16 +++++++++------- .../schemas/AdminPostCancelReturnReqSchema.yaml | 5 ----- .../api-reference/specs/store/openapi.full.yaml | 5 ----- .../admin/post_admin_products_import.ts | 16 ++++++++-------- .../schemas/AdminPostCancelReturnReqSchema.ts | 5 ----- 7 files changed, 19 insertions(+), 48 deletions(-) diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml index 4ccddce667..0fa1745dfd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml @@ -2,13 +2,8 @@ type: object description: SUMMARY x-schemaName: AdminPostCancelReturnReqSchema required: - - return_id - internal_note properties: - return_id: - type: string - title: return_id - description: The return's return id. no_notification: type: boolean title: no_notification diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 66fca0f0c1..04a3281d43 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -25751,18 +25751,12 @@ paths: description: Comma-separated relations that should be expanded in the returned data. - 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. 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. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -41685,13 +41679,8 @@ components: description: SUMMARY x-schemaName: AdminPostCancelReturnReqSchema required: - - return_id - internal_note properties: - return_id: - type: string - title: return_id - description: The return's return id. no_notification: type: boolean title: no_notification diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml index d305f2c96f..051d7ae3f9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml @@ -16,18 +16,20 @@ post: data. - 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. required: false schema: type: string title: fields - description: |- + 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. + 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. - name: offset in: query description: The number of items to skip when retrieving a list. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml index 4ccddce667..0fa1745dfd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml @@ -2,13 +2,8 @@ type: object description: SUMMARY x-schemaName: AdminPostCancelReturnReqSchema required: - - return_id - internal_note properties: - return_id: - type: string - title: return_id - description: The return's return id. no_notification: type: boolean title: no_notification diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index be120c372a..5fb28f59ae 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -5600,13 +5600,8 @@ components: description: SUMMARY x-schemaName: AdminPostCancelReturnReqSchema required: - - return_id - internal_note properties: - return_id: - type: string - title: return_id - description: The return's return id. no_notification: type: boolean title: no_notification diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts index 6554140535..661d1bd185 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts @@ -15,18 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - 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. * 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. * - name: offset * in: query * description: The number of items to skip when retrieving a list. diff --git a/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts index ea1dbe5e53..1826a6ea2f 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts @@ -4,13 +4,8 @@ * description: SUMMARY * x-schemaName: AdminPostCancelReturnReqSchema * required: - * - return_id * - internal_note * properties: - * return_id: - * type: string - * title: return_id - * description: The return's return id. * no_notification: * type: boolean * title: no_notification