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
--- a/www/apps/api-reference/specs/admin/components/schemas/CustomShippingOption.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/CustomShippingOption.yaml
@@ -0,0 +1,68 @@
+title: Custom Shipping Option
+description: >-
+  Custom Shipping Options are overridden Shipping Options. Admins can attach a
+  Custom Shipping Option to a cart in order to set a custom price for a
+  particular Shipping Option.
+type: object
+required:
+  - cart_id
+  - created_at
+  - deleted_at
+  - id
+  - metadata
+  - price
+  - shipping_option_id
+  - updated_at
+properties:
+  id:
+    description: The custom shipping option's ID
+    type: string
+    example: cso_01G8X99XNB77DMFBJFWX6DN9V9
+  price:
+    description: >-
+      The custom price set that will override the shipping option's original
+      price
+    type: integer
+    example: 1000
+  shipping_option_id:
+    description: The ID of the Shipping Option that the custom shipping option overrides
+    type: string
+    example: so_01G1G5V27GYX4QXNARRQCW1N8T
+  shipping_option:
+    description: The details of the overridden shipping options.
+    x-expandable: shipping_option
+    nullable: true
+    $ref: ./ShippingOption.yaml
+  cart_id:
+    description: The ID of the Cart that the custom shipping option is attached to
+    nullable: true
+    type: string
+    example: cart_01G8ZH853Y6TFXWPG5EYE81X63
+  cart:
+    description: The details of the cart this shipping option belongs to.
+    x-expandable: cart
+    nullable: true
+    $ref: ./Cart.yaml
+  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
+  deleted_at:
+    description: The date with timezone at which the resource was deleted.
+    nullable: true
+    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