chore(docs): Generated API Reference (#4706)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

docs/api/admin/paths/admin_orders.yaml

@@ -1,26 +1,28 @@
 get:
   operationId: GetOrders
   summary: List Orders
-  description: Retrieves a list of Orders
+  description: >-
+    Retrieve a list of Orders. The orders can be filtered by fields such as
+    `status` or `display_id`. The order can also be paginated.
   x-authenticated: true
   parameters:
     - in: query
       name: q
       description: >-
-        Query used for searching orders by shipping address first name, orders'
-        email, and orders' display ID
+        term to search orders' shipping address, first name, email, and display
+        ID
       schema:
         type: string
     - in: query
       name: id
-      description: ID of the order to search for.
+      description: Filter by ID.
       schema:
         type: string
     - in: query
       name: status
       style: form
       explode: false
-      description: Status to search for
+      description: Filter by status
       schema:
         type: array
         items:
@@ -35,7 +37,7 @@ get:
       name: fulfillment_status
       style: form
       explode: false
-      description: Fulfillment status to search for.
+      description: Filter by fulfillment status
       schema:
         type: array
         items:
@@ -54,7 +56,7 @@ get:
       name: payment_status
       style: form
       explode: false
-      description: Payment status to search for.
+      description: Filter by payment status
       schema:
         type: array
         items:
@@ -69,29 +71,29 @@ get:
             - requires_action
     - in: query
       name: display_id
-      description: Display ID to search for.
+      description: Filter by display ID
       schema:
         type: string
     - in: query
       name: cart_id
-      description: to search for.
+      description: Filter by cart ID
       schema:
         type: string
     - in: query
       name: customer_id
-      description: to search for.
+      description: Filter by customer ID
       schema:
         type: string
     - in: query
       name: email
-      description: to search for.
+      description: Filter by email
       schema:
         type: string
     - in: query
       name: region_id
       style: form
       explode: false
-      description: Regions to search orders by
+      description: Filter by region IDs.
       schema:
         oneOf:
           - type: string
@@ -104,7 +106,7 @@ get:
       name: currency_code
       style: form
       explode: false
-      description: Currency code to search for
+      description: Filter by currency codes.
       schema:
         type: string
         externalDocs:
@@ -112,12 +114,12 @@ get:
           description: See a list of codes.
     - in: query
       name: tax_rate
-      description: to search for.
+      description: Filter by tax rate.
       schema:
         type: string
     - in: query
       name: created_at
-      description: Date comparison for when resulting orders were created.
+      description: Filter by a creation date range.
       schema:
         type: object
         properties:
@@ -139,7 +141,7 @@ get:
             format: date
     - in: query
       name: updated_at
-      description: Date comparison for when resulting orders were updated.
+      description: Filter by an update date range.
       schema:
         type: object
         properties:
@@ -161,7 +163,7 @@ get:
             format: date
     - in: query
       name: canceled_at
-      description: Date comparison for when resulting orders were canceled.
+      description: Filter by a cancelation date range.
       schema:
         type: object
         properties:
@@ -185,7 +187,7 @@ get:
       name: sales_channel_id
       style: form
       explode: false
-      description: Filter by Sales Channels
+      description: Filter by Sales Channel IDs
       schema:
         type: array
         items:
@@ -193,7 +195,7 @@ get:
           description: The ID of a Sales Channel
     - in: query
       name: offset
-      description: How many orders to skip before the results.
+      description: The number of orders to skip when retrieving the orders.
       schema:
         type: integer
         default: 0
@@ -205,16 +207,12 @@ get:
         default: 50
     - in: query
       name: expand
-      description: >-
-        (Comma separated) Which fields should be expanded in each order of the
-        result.
+      description: Comma-separated relations that should be expanded in the returned order.
       schema:
         type: string
     - in: query
       name: fields
-      description: >-
-        (Comma separated) Which fields should be included in each order of the
-        result.
+      description: Comma-separated fields that should be included in the returned order.
       schema:
         type: string
   x-codegen: