docs: refactored versioning in api reference + modified v2 content (#7274)
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
import AreaProvider from "@/providers/area"
|
||||
import AdminDescription from "../../_mdx/admin.mdx"
|
||||
import StoreDescription from "../../_mdx/store.mdx"
|
||||
import ClientLibraries from "../../_mdx/client-libraries.mdx"
|
||||
import AdminContentV1 from "../../_mdx/v1/admin.mdx"
|
||||
import StoreContentV1 from "../../_mdx/v1/store.mdx"
|
||||
import ClientLibrariesV1 from "../../_mdx/v1/client-libraries.mdx"
|
||||
import Section from "@/components/Section"
|
||||
import Tags from "@/components/Tags"
|
||||
import type { Area } from "@/types/openapi"
|
||||
@@ -25,11 +25,11 @@ const ReferencePage = async ({ params: { area } }: ReferencePageProps) => {
|
||||
mainContent={
|
||||
<Section>
|
||||
<PageHeading className="!text-h2 hidden lg:block" />
|
||||
{area.includes("admin") && <AdminDescription />}
|
||||
{area.includes("store") && <StoreDescription />}
|
||||
{area.includes("admin") && <AdminContentV1 />}
|
||||
{area.includes("store") && <StoreContentV1 />}
|
||||
</Section>
|
||||
}
|
||||
codeContent={<ClientLibraries />}
|
||||
codeContent={<ClientLibrariesV1 />}
|
||||
className="flex-col-reverse"
|
||||
/>
|
||||
<Tags />
|
||||
|
||||
BIN
www/apps/api-reference/app/api/[area]/v2/opengraph-image.jpg
Normal file
BIN
www/apps/api-reference/app/api/[area]/v2/opengraph-image.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 253 KiB |
62
www/apps/api-reference/app/api/[area]/v2/page.tsx
Normal file
62
www/apps/api-reference/app/api/[area]/v2/page.tsx
Normal file
@@ -0,0 +1,62 @@
|
||||
import AreaProvider from "@/providers/area"
|
||||
import AdminContentV2 from "../../../_mdx/v2/admin.mdx"
|
||||
import StoreContentV2 from "../../../_mdx/v2/store.mdx"
|
||||
import ClientLibrariesV2 from "../../../_mdx/v2/client-libraries.mdx"
|
||||
import Section from "@/components/Section"
|
||||
import Tags from "@/components/Tags"
|
||||
import type { Area } from "@/types/openapi"
|
||||
import DividedLayout from "@/layouts/Divided"
|
||||
import { capitalize } from "docs-ui"
|
||||
import PageTitleProvider from "@/providers/page-title"
|
||||
import PageHeading from "@/components/PageHeading"
|
||||
|
||||
type ReferencePageProps = {
|
||||
params: {
|
||||
area: Area
|
||||
}
|
||||
}
|
||||
|
||||
const ReferencePage = async ({ params: { area } }: ReferencePageProps) => {
|
||||
return (
|
||||
<AreaProvider area={area}>
|
||||
<PageTitleProvider>
|
||||
<PageHeading className="!text-h2 block lg:hidden" />
|
||||
<DividedLayout
|
||||
mainContent={
|
||||
<Section>
|
||||
<PageHeading className="!text-h2 hidden lg:block" />
|
||||
{area.includes("admin") && <AdminContentV2 />}
|
||||
{area.includes("store") && <StoreContentV2 />}
|
||||
</Section>
|
||||
}
|
||||
codeContent={<ClientLibrariesV2 />}
|
||||
className="flex-col-reverse"
|
||||
/>
|
||||
<Tags />
|
||||
</PageTitleProvider>
|
||||
</AreaProvider>
|
||||
)
|
||||
}
|
||||
|
||||
export default ReferencePage
|
||||
|
||||
export function generateMetadata({ params: { area } }: ReferencePageProps) {
|
||||
return {
|
||||
title: `Medusa ${capitalize(area)} API Reference`,
|
||||
description: `REST API reference for the Medusa ${area} API. This reference includes code snippets and examples for Medusa JS Client and cURL.`,
|
||||
metadataBase: process.env.NEXT_PUBLIC_BASE_URL,
|
||||
}
|
||||
}
|
||||
|
||||
export const dynamicParams = false
|
||||
|
||||
export async function generateStaticParams() {
|
||||
return [
|
||||
{
|
||||
area: "admin",
|
||||
},
|
||||
{
|
||||
area: "store",
|
||||
},
|
||||
]
|
||||
}
|
||||
BIN
www/apps/api-reference/app/api/[area]/v2/twitter-image.jpg
Normal file
BIN
www/apps/api-reference/app/api/[area]/v2/twitter-image.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 253 KiB |
Reference in New Issue
Block a user