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/IdempotencyKey.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/IdempotencyKey.yaml
@@ -0,0 +1,69 @@
+title: Idempotency Key
+description: >-
+  Idempotency Key is used to continue a process in case of any failure that
+  might occur.
+type: object
+required:
+  - created_at
+  - id
+  - idempotency_key
+  - locked_at
+  - recovery_point
+  - response_code
+  - response_body
+  - request_method
+  - request_params
+  - request_path
+properties:
+  id:
+    description: The idempotency key's ID
+    type: string
+    example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A
+  idempotency_key:
+    description: >-
+      The unique randomly generated key used to determine the state of a
+      process.
+    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: Date which the idempotency key was locked.
+    type: string
+    format: date-time
+  locked_at:
+    description: Date which the idempotency key was locked.
+    nullable: true
+    type: string
+    format: date-time
+  request_method:
+    description: The method of the request
+    nullable: true
+    type: string
+    example: POST
+  request_params:
+    description: The parameters passed to the request
+    nullable: true
+    type: object
+    example:
+      id: cart_01G8ZH853Y6TFXWPG5EYE81X63
+  request_path:
+    description: The request's path
+    nullable: true
+    type: string
+    example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete
+  response_code:
+    description: The response's code.
+    nullable: true
+    type: string
+    example: 200
+  response_body:
+    description: The response's body
+    nullable: true
+    type: object
+    example:
+      id: cart_01G8ZH853Y6TFXWPG5EYE81X63
+  recovery_point:
+    description: Where to continue from.
+    type: string
+    default: started