microsoft / kiota

OpenAPI based HTTP Client code generator

Home Page:https://aka.ms/kiota/docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Investigate of exporting the CodeDom to standardised file.

andrueastman opened this issue · comments

Is your feature request related to a problem? Please describe the problem.

Capture regressions in a consistent fashion much earlier.

Client library/SDK language

None

Describe the solution you'd like

Exporting the CodeDom to a file (which would then be diffed or compared with a tool)would possibly unlock the detections of generation regressions that may result in breaking changes in the following scenarios.

  • Metadata - removal of paths/types
  • Naming changes that are breaking
  • Multiple/repeated validations across languages as the dom could optionally be exported before or after the refiner.

Additional context

No response

Thanks for creating the issue.
Adding some thoughts:
Since that export is going to be read by tools, it probably needs to have a JSON schema associated with it.
I don't think the export should be systematic to begin with, maybe let's hide that behind an environment variable at first?
It should NOT contain descriptions or deprecation information.

Relates to #4628