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/GiftCard.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/GiftCard.yaml
@@ -0,0 +1,96 @@
+title: Gift Card
+description: >-
+  Gift Cards are redeemable and represent a value that can be used towards the
+  payment of an Order.
+type: object
+required:
+  - balance
+  - code
+  - created_at
+  - deleted_at
+  - ends_at
+  - id
+  - is_disabled
+  - metadata
+  - order_id
+  - region_id
+  - tax_rate
+  - updated_at
+  - value
+properties:
+  id:
+    description: The gift card's ID
+    type: string
+    example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
+  code:
+    description: >-
+      The unique code that identifies the Gift Card. This is used by the
+      Customer to redeem the value of the Gift Card.
+    type: string
+    example: 3RFT-MH2C-Y4YZ-XMN4
+  value:
+    description: The value that the Gift Card represents.
+    type: integer
+    example: 10
+  balance:
+    description: The remaining value on the Gift Card.
+    type: integer
+    example: 10
+  region_id:
+    description: The ID of the region this gift card is available in.
+    type: string
+    example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
+  region:
+    description: The details of the region this gift card is available in.
+    x-expandable: region
+    nullable: true
+    $ref: ./Region.yaml
+  order_id:
+    description: The ID of the order that the gift card was purchased in.
+    nullable: true
+    type: string
+    example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+  order:
+    description: The details of the order that the gift card was purchased in.
+    x-expandable: region
+    nullable: true
+    type: object
+  is_disabled:
+    description: >-
+      Whether the Gift Card has been disabled. Disabled Gift Cards cannot be
+      applied to carts.
+    type: boolean
+    default: false
+  ends_at:
+    description: The time at which the Gift Card can no longer be used.
+    nullable: true
+    type: string
+    format: date-time
+  tax_rate:
+    description: The gift card's tax rate that will be applied on calculating totals
+    nullable: true
+    type: number
+    example: 0
+  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