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/TrackingLink.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/TrackingLink.yaml
@@ -0,0 +1,72 @@
+title: Tracking Link
+description: >-
+  A tracking link holds information about tracking numbers for a Fulfillment.
+  Tracking Links can optionally contain a URL that can be visited to see the
+  status of the shipment. Typically, the tracking link is provided from the
+  third-party service integrated through the used fulfillment provider.
+type: object
+required:
+  - created_at
+  - deleted_at
+  - fulfillment_id
+  - id
+  - idempotency_key
+  - metadata
+  - tracking_number
+  - updated_at
+  - url
+properties:
+  id:
+    description: The tracking link's ID
+    type: string
+    example: tlink_01G8ZH853Y6TFXWPG5EYE81X63
+  url:
+    description: The URL at which the status of the shipment can be tracked.
+    nullable: true
+    type: string
+    format: uri
+  tracking_number:
+    description: The tracking number given by the shipping carrier.
+    type: string
+    format: RH370168054CN
+  fulfillment_id:
+    description: The ID of the fulfillment that the tracking link belongs to.
+    type: string
+    example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
+  fulfillment:
+    description: The details of the fulfillment that the tracking link belongs to.
+    x-expandable: fulfillment
+    nullable: true
+    type: object
+  idempotency_key:
+    description: >-
+      Randomly generated key used to continue the completion of a process 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
+  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