chore(oas): clean up oas (#9354)

* clean up generated oas * fix issues in docs-util * more fixes * align max level * validation fix * add missing summaries * fix validation * fix exchanges route
medusajs · Oct 2, 2024 · 1fe336a · 1fe336a
1 parent 968c5d9
commit 1fe336a
Show file tree

Hide file tree

Showing 83 changed files with 2,693 additions and 624 deletions.
diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts
@@ -31,7 +31,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts
@@ -31,7 +31,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts
@@ -31,7 +31,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts
@@ -30,7 +30,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/...nerated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/...nerated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts
@@ -53,7 +53,7 @@
  *         schema:
  *           allOf:
  *             - type: object
- *               description: SUMMARY
+ *               description: The deletion's details.
  *               required:
  *                 - id
  *                 - object
@@ -72,11 +72,11 @@
  *                   title: deleted
  *                   description: Whether the Customer was deleted.
  *             - type: object
- *               description: SUMMARY
+ *               description: The deletion's details.
  *               properties:
  *                 parent:
  *                   $ref: "#/components/schemas/AdminCustomer"
- *           description: SUMMARY
+ *           description: The deletion's details.
  *   "400":
  *     $ref: "#/components/responses/400_error"
  *   "401":

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts
@@ -30,7 +30,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/...utput/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts b/...utput/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts
@@ -57,7 +57,7 @@
  *         schema:
  *           allOf:
  *             - type: object
- *               description: SUMMARY
+ *               description: The deletion's details.
  *               required:
  *                 - id
  *                 - object
@@ -76,11 +76,11 @@
  *                   title: deleted
  *                   description: Whether the Inventory Item was deleted.
  *             - type: object
- *               description: SUMMARY
+ *               description: The deletion's details.
  *               properties:
  *                 parent:
  *                   $ref: "#/components/schemas/AdminInventoryItem"
- *           description: SUMMARY
+ *           description: The deletion's details.
  *   "400":
  *     $ref: "#/components/responses/400_error"
  *   "401":

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts
@@ -24,7 +24,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts
@@ -30,7 +30,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts
@@ -30,7 +30,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts
@@ -30,7 +30,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts
@@ -30,7 +30,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts
@@ -30,7 +30,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

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
@@ -30,7 +30,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts
@@ -30,7 +30,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/...tils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts b/...tils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts
@@ -56,7 +56,7 @@
  *         schema:
  *           allOf:
  *             - type: object
- *               description: SUMMARY
+ *               description: The deletion's details.
  *               required:
  *                 - id
  *                 - object
@@ -75,11 +75,11 @@
  *                   title: deleted
  *                   description: Whether the Tax Rate was deleted.
  *             - type: object
- *               description: SUMMARY
+ *               description: The deletion's details.
  *               properties:
  *                 parent:
  *                   $ref: "#/components/schemas/AdminTaxRate"
- *           description: SUMMARY
+ *           description: The deletion's details.
  *   "400":
  *     $ref: "#/components/responses/400_error"
  *   "401":

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts
@@ -30,7 +30,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - id
  *             - object

diff --git a/www/utils/generated/oas-output/operations/admin/delete_auth_session.ts b/www/utils/generated/oas-output/operations/admin/delete_auth_session.ts
@@ -19,7 +19,7 @@
  *       application/json:
  *         schema:
  *           type: object
- *           description: SUMMARY
+ *           description: The deletion's details.
  *           required:
  *             - success
  *           properties:

diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts
@@ -845,7 +845,7 @@
  *         schema:
  *           allOf:
  *             - type: object
- *               description: SUMMARY
+ *               description: The paginated list of customer groups.
  *               required:
  *                 - limit
  *                 - offset
@@ -854,23 +854,23 @@
  *                 limit:
  *                   type: number
  *                   title: limit
- *                   description: The customer group's limit.
+ *                   description: The maximum number of items retrieved.
  *                 offset:
  *                   type: number
  *                   title: offset
- *                   description: The customer group's offset.
+ *                   description: The number of items skipped before retrieving the returned items.
  *                 count:
  *                   type: number
  *                   title: count
- *                   description: The customer group's count.
+ *                   description: The total number of items
  *             - type: object
- *               description: SUMMARY
+ *               description: The paginated list of customer groups.
  *               required:
  *                 - customer_groups
  *               properties:
  *                 customer_groups:
  *                   type: array
- *                   description: The customer group's customer groups.
+ *                   description: The list of customer groups.
  *                   items:
  *                     $ref: "#/components/schemas/AdminCustomerGroup"
  *   "400":

diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts
@@ -1467,7 +1467,7 @@
  *         schema:
  *           allOf:
  *             - type: object
- *               description: SUMMARY
+ *               description: The paginated list of draft orders.
  *               required:
  *                 - limit
  *                 - offset
@@ -1476,17 +1476,17 @@
  *                 limit:
  *                   type: number
  *                   title: limit
- *                   description: The draft order's limit.
+ *                   description: The maximum number of items returned.
  *                 offset:
  *                   type: number
  *                   title: offset
- *                   description: The draft order's offset.
+ *                   description: The number of items skipped before retrieving the returned items.
  *                 count:
  *                   type: number
  *                   title: count
- *                   description: The draft order's count.
+ *                   description: The total number of items.
  *             - type: object
- *               description: SUMMARY
+ *               description: The paginated list of draft orders.
  *               required:
  *                 - draft_orders
  *               properties:

diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts
@@ -830,7 +830,7 @@
  *         schema:
  *           allOf:
  *             - type: object
- *               description: SUMMARY
+ *               description: The paginated list of exchanges.
  *               required:
  *                 - limit
  *                 - offset
@@ -839,22 +839,25 @@
  *                 limit:
  *                   type: number
  *                   title: limit
- *                   description: The exchange's limit.
+ *                   description: The maximum number of items returned.
  *                 offset:
  *                   type: number
  *                   title: offset
- *                   description: The exchange's offset.
+ *                   description: The number of items skipped before retrieving the returned items.
  *                 count:
  *                   type: number
  *                   title: count
- *                   description: The exchange's count.
+ *                   description: The total number of items.
  *             - type: object
- *               description: SUMMARY
+ *               description: The paginated list of exchanges.
  *               required:
  *                 - exchanges
  *               properties:
  *                 exchanges:
- *                   $ref: "#/components/schemas/AdminExchange"
+ *                   type: array
+ *                   description: The exchange's exchanges.
+ *                   items:
+ *                     $ref: "#/components/schemas/AdminExchange"
  *   "400":
  *     $ref: "#/components/responses/400_error"
  *   "401":

diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts
@@ -402,7 +402,7 @@
  *         schema:
  *           allOf:
  *             - type: object
- *               description: SUMMARY
+ *               description: The paginated list of inventory items.
  *               required:
  *                 - limit
  *                 - offset
@@ -411,17 +411,17 @@
  *                 limit:
  *                   type: number
  *                   title: limit
- *                   description: The inventory item's limit.
+ *                   description: The maximum number of items returned.
  *                 offset:
  *                   type: number
  *                   title: offset
- *                   description: The inventory item's offset.
+ *                   description: The number of items skipped before retrieving the returned items.
  *                 count:
  *                   type: number
  *                   title: count
- *                   description: The inventory item's count.
+ *                   description: The total number of items.
  *             - type: object
- *               description: SUMMARY
+ *               description: The paginated list of inventory items.
  *               required:
  *                 - inventory_items
  *               properties:

diff --git a/...s/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts b/...s/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts
@@ -105,7 +105,7 @@
  *         schema:
  *           allOf:
  *             - type: object
- *               description: SUMMARY
+ *               description: The paginated list of inventory levels.
  *               required:
  *                 - limit
  *                 - offset
@@ -114,17 +114,17 @@
  *                 limit:
  *                   type: number
  *                   title: limit
- *                   description: The inventory item's limit.
+ *                   description: The maximum number of items returned.
  *                 offset:
  *                   type: number
  *                   title: offset
- *                   description: The inventory item's offset.
+ *                   description: The number of items skipped before retrieving the returned items.
  *                 count:
  *                   type: number
  *                   title: count
- *                   description: The inventory item's count.
+ *                   description: The total number of items.
  *             - type: object
- *               description: SUMMARY
+ *               description: The paginated list of inventory levels.
  *               required:
  *                 - inventory_levels
  *               properties: