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 0c85e980ce..4ccddce667 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml @@ -1,8 +1,9 @@ type: object +description: SUMMARY +x-schemaName: AdminPostCancelReturnReqSchema required: - return_id - internal_note -x-schemaName: AdminPostCancelReturnReqSchema properties: return_id: type: string diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 0646ffce9a..19c8033311 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -6876,18 +6876,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. @@ -6969,8 +6963,6 @@ paths: tags: - Notifications responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -7006,18 +6998,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. @@ -7055,8 +7041,6 @@ paths: tags: - Notifications responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -25684,18 +25668,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. @@ -32469,18 +32447,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. @@ -32523,8 +32495,6 @@ paths: tags: - Returns responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -32566,18 +32536,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. @@ -32620,8 +32584,6 @@ paths: tags: - Returns responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -32662,18 +32624,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. @@ -32711,8 +32667,6 @@ paths: tags: - Returns responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -32843,18 +32797,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. @@ -32892,8 +32840,6 @@ paths: tags: - Returns responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -32929,18 +32875,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. @@ -32983,8 +32923,6 @@ paths: tags: - Returns responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -33026,18 +32964,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. @@ -33080,8 +33012,6 @@ paths: tags: - Returns responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -33122,18 +33052,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. @@ -33171,8 +33095,6 @@ paths: tags: - Returns responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -33208,18 +33130,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. @@ -33262,8 +33178,6 @@ paths: tags: - Returns responses: - '200': - description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -41664,10 +41578,11 @@ components: description: The order's metadata. AdminPostCancelReturnReqSchema: type: object + description: SUMMARY + x-schemaName: AdminPostCancelReturnReqSchema required: - return_id - internal_note - x-schemaName: AdminPostCancelReturnReqSchema properties: return_id: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml index 4bcec8267d..cbf87b01ac 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml @@ -18,18 +18,20 @@ get: 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. @@ -115,8 +117,6 @@ get: tags: - Notifications responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml index 8ced732f89..d5f5674561 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml @@ -24,18 +24,20 @@ get: 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. @@ -77,8 +79,6 @@ get: tags: - Notifications responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml index b4399fca01..a9970840be 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_export.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_export.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/admin/paths/admin_returns_{id}_dismiss-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml index 6e21c786d3..c642e7a29e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items.yaml @@ -22,18 +22,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. @@ -80,8 +82,6 @@ post: tags: - Returns responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml index be34c0078d..223759f1af 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_dismiss-items_{action_id}.yaml @@ -28,18 +28,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. @@ -88,8 +90,6 @@ post: tags: - Returns responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -134,18 +134,20 @@ delete: 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. @@ -188,8 +190,6 @@ delete: tags: - Returns responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml index 49c4727024..44ef212554 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items.yaml @@ -22,18 +22,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. @@ -80,8 +82,6 @@ post: tags: - Returns responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml index 33694a125d..ee12ae986c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive-items_{action_id}.yaml @@ -28,18 +28,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. @@ -88,8 +90,6 @@ post: tags: - Returns responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -134,18 +134,20 @@ delete: 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. @@ -188,8 +190,6 @@ delete: tags: - Returns responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml index 4631e576d2..f0f7669c0d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml @@ -120,18 +120,20 @@ delete: 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. @@ -173,8 +175,6 @@ delete: tags: - Returns responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml index 8910055b72..b554050bb6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive_confirm.yaml @@ -22,18 +22,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. @@ -80,8 +82,6 @@ post: tags: - Returns responses: - '200': - description: OK '400': $ref: ../components/responses/400_error.yaml '401': 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 0c85e980ce..4ccddce667 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostCancelReturnReqSchema.yaml @@ -1,8 +1,9 @@ type: object +description: SUMMARY +x-schemaName: AdminPostCancelReturnReqSchema required: - return_id - internal_note -x-schemaName: AdminPostCancelReturnReqSchema properties: return_id: type: string diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index a231414e57..0fbed33194 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -5582,10 +5582,11 @@ components: description: The order's metadata. AdminPostCancelReturnReqSchema: type: object + description: SUMMARY + x-schemaName: AdminPostCancelReturnReqSchema required: - return_id - internal_note - x-schemaName: AdminPostCancelReturnReqSchema properties: return_id: type: string diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts index 2e9ca8a43f..5e77d27adc 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts @@ -29,18 +29,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. @@ -84,8 +84,6 @@ * tags: * - Returns * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts index 3e4e8ffdbb..7518e0f371 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts @@ -29,18 +29,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. @@ -84,8 +84,6 @@ * tags: * - Returns * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts index f62d9f1eec..5fb9becb8f 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts @@ -22,18 +22,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. @@ -75,8 +75,6 @@ * tags: * - Returns * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts index 10d7eb9ec7..d19cffce38 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts @@ -16,18 +16,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. @@ -113,8 +113,6 @@ * tags: * - Notifications * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts index fa59fd1fac..f054ecfa6c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts @@ -22,18 +22,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. @@ -75,8 +75,6 @@ * tags: * - Notifications * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts index 3e5e404e5b..75d3abe39e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.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/operations/admin/post_admin_returns_[id]_dismiss-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts index c550caa921..70f8f87b99 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts @@ -21,18 +21,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. @@ -79,8 +79,6 @@ * tags: * - Returns * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts index c9f18b3217..34e7aa1c17 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts @@ -27,18 +27,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. @@ -87,8 +87,6 @@ * tags: * - Returns * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts index 0f609697e7..adde722603 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts @@ -21,18 +21,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. @@ -79,8 +79,6 @@ * tags: * - Returns * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts index d58e325e13..dd07098d73 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts @@ -27,18 +27,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. @@ -87,8 +87,6 @@ * tags: * - Returns * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts index 5183b540a9..a476e3ec81 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts @@ -21,18 +21,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. @@ -79,8 +79,6 @@ * tags: * - Returns * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts index cf306839a8..ea1dbe5e53 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostCancelReturnReqSchema.ts @@ -1,10 +1,11 @@ /** * @schema AdminPostCancelReturnReqSchema * type: object + * description: SUMMARY + * x-schemaName: AdminPostCancelReturnReqSchema * required: * - return_id * - internal_note - * x-schemaName: AdminPostCancelReturnReqSchema * properties: * return_id: * type: string