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.
60 lines
1.6 KiB
TypeScript
60 lines
1.6 KiB
TypeScript
import { MetadataRoute } from "next"
|
|
import OpenAPIParser from "@readme/openapi-parser"
|
|
import path from "path"
|
|
import type { ExpandedDocument, Operation } from "../../types/openapi"
|
|
import getUrl from "../../utils/get-url"
|
|
import getSectionId from "../../utils/get-section-id"
|
|
import getPathsOfTag from "../../utils/get-paths-of-tag"
|
|
import { config } from "../../config"
|
|
|
|
export default async function sitemap(): Promise<MetadataRoute.Sitemap> {
|
|
const baseUrl = config.baseUrl
|
|
|
|
const results = [
|
|
{
|
|
url: `${baseUrl}/api/admin`,
|
|
lastModified: new Date(),
|
|
},
|
|
{
|
|
url: `${baseUrl}/api/store`,
|
|
lastModified: new Date(),
|
|
},
|
|
]
|
|
|
|
for (const area of ["store", "admin"]) {
|
|
const baseSpecs = (await OpenAPIParser.parse(
|
|
path.join(process.cwd(), `specs/${area}/openapi.yaml`)
|
|
)) as ExpandedDocument
|
|
|
|
await Promise.all(
|
|
baseSpecs.tags?.map(async (tag) => {
|
|
const tagName = getSectionId([tag.name])
|
|
const url = getUrl(area, tagName)
|
|
results.push({
|
|
url,
|
|
lastModified: new Date(),
|
|
})
|
|
|
|
const paths = await getPathsOfTag(tagName, area)
|
|
|
|
Object.values(paths.paths).forEach((path) => {
|
|
Object.values(path).forEach((op) => {
|
|
const operation = op as Operation
|
|
const operationName = getSectionId([
|
|
tag.name,
|
|
operation.operationId,
|
|
])
|
|
const url = getUrl(area, operationName)
|
|
results.push({
|
|
url,
|
|
lastModified: new Date(),
|
|
})
|
|
})
|
|
})
|
|
}) || []
|
|
)
|
|
}
|
|
|
|
return results
|
|
}
|