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

Create API review for JS packages with namespace in api extractor model #5292

Merged

Conversation

praveenkuttappan
Copy link
Member

API review JSON input file has namespace model and all public API details are under this namespace model. APIView parser currently ignores namespace and any below members which causes issues for packages that has all it's members under a namespace. For e.g API review for change in PR https://github.com/Azure/azure-sdk-for-js-pr/pull/236/files#diff-6dc05287911739aecce4b2d7cbc4df5699df151c14f032b5a14990cd3f5b2762 is empty.

This PR will process namespace model and its child nodes.

@praveenkuttappan praveenkuttappan added the Central-EngSys This issue is owned by the Engineering System team. label Jan 31, 2023
@praveenkuttappan praveenkuttappan self-assigned this Jan 31, 2023
@praveenkuttappan praveenkuttappan requested a review from a team as a code owner January 31, 2023 19:40
Copy link
Member

@jeremymeng jeremymeng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix!

@praveenkuttappan
Copy link
Member Author

Sample API review with this fix: https://apiviewstaging.azurewebsites.net/Assemblies/Review/f6bdaff7a9824ad0a96f13d0da57ad70

@MaryGao FYI....

@praveenkuttappan
Copy link
Member Author

/check-enforcer override

@praveenkuttappan
Copy link
Member Author

/azp run APIView - CI

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@praveenkuttappan
Copy link
Member Author

/azp run APIView - CI

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@praveenkuttappan praveenkuttappan merged commit 1803f5f into Azure:main Feb 1, 2023
@praveenkuttappan praveenkuttappan deleted the feature/js_parser_enhancements branch February 1, 2023 14:44
@MaryGao
Copy link
Member

MaryGao commented Feb 1, 2023

Sample API review with this fix: https://apiviewstaging.azurewebsites.net/Assemblies/Review/f6bdaff7a9824ad0a96f13d0da57ad70

@MaryGao FYI....

@praveenkuttappan I notice that all tokens under namespace are un-clickable, do you know why? Could we someone fix it?

To say we have a declaration type InferOncologyPhenotypingParameters here

image

This type is used by post method under interface InferOncologyPhenotyping and when click the reference type InferOncologyPhenotypingParameters we can't jump to relevant declaration.

image

@praveenkuttappan
Copy link
Member Author

Sample API review with this fix: https://apiviewstaging.azurewebsites.net/Assemblies/Review/f6bdaff7a9824ad0a96f13d0da57ad70
@MaryGao FYI....

@praveenkuttappan I notice that all tokens under namespace are un-clickable, do you know why? Could we someone fix it?

To say we have a declaration type InferOncologyPhenotypingParameters here

image

This type is used by post method under interface InferOncologyPhenotyping and when click the reference type InferOncologyPhenotypingParameters we can't jump to relevant declaration.

image

This one doesn't look like we can resolve with a quick fix in APIView due to the metadata returned by api-extractor itself which is outside the APIView system. I will have a look and talk to someone JS team.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team.
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants