docs: general fixes to references (#5653)

* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
This commit is contained in:
Shahed Nasser
2023-11-17 19:36:58 +02:00
committed by GitHub
parent b3093c3e3d
commit c51dce164d
869 changed files with 15238 additions and 7267 deletions
@@ -14,7 +14,7 @@ The attributes to update in an inventory level. The inventory level is identifie
{
"name": "incoming_quantity",
"type": "`number`",
"description": "",
"description": "The incoming quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -41,7 +41,7 @@ The attributes to update in an inventory level. The inventory level is identifie
{
"name": "stocked_quantity",
"type": "`number`",
"description": "",
"description": "The stocked quantity of the associated inventory item in the associated location.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -13,7 +13,7 @@ The details of the inventory item to be created.
<ParameterTypes parameters={[
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -22,7 +22,7 @@ The details of the inventory item to be created.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -31,7 +31,7 @@ The details of the inventory item to be created.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The HS code of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -40,7 +40,7 @@ The details of the inventory item to be created.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -49,7 +49,7 @@ The details of the inventory item to be created.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The material of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -58,7 +58,7 @@ The details of the inventory item to be created.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -67,7 +67,7 @@ The details of the inventory item to be created.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The MID code of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -76,7 +76,7 @@ The details of the inventory item to be created.
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The origin country of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -86,7 +86,7 @@ The details of the inventory item to be created.
{
"name": "requires_shipping",
"type": "`boolean`",
"description": "",
"description": "Whether the inventory item requires shipping.",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -94,7 +94,7 @@ The details of the inventory item to be created.
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The SKU of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -103,7 +103,7 @@ The details of the inventory item to be created.
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The thumbnail of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -112,7 +112,7 @@ The details of the inventory item to be created.
},
{
"name": "title",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The title of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -121,7 +121,7 @@ The details of the inventory item to be created.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -130,7 +130,7 @@ The details of the inventory item to be created.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the inventory item.",
"optional": true,
"defaultValue": "",
@@ -67,7 +67,7 @@ The details of the reservation item to be created.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "extends",
"type": "`&#123; relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string &#125;`[]",
"type": "``{ relationship: [JoinerRelationship](../types/JoinerRelationship.mdx) ; serviceName: string }``[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -31,7 +31,7 @@ The attributes to update in a reservation item.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "Holds custom data in key-value pairs.",
"optional": true,
"defaultValue": "",