From 9d6c81671d043e91390e35c13d9d45da83ed3d8e Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 14 Aug 2024 17:47:52 +0300 Subject: [PATCH 1/2] fix component --- .../docs-ui/src/components/ExpandableNotice/index.tsx | 6 +++--- .../docs-ui/src/components/TypeList/Items/index.tsx | 6 ++++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/www/packages/docs-ui/src/components/ExpandableNotice/index.tsx b/www/packages/docs-ui/src/components/ExpandableNotice/index.tsx index 89f53ca867533..daced4ffef5a6 100644 --- a/www/packages/docs-ui/src/components/ExpandableNotice/index.tsx +++ b/www/packages/docs-ui/src/components/ExpandableNotice/index.tsx @@ -2,7 +2,7 @@ import React from "react" import { Badge, Link, Tooltip } from "@/components" export type ExpandableNoticeProps = { - type: "request" | "method" + type: "request" | "method" | "workflow" link: string badgeContent?: React.ReactNode badgeClassName?: string @@ -19,8 +19,8 @@ export const ExpandableNotice = ({ tooltipChildren={ <> If this {type} accepts an expand{" "} - {type === "request" ? "parameter" : "property or option"}, -
this field can be expanded into an + {type === "request" ? "parameter" : "parameter or property"}, +
this relation can be expanded into an object. } diff --git a/www/packages/docs-ui/src/components/TypeList/Items/index.tsx b/www/packages/docs-ui/src/components/TypeList/Items/index.tsx index 0c2b0200569f1..d8c43d8623a32 100644 --- a/www/packages/docs-ui/src/components/TypeList/Items/index.tsx +++ b/www/packages/docs-ui/src/components/TypeList/Items/index.tsx @@ -25,6 +25,7 @@ import { useIsBrowser, useSiteConfig } from "../../.." type CommonProps = ParentCommonProps & { level?: number + referenceType?: "method" | "workflow" } type TypeListItemProps = { @@ -39,6 +40,7 @@ const TypeListItem = ({ expandUrl, elementKey, sectionTitle, + referenceType = "method", }: TypeListItemProps) => { const isBrowser = useIsBrowser() const pathname = usePathname() @@ -227,9 +229,9 @@ const TypeListItem = ({ )} {item.expandable && ( } /> )} From fbb834af22273587d4396e18a4392b8d03daab97 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Thu, 15 Aug 2024 17:05:56 +0300 Subject: [PATCH 2/2] update expand URL --- .../src/constants/merger-custom-options/medusa.ts | 4 ---- .../src/constants/merger-options.ts | 4 ++++ 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/medusa.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/medusa.ts index c9c4a2a740761..7c51a85c887c2 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/medusa.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/medusa.ts @@ -3,10 +3,6 @@ import { FormattingOptionsType } from "types" const medusaOptions: FormattingOptionsType = { "^medusa/": { maxLevel: 2, - parameterComponentExtraProps: { - expandUrl: - "https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records", - }, }, "^medusa/classes/medusa\\.(Store*|Admin*)": { reflectionGroups: { diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-options.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-options.ts index 869c56c44d7fc..6aee815213628 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-options.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-options.ts @@ -50,6 +50,10 @@ const mergerOptions: Partial = { parameterStyle: "component", parameterComponent: "TypeList", mdxImports: [`import { TypeList } from "docs-ui"`], + parameterComponentExtraProps: { + expandUrl: + "https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation", + }, }, internal: { maxLevel: 1,