-
Notifications
You must be signed in to change notification settings - Fork 187
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
Add TypeSpec Definition for APIView TreeStyle Parser #8657
Add TypeSpec Definition for APIView TreeStyle Parser #8657
Conversation
chidozieononiwu
commented
Jul 18, 2024
- TypeSpec Definition for APIView TreeStyle Parser
tools/apiview/parsers/APIViewTreeStyleParserSchema/src/decorators.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm confused. I was expecting this PR to contain two things: 1) the TypeSpec definition for APIView and 2) the generated JSON schema of the same.
This seems to be an outline of a TypeSpec library for APIView, but I don't understand why, or what it is doing?
a3413fb
to
2e97a17
Compare
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
tools/apiview/parsers/apiview-treestyle-parser-schema/models.tsp
Outdated
Show resolved
Hide resolved
3abc447
to
c9a26c6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall this is a great step forward. Two things I would like to see:
- a script of some kind (though preferably not Powershell) that would allow you to evaluate a provided tokenfile against the generated JSON schema. Every inner-loop dev will need to do that, so that should live here.
- Some kind of automated test that would compare test tokenfiles against both the JSON schema and the server parsing logic. This will help ensure that if the server logic changes, that the TypeSpec and JSON schema and likewise updated.
@chidozieononiwu the JSON registry that Jonathan was mentioning will probably suffice for this, which is great. It will also simplify ask 2. |
c9a26c6
to
f5d1de7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving to work in a more incremental way, but @tjprescott point about incorporating the TypeSpec and schema into automation should be taken into account seriously
CC @maririos @weshaggard
I have updated the tracking issue |