docs: enhance how references are generated (#5805)

* adjusted configurations * enhancements to tool and configurations * change reference in docs * fixed issue in workflows reference * added project name * more optimizations * fix context error * added a types reference * resolved missing types * fix reference reflection types not having children * add an expand url parameter * added new option to the README * added details about new option
2023-12-05 15:29:41 +02:00
parent a418e6cebc
commit 892d737c1f
4358 changed files with 947876 additions and 534760 deletions
@@ -0,0 +1,105 @@
+---
+displayed_sidebar: entitiesSidebar
+slug: /references/entities/classes/IdempotencyKey
+---
+
+import ParameterTypes from "@site/src/components/ParameterTypes"
+
+# IdempotencyKey
+
+Idempotency Key is used to continue a process in case of any failure that might occur.
+
+## Properties
+
+<ParameterTypes parameters={[
+  {
+    "name": "created_at",
+    "type": "`Date`",
+    "description": "Date which the idempotency key was locked.",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "id",
+    "type": "`string`",
+    "description": "The idempotency key's ID",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "idempotency_key",
+    "type": "`string`",
+    "description": "The unique randomly generated key used to determine the state of a process.",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "locked_at",
+    "type": "`Date`",
+    "description": "Date which the idempotency key was locked.",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "recovery_point",
+    "type": "`string`",
+    "description": "Where to continue from.",
+    "optional": false,
+    "defaultValue": "started",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "request_method",
+    "type": "`string`",
+    "description": "The method of the request",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "request_params",
+    "type": "`Record<string, unknown>`",
+    "description": "The parameters passed to the request",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "request_path",
+    "type": "`string`",
+    "description": "The request's path",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "response_body",
+    "type": "`Record<string, unknown>`",
+    "description": "The response's body",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "response_code",
+    "type": "`number`",
+    "description": "The response's code.",
+    "optional": false,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  }
+]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>