-
Notifications
You must be signed in to change notification settings - Fork 183
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
APIView code file token tsp and json schema #8816
Conversation
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. |
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. |
@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/apiview-treestyle-parser-schema/model.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/model.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/model.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/model.tsp
Outdated
Show resolved
Hide resolved
Co-authored-by: Mariana Rios Flores <[email protected]>
Co-authored-by: Mariana Rios Flores <[email protected]>
Co-authored-by: Mariana Rios Flores <[email protected]>
/check-enforcer override |
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.