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

APIView code file token tsp and json schema #8816

Merged
merged 17 commits into from
Aug 19, 2024

Conversation

praveenkuttappan
Copy link
Member

Here is the token schema based on the discussion with @tjprescott and @JonathanGiles. This schema is closer to older token file but at the same time we will have parent child relationship between the code lines to have the context details for APIView. Some other changes are to remove new line and white space tokens as well as to generate navigation TOC by APIView so parser does not haver to generate it.

@praveenkuttappan praveenkuttappan added APIView Central-EngSys This issue is owned by the Engineering System team. labels Aug 9, 2024
@praveenkuttappan praveenkuttappan self-assigned this Aug 9, 2024
@praveenkuttappan
Copy link
Member Author

I will submit a separate PR to remove https://github.com/Azure/azure-sdk-tools/tree/main/tools/apiview/parsers/apiview-treestyle-parser-schema once new token model is signed off.

@maririos
Copy link
Member

maririos commented Aug 9, 2024

Can we generate examples too to see how it will look?

@praveenkuttappan
Copy link
Member Author

Can we generate examples too to see how it will look?

As @lmazuel mentioned on another PR, I am trying to use TypeSpec C# emitter to directly generate the .NET models from TypeSpec and then I will create sample token file for Template. We can include this sample file along with the schema for comparison.

tools/apiview/token-schema/model.tsp Outdated Show resolved Hide resolved
tools/apiview/token-schema/model.tsp Outdated Show resolved Hide resolved
@praveenkuttappan
Copy link
Member Author

Can we generate examples too to see how it will look?

@maririos @tjprescott I have added a sample token file generated for .NET Azure.Template package and rendered review content text file from this sample token(without docs and system generated comments).

@maririos
Copy link
Member

Can we generate examples too to see how it will look?

@maririos @tjprescott I have added a sample token file generated for .NET Azure.Template package and rendered review content text file from this sample token(without docs and system generated comments).

This is great! we should improve then the documentation on https://github.com/Azure/azure-sdk-tools/blob/main/tools/apiview/parsers/CONTRIBUTING.md with this info and how to use the json schema to validate the parser files

@praveenkuttappan
Copy link
Member Author

Can we generate examples too to see how it will look?

@maririos @tjprescott I have added a sample token file generated for .NET Azure.Template package and rendered review content text file from this sample token(without docs and system generated comments).

This is great! we should improve then the documentation on https://github.com/Azure/azure-sdk-tools/blob/main/tools/apiview/parsers/CONTRIBUTING.md with this info and how to use the json schema to validate the parser files

Updated contributing guide and info about json schema validator.

tools/apiview/parsers/CONTRIBUTING.md Show resolved Hide resolved
tools/apiview/parsers/CONTRIBUTING.md Outdated Show resolved Hide resolved
tools/apiview/parsers/CONTRIBUTING.md Outdated Show resolved Hide resolved
tools/apiview/parsers/CONTRIBUTING.md Outdated Show resolved Hide resolved
tools/apiview/parsers/CONTRIBUTING.md Outdated Show resolved Hide resolved
@praveenkuttappan
Copy link
Member Author

/check-enforcer override

@praveenkuttappan praveenkuttappan merged commit aa0fc47 into Azure:main Aug 19, 2024
4 checks passed
@praveenkuttappan praveenkuttappan deleted the apiview_token_schema branch August 19, 2024 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIView Central-EngSys This issue is owned by the Engineering System team.
Projects
Status: ✅ Done
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants