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/DiscountRule.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/DiscountRule.yaml
@@ -0,0 +1,79 @@
+title: Discount Rule
+description: A discount rule defines how a Discount is calculated when applied to a Cart.
+type: object
+required:
+  - allocation
+  - created_at
+  - deleted_at
+  - description
+  - id
+  - metadata
+  - type
+  - updated_at
+  - value
+properties:
+  id:
+    description: The discount rule's ID
+    type: string
+    example: dru_01F0YESMVK96HVX7N419E3CJ7C
+  type:
+    description: >-
+      The type of the Discount, can be `fixed` for discounts that reduce the
+      price by a fixed amount, `percentage` for percentage reductions or
+      `free_shipping` for shipping vouchers.
+    type: string
+    enum:
+      - fixed
+      - percentage
+      - free_shipping
+    example: percentage
+  description:
+    description: A short description of the discount
+    nullable: true
+    type: string
+    example: 10 Percent
+  value:
+    description: >-
+      The value that the discount represents; this will depend on the type of
+      the discount
+    type: integer
+    example: 10
+  allocation:
+    description: The scope that the discount should apply to.
+    nullable: true
+    type: string
+    enum:
+      - total
+      - item
+    example: total
+  conditions:
+    description: >-
+      The details of the discount conditions associated with the rule. They can
+      be used to limit when the discount can be used.
+    type: array
+    x-expandable: conditions
+    items:
+      type: object
+  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