Skip to content
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.

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

feat(dgeni): add deprecated field to API doc #3543

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

griest024
Copy link
Member

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Fixes: #3499

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@griest024 griest024 added status: wip This PR is WIP. It should be marked as a draft. package: docs-utils @daffodil/docs-utils tools: dgeni @daffodil/tools-dgeni labels Mar 5, 2025
@griest024 griest024 requested a review from xelaint March 5, 2025 21:20
@griest024
Copy link
Member Author

@xelaint I've added the deprecated field to API docs, its ready for UI updates.

@xelaint
Copy link
Member

xelaint commented Mar 6, 2025

@griest024 I'm not seeing the deprecated tag on any of the deprecated classes?

@griest024
Copy link
Member Author

@griest024 I'm not seeing the deprecated tag on any of the deprecated classes?

It should be on the JSON document. I wasn't sure how to wire it up to the UI

@xelaint
Copy link
Member

xelaint commented Mar 7, 2025

@griest024 Something like this. I think I might need to create a docs specific article component to render the UI I want in docs.

Screen Shot 2025-03-07 at 12 53 10 PM Screen Shot 2025-03-07 at 12 54 01 PM

@griest024 griest024 added status: blocked This PR or issue is blocked and cannot currently be progressed and removed status: wip This PR is WIP. It should be marked as a draft. labels Mar 10, 2025
@griest024
Copy link
Member Author

blocked by #3554

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: docs-utils @daffodil/docs-utils status: blocked This PR or issue is blocked and cannot currently be progressed tools: dgeni @daffodil/tools-dgeni
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEAT] Add deprecation indicator to deprecated API tokens
2 participants