Skip to content

feat(docs,dgeni): add deprecated to API nav list #3649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
griest024 merged 1 commit into from
Apr 29, 2025
Merged

feat(docs,dgeni): add deprecated to API nav list #3649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions libs/docs-utils/src/nav/api.type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
import { DaffNavDoc } from './type';
import { DaffDocsApiRole } from '../api/public_api';

/**
* A navigation item for an API doc.
*/
export interface DaffApiNavDoc extends DaffNavDoc {
interface DaffApiNavDocBase extends DaffNavDoc {
path: string;
docType: string;
role?: DaffDocsApiRole;
}

/**
* A navigation item for an API doc.
*/
export interface DaffApiNavDoc extends DaffApiNavDocBase {
deprecated?: string;
}

/**
* A navigation item for an API doc of a package entrypoint.
*/
export interface DaffApiNavPackageDoc extends DaffApiNavDoc {
export interface DaffApiNavPackageDoc extends DaffApiNavDocBase {
docType: 'package';
description: string;
}
1 change: 1 addition & 0 deletions tools/dgeni/src/transforms/daffodil-api-package/helpers/generateApiList.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ function getExportInfo(exportDoc): DaffDocsApiNavList {
path: `${exportDoc.path[0] === '/' ? '' : '/'}${exportDoc.path}`,
docType: getDocType(exportDoc),
role: exportDoc.role,
deprecated: exportDoc.deprecated,
children: exportDoc.docType === DaffDocsApiType.PACKAGE
? exportDoc.exports
.map(getExportInfo)
Expand Down