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

View File

@@ -82,7 +82,7 @@ medusa.admin.users
"children": [
{
"name": "user",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -108,7 +108,7 @@ medusa.admin.users
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,7 @@ medusa.admin.users.list().then(({ users }) => {
"children": [
{
"name": "users",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>[]",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">[]",
"description": "An array of users details.",
"optional": false,
"defaultValue": "",
@@ -346,7 +346,7 @@ medusa.admin.users.list().then(({ users }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -519,7 +519,7 @@ medusa.admin.users
"children": [
{
"name": "user",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -545,7 +545,7 @@ medusa.admin.users
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -684,7 +684,7 @@ medusa.admin.users.retrieve(userId).then(({ user }) => {
"children": [
{
"name": "user",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -710,7 +710,7 @@ medusa.admin.users.retrieve(userId).then(({ user }) => {
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -981,7 +981,7 @@ medusa.admin.users
"children": [
{
"name": "user",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), `\"password_hash\"`>",
"type": "[Omit](../internal/types/internal.Omit.mdx)<[User](../internal/classes/internal.User.mdx), \"password_hash\">",
"description": "User details.",
"optional": false,
"defaultValue": "",
@@ -1007,7 +1007,7 @@ medusa.admin.users
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",