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
@@ -0,0 +1,76 @@
+title: Shipping Profile
+description: >-
+  A Shipping Profile has a set of defined Shipping Options that can be used to
+  fulfill a given set of Products. For example, gift cards are shipped
+  differently than physical products, so a shipping profile with the type
+  `gift_card` groups together the shipping options that can only be used for
+  gift cards.
+type: object
+required:
+  - created_at
+  - deleted_at
+  - id
+  - metadata
+  - name
+  - type
+  - updated_at
+properties:
+  id:
+    description: The shipping profile's ID
+    type: string
+    example: sp_01G1G5V239ENSZ5MV4JAR737BM
+  name:
+    description: >-
+      The name given to the Shipping profile - this may be displayed to the
+      Customer.
+    type: string
+    example: Default Shipping Profile
+  type:
+    description: >-
+      The type of the Shipping Profile, may be `default`, `gift_card` or
+      `custom`.
+    type: string
+    enum:
+      - default
+      - gift_card
+      - custom
+    example: default
+  products:
+    description: >-
+      The details of the products that the Shipping Profile defines Shipping
+      Options for. Available if the relation `products` is expanded.
+    type: array
+    x-expandable: products
+    items:
+      type: object
+  shipping_options:
+    description: >-
+      The details of the shipping options that can be used to create shipping
+      methods for the Products in the Shipping Profile.
+    type: array
+    x-expandable: shipping_options
+    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