Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(oas): clean up oas #9354

Merged
merged 8 commits into from
Oct 2, 2024
Merged

chore(oas): clean up oas #9354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1745725
clean up generated oas
shahednasser Sep 27, 2024
864eade
fix issues in docs-util
shahednasser Sep 27, 2024
ff36368
more fixes
shahednasser Sep 27, 2024
5918e1f
align max level
shahednasser Sep 27, 2024
8528bb5
validation fix
shahednasser Sep 27, 2024
3942d9b
add missing summaries
shahednasser Sep 27, 2024
4c9dc82
fix validation
shahednasser Sep 27, 2024
1bcdc4f
fix exchanges route
shahednasser Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
6 changes: 3 additions & 3 deletions ...nerated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand All @@ -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":
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
6 changes: 3 additions & 3 deletions ...utput/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand All @@ -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":
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
6 changes: 3 additions & 3 deletions ...tils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand All @@ -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":
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - id
* - object
Expand Down
2 changes: 1 addition & 1 deletion www/utils/generated/oas-output/operations/admin/delete_auth_session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* application/json:
* schema:
* type: object
* description: SUMMARY
* description: The deletion's details.
* required:
* - success
* properties:
Expand Down
12 changes: 6 additions & 6 deletions www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -845,7 +845,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of customer groups.
* required:
* - limit
* - offset
Expand All @@ -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":
Expand Down
10 changes: 5 additions & 5 deletions www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1467,7 +1467,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of draft orders.
* required:
* - limit
* - offset
Expand All @@ -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:
Expand Down
15 changes: 9 additions & 6 deletions www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -830,7 +830,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of exchanges.
* required:
* - limit
* - offset
Expand All @@ -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":
Expand Down
10 changes: 5 additions & 5 deletions www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of inventory items.
* required:
* - limit
* - offset
Expand All @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions ...s/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
* schema:
* allOf:
* - type: object
* description: SUMMARY
* description: The paginated list of inventory levels.
* required:
* - limit
* - offset
Expand All @@ -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:
Expand Down
Loading
Loading