miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(misc): update getSchemaViewModel to return new API path rather than /nx-api/:plugin (#31561)

Browse Source 
This PR updates pages like
`/technologies/typescript/api/executors/verdaccio`, such that the
backlink to the API index is correct. Even though we redirect `/nx-api`
pages, the Next.js pages router does not respect them and users see 404
instead.
This commit is contained in:
Jack Hsu 2025-06-12 12:28:47 -04:00 committed by GitHub
parent 5ac1c08d34
commit 51dced2469
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
nx-dev/feature-package-schema-viewer/src/lib/get-schema-view-model.ts
View File

@ -11,6 +11,7 @@ import {
} from '@nx/nx-dev/models-package'; } from '@nx/nx-dev/models-package';
import { ParsedUrlQuery } from 'querystring'; import { ParsedUrlQuery } from 'querystring';
import { Errors, Example, generateJsonExampleFor } from './examples'; import { Errors, Example, generateJsonExampleFor } from './examples';
import { pkgToGeneratedApiDocs } from '@nx/nx-dev/models-document';
function getReferenceFromQuery(query: string): string { function getReferenceFromQuery(query: string): string {
return query.replace('root/', '#/'); return query.replace('root/', '#/');
@ -28,7 +29,7 @@ export interface SchemaViewModel {
schemaGithubUrl: string; schemaGithubUrl: string;
schemaMetadata: SchemaMetadata; schemaMetadata: SchemaMetadata;
subReference: string; subReference: string;
type: 'executor' | 'generator'; type: 'executor' | 'generator' | 'migration';
} }
export function getSchemaViewModel( export function getSchemaViewModel(
@ -37,11 +38,12 @@ export function getSchemaViewModel(
schema: SchemaMetadata schema: SchemaMetadata
): SchemaViewModel | null { ): SchemaViewModel | null {
if (!schema.schema) return null; if (!schema.schema) return null;
const packageUrl = pkgToGeneratedApiDocs[pkg.name].pagePath;
return { return {
schemaMetadata: schema, schemaMetadata: schema,
packageName: pkg.packageName, packageName: pkg.packageName,
packageUrl: `/nx-api/${pkg.name}`, packageUrl,
schemaGithubUrl: pkg.githubRoot + schema.path, schemaGithubUrl: pkg.githubRoot + schema.path,
rootReference: '#', rootReference: '#',
subReference: subReference: