docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2023-09-21 20:57:15 +03:00
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,103 @@
+title: DraftOrder
+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
+  - cart_id
+  - completed_at
+  - created_at
+  - display_id
+  - id
+  - idempotency_key
+  - metadata
+  - no_notification_order
+  - order_id
+  - status
+  - updated_at
+properties:
+  id:
+    description: The draft order's ID
+    type: string
+    example: dorder_01G8TJFKBG38YYFQ035MSVG03C
+  status:
+    description: >-
+      The status of the draft order. It's changed to `completed` when it's
+      transformed to an order.
+    type: string
+    enum:
+      - open
+      - completed
+    default: open
+  display_id:
+    description: The draft order's display ID
+    type: string
+    example: 2
+  cart_id:
+    description: The ID of the cart associated with the draft order.
+    nullable: true
+    type: string
+    example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+  cart:
+    description: The details of the cart associated with the draft order.
+    x-expandable: cart
+    nullable: true
+    type: object
+  order_id:
+    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: >-
+      The details of the order created from the draft order when its payment is
+      captured.
+    x-expandable: order
+    nullable: true
+    type: object
+  canceled_at:
+    description: The date the draft order was canceled at.
+    nullable: true
+    type: string
+    format: date-time
+  completed_at:
+    description: The date the draft order was completed at.
+    nullable: true
+    type: string
+    format: date-time
+  no_notification_order:
+    description: Whether to send the customer notifications regarding order updates.
+    nullable: true
+    type: boolean
+    example: false
+  idempotency_key:
+    description: >-
+      Randomly generated key used to continue the completion of the cart
+      associated with the draft order in case of failure.
+    nullable: true
+    type: string
+    externalDocs:
+      url: https://docs.medusajs.com/development/idempotency-key/overview.md
+      description: Learn more how to use the idempotency key.
+  created_at:
+    description: The date with timezone at which the resource was created.
+    type: string
+    format: date-time
+  updated_at:
+    description: The date with timezone at which the resource was updated.
+    type: string
+    format: date-time
+  metadata:
+    description: An optional key-value map with additional details
+    nullable: true
+    type: object
+    example:
+      car: white
+    externalDocs:
+      description: Learn about the metadata attribute, and how to delete and update it.
+      url: >-
+        https://docs.medusajs.com/development/entities/overview#metadata-attribute