chore(docs): Refactor API Reference (#1883)

2022-08-05 14:06:12 +02:00
parent b126ab4dec
commit 73383cc466
625 changed files with 52358 additions and 11660 deletions
@@ -0,0 +1,55 @@
+title: Tracking Link
+description: >-
+  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.
+x-resourceId: tracking_link
+required:
+  - tracking_number
+  - fulfillment_id
+properties:
+  id:
+    type: string
+    description: The tracking link's ID
+    example: tlink_01G8ZH853Y6TFXWPG5EYE81X63
+  url:
+    description: The URL at which the status of the shipment can be tracked.
+    type: string
+    format: uri
+  tracking_number:
+    description: The tracking number given by the shipping carrier.
+    type: string
+    format: RH370168054CN
+  fulfillment_id:
+    type: string
+    description: The id of the Fulfillment that the Tracking Link references.
+    example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
+  fulfillment:
+    description: Available if the relation `fulfillment` is expanded.
+    $ref: ./fulfillment.yaml
+  idempotency_key:
+    type: string
+    description: >-
+      Randomly generated key used to continue the completion of a process in
+      case of failure.
+    externalDocs:
+      url: >-
+        https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
+      description: Learn more how to use the idempotency key.
+  created_at:
+    type: string
+    description: The date with timezone at which the resource was created.
+    format: date-time
+  updated_at:
+    type: string
+    description: The date with timezone at which the resource was updated.
+    format: date-time
+  deleted_at:
+    type: string
+    description: The date with timezone at which the resource was deleted.
+    format: date-time
+  metadata:
+    type: object
+    description: An optional key-value map with additional details
+    example:
+      car: white