chore(docs): Updated API Reference (v2) (#8714)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

www/apps/api-reference/specs/admin/code_samples/Shell/admin_order-edits_{id}_request/post.sh

@@ -0,0 +1,2 @@
+curl -X POST '{backend_url}/admin/order-edits/{id}/request' \
+-H 'x-medusa-access-token: {api_token}'

www/apps/api-reference/specs/admin/openapi.full.yaml

@@ -12485,6 +12485,97 @@ paths:
         '500':
           $ref: '#/components/responses/500_error'
       x-workflow: removeItemOrderEditActionWorkflow
+  /admin/order-edits/{id}/request:
+    post:
+      operationId: PostOrderEditsIdRequest
+      summary: Add Requests to Order Edit
+      description: Add a list of requests to a order edit.
+      x-authenticated: true
+      parameters:
+        - name: id
+          in: path
+          description: The order edit's ID.
+          required: true
+          schema:
+            type: string
+        - name: expand
+          in: query
+          description: Comma-separated relations that should be expanded in the returned data.
+          required: false
+          schema:
+            type: string
+            title: expand
+            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.
+          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.
+        - name: offset
+          in: query
+          description: The number of items to skip when retrieving a list.
+          required: false
+          schema:
+            type: number
+            title: offset
+            description: The number of items to skip when retrieving a list.
+        - name: limit
+          in: query
+          description: Limit the number of items returned in the list.
+          required: false
+          schema:
+            type: number
+            title: limit
+            description: Limit the number of items returned in the list.
+        - name: order
+          in: query
+          description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
+          required: false
+          schema:
+            type: string
+            title: order
+            description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
+      security:
+        - api_token: []
+        - cookie_auth: []
+        - jwt_token: []
+      x-codeSamples:
+        - lang: Shell
+          label: cURL
+          source: |-
+            curl -X POST '{backend_url}/admin/order-edits/{id}/request' \
+            -H 'x-medusa-access-token: {api_token}'
+      tags:
+        - Order Edits
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AdminOrderEditPreviewResponse'
+        '400':
+          $ref: '#/components/responses/400_error'
+        '401':
+          $ref: '#/components/responses/unauthorized'
+        '404':
+          $ref: '#/components/responses/not_found_error'
+        '409':
+          $ref: '#/components/responses/invalid_state_error'
+        '422':
+          $ref: '#/components/responses/invalid_request_error'
+        '500':
+          $ref: '#/components/responses/500_error'
+      x-workflow: requestOrderEditRequestWorkflow
   /admin/order-edits/{id}/shipping-method:
     post:
       operationId: PostOrderEditsIdShippingMethod
@@ -13959,18 +14050,12 @@ paths:
             description: Comma-separated relations that should be expanded in the returned data.
         - name: fields
           in: query
-          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.
-            Comma-separated fields that should be included in the returned data.
-             * if a field is prefixed with `+` it 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.
-              Comma-separated fields that should be included in the returned data.
-               * if a field is prefixed with `+` it 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.
@@ -14070,18 +14155,12 @@ paths:
             description: Comma-separated relations that should be expanded in the returned data.
         - name: fields
           in: query
-          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.
-            Comma-separated fields that should be included in the returned data.
-             * if a field is prefixed with `+` it 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.
-              Comma-separated fields that should be included in the returned data.
-               * if a field is prefixed with `+` it 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.

www/apps/api-reference/specs/admin/openapi.yaml

@@ -301,6 +301,8 @@ paths:
     $ref: paths/admin_order-edits_{id}_items_item_{item_id}.yaml
   /admin/order-edits/{id}/items/{action_id}:
     $ref: paths/admin_order-edits_{id}_items_{action_id}.yaml
+  /admin/order-edits/{id}/request:
+    $ref: paths/admin_order-edits_{id}_request.yaml
   /admin/order-edits/{id}/shipping-method:
     $ref: paths/admin_order-edits_{id}_shipping-method.yaml
   /admin/order-edits/{id}/shipping-method/{action_id}:

www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml

@@ -0,0 +1,96 @@
+post:
+  operationId: PostOrderEditsIdRequest
+  summary: Add Requests to Order Edit
+  description: Add a list of requests to a order edit.
+  x-authenticated: true
+  parameters:
+    - name: id
+      in: path
+      description: The order edit's ID.
+      required: true
+      schema:
+        type: string
+    - name: expand
+      in: query
+      description: Comma-separated relations that should be expanded in the returned data.
+      required: false
+      schema:
+        type: string
+        title: expand
+        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.
+      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.
+    - name: offset
+      in: query
+      description: The number of items to skip when retrieving a list.
+      required: false
+      schema:
+        type: number
+        title: offset
+        description: The number of items to skip when retrieving a list.
+    - name: limit
+      in: query
+      description: Limit the number of items returned in the list.
+      required: false
+      schema:
+        type: number
+        title: limit
+        description: Limit the number of items returned in the list.
+    - name: order
+      in: query
+      description: >-
+        The field to sort the data by. By default, the sort order is ascending.
+        To change the order to descending, prefix the field name with `-`.
+      required: false
+      schema:
+        type: string
+        title: order
+        description: >-
+          The field to sort the data by. By default, the sort order is
+          ascending. To change the order to descending, prefix the field name
+          with `-`.
+  security:
+    - api_token: []
+    - cookie_auth: []
+    - jwt_token: []
+  x-codeSamples:
+    - lang: Shell
+      label: cURL
+      source:
+        $ref: ../code_samples/Shell/admin_order-edits_{id}_request/post.sh
+  tags:
+    - Order Edits
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/AdminOrderEditPreviewResponse.yaml
+    '400':
+      $ref: ../components/responses/400_error.yaml
+    '401':
+      $ref: ../components/responses/unauthorized.yaml
+    '404':
+      $ref: ../components/responses/not_found_error.yaml
+    '409':
+      $ref: ../components/responses/invalid_state_error.yaml
+    '422':
+      $ref: ../components/responses/invalid_request_error.yaml
+    '500':
+      $ref: ../components/responses/500_error.yaml
+  x-workflow: requestOrderEditRequestWorkflow

www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml

@@ -22,18 +22,20 @@ delete:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire 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.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          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.

www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml

@@ -22,18 +22,20 @@ post:
           data.
     - name: fields
       in: query
-      description: |-
+      description: >-
-        Comma-separated fields that should be included in the returned data.
+        Comma-separated fields that should be included in the returned data. if
-         * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+        a field is prefixed with `+` it will be added to the default fields,
-         * without prefix it will replace the entire 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.
+          if a field is prefixed with `+` it will be added to the default
-           * without prefix it will replace the entire default fields.
+          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.

www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts

@@ -21,18 +21,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       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
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.

www/utils/generated/oas-output/operations/admin/post_admin_order-edits_[id]_request.ts

@@ -0,0 +1,98 @@
+/**
+ * @oas [post] /admin/order-edits/{id}/request
+ * operationId: PostOrderEditsIdRequest
+ * summary: Add Requests to Order Edit
+ * description: Add a list of requests to a order edit.
+ * x-authenticated: true
+ * parameters:
+ *   - name: id
+ *     in: path
+ *     description: The order edit's ID.
+ *     required: true
+ *     schema:
+ *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       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.
+ *     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.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: The field to sort the data by. By default, the sort order is
+ *       ascending. To change the order to descending, prefix the field name with
+ *       `-`.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: The field to sort the data by. By default, the sort order is
+ *         ascending. To change the order to descending, prefix the field name with
+ *         `-`.
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ *   - jwt_token: []
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: |-
+ *       curl -X POST '{backend_url}/admin/order-edits/{id}/request' \
+ *       -H 'x-medusa-access-token: {api_token}'
+ * tags:
+ *   - Order Edits
+ * responses:
+ *   "200":
+ *     description: OK
+ *     content:
+ *       application/json:
+ *         schema:
+ *           $ref: "#/components/schemas/AdminOrderEditPreviewResponse"
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * x-workflow: requestOrderEditRequestWorkflow
+ * 
+*/
+

www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts

@@ -21,18 +21,18 @@
  *       description: Comma-separated relations that should be expanded in the returned data.
  *   - name: fields
  *     in: query
- *     description: >-
+ *     description: Comma-separated fields that should be included in the returned
- *       Comma-separated fields that should be included in the returned data.
+ *       data. if a field is prefixed with `+` it will be added to the default
- *        * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *       fields, using `-` will remove it from the default fields. without prefix
- *        * without prefix it will replace the entire default fields.
+ *       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
- *         Comma-separated fields that should be included in the returned data.
+ *         data. if a field is prefixed with `+` it will be added to the default
- *          * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
+ *         fields, using `-` will remove it from the default fields. without prefix
- *          * without prefix it will replace the entire default fields.
+ *         it will replace the entire default fields.
  *   - name: offset
  *     in: query
  *     description: The number of items to skip when retrieving a list.