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.
46 lines
1.2 KiB
TypeScript
46 lines
1.2 KiB
TypeScript
import { NextResponse } from "next/server"
|
|
import path from "path"
|
|
import OpenAPIParser from "@readme/openapi-parser"
|
|
import getPathsOfTag from "@/utils/get-paths-of-tag"
|
|
import type { ExpandedDocument, Version } from "@/types/openapi"
|
|
|
|
export async function GET(request: Request) {
|
|
const { searchParams } = new URL(request.url)
|
|
const area = searchParams.get("area")
|
|
const version =
|
|
process.env.NEXT_PUBLIC_VERSIONING === "true"
|
|
? (searchParams.get("version") as Version) || "1"
|
|
: "1"
|
|
const expand = searchParams.get("expand")
|
|
if (area !== "admin" && area !== "store") {
|
|
return NextResponse.json(
|
|
{
|
|
success: false,
|
|
message: `area ${area} is not allowed`,
|
|
},
|
|
{
|
|
status: 400,
|
|
}
|
|
)
|
|
}
|
|
const baseSpecs = (await OpenAPIParser.parse(
|
|
path.join(
|
|
process.cwd(),
|
|
version === "1" ? "specs" : "specs-v2",
|
|
`${area}/openapi.yaml`
|
|
)
|
|
)) as ExpandedDocument
|
|
|
|
if (expand) {
|
|
const paths = await getPathsOfTag(expand, area)
|
|
if (paths) {
|
|
baseSpecs.expandedTags = {}
|
|
baseSpecs.expandedTags[expand] = paths.paths
|
|
}
|
|
}
|
|
|
|
return NextResponse.json(baseSpecs, {
|
|
status: 200,
|
|
})
|
|
}
|