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,126 @@
+---
+displayed_sidebar: homepage
+---
+
+import ParameterTypes from "@site/src/components/ParameterTypes"
+
+# AdminGetVariantsParams
+
+Parameters used to filter and configure the pagination of the retrieved product variants.
+
+## constructor
+
+___
+
+## Properties
+
+<ParameterTypes parameters={[
+  {
+    "name": "cart_id",
+    "type": "`string`",
+    "description": "Retrieve prices for a cart ID.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "currency_code",
+    "type": "`string`",
+    "description": "Retrieve prices for a currency code.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "customer_id",
+    "type": "`string`",
+    "description": "Retrieve prices for a customer ID.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "expand",
+    "type": "`string`",
+    "description": "Comma-separated relations that should be expanded in the returned data.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "fields",
+    "type": "`string`",
+    "description": "Comma-separated fields that should be included in the returned data.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "id",
+    "type": "`string` \\| `string`[]",
+    "description": "IDs to filter product variants by.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "inventory_quantity",
+    "type": "`number` \\| [NumericalComparisonOperator](medusa.NumericalComparisonOperator.mdx)",
+    "description": "Number filters to apply on product variants' `inventory_quantity` field.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "limit",
+    "type": "`number`",
+    "description": "Limit the number of items returned in the list.",
+    "optional": true,
+    "defaultValue": "20",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "offset",
+    "type": "`number`",
+    "description": "The number of items to skip when retrieving a list.",
+    "optional": true,
+    "defaultValue": "0",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "q",
+    "type": "`string`",
+    "description": "Search term to search product variants' IDs.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "region_id",
+    "type": "`string`",
+    "description": "Retrieve prices for a region ID.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  },
+  {
+    "name": "title",
+    "type": "`string` \\| `string`[]",
+    "description": "Titles to filter product variants by.",
+    "optional": true,
+    "defaultValue": "",
+    "expandable": false,
+    "children": []
+  }
+]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>