asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(oas): improvements to examples and descriptions (#4545)

Browse Source 
* improve curl examples in OAS

* update tags

* fix oas errors

* update tags and their descriptions

* updated oas of endpoints

* improved oas of all admin endpoints

* improved store OAS comments

* improved models OAS comments

* small change
This commit is contained in:
Shahed Nasser
2023-07-26 20:13:44 +03:00
committed by GitHub
parent caea44ebfd
commit 8a1aac028e
831 changed files with 5871 additions and 4324 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/medusa/src/models/draft-order.ts
+7 -5
View File
@@ -81,7 +81,7 @@ export class DraftOrder extends BaseEntity {
/**
* @schema DraftOrder
* title: "DraftOrder"
* description: "Represents a draft order"
* description: "A draft order is created by an admin without direct involvement of the customer. Once its payment is marked as captured, it is transformed into an order."
* type: object
* required:
* - canceled_at
@@ -102,7 +102,7 @@ export class DraftOrder extends BaseEntity {
* type: string
* example: dorder_01G8TJFKBG38YYFQ035MSVG03C
* status:
* description: The status of the draft order
* description: The status of the draft order. It's changed to `completed` when it's transformed to an order.
* type: string
* enum:
* - open
@@ -118,16 +118,18 @@ export class DraftOrder extends BaseEntity {
* type: string
* example: cart_01G8ZH853Y6TFXWPG5EYE81X63
* cart:
* description: A cart object. Available if the relation `cart` is expanded.
* description: The details of the cart associated with the draft order.
* x-expandable: "cart"
* nullable: true
* $ref: "#/components/schemas/Cart"
* order_id:
* description: The ID of the order associated with the draft order.
* description: The ID of the order created from the draft order when its payment is captured.
* nullable: true
* type: string
* example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
* order:
* description: An order object. Available if the relation `order` is expanded.
* description: The details of the order created from the draft order when its payment is captured.
* x-expandable: "order"
* nullable: true
* $ref: "#/components/schemas/Order"
* canceled_at: