bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
63 lines
1.8 KiB
TypeScript
63 lines
1.8 KiB
TypeScript
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 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") && <AdminDescription />}
|
|
{area.includes("store") && <StoreDescription />}
|
|
</Section>
|
|
}
|
|
codeContent={<ClientLibraries />}
|
|
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",
|
|
},
|
|
]
|
|
}
|