Feature Overview
Aqua has nice Go comments for its structs, but they do not make it into JSON schemas, leaving the schemas pretty much undocumented. Making use of them when generating schemas would be good.
Why is the feature needed?
Better documentation in JSON schemas.
Example Code
No response
Note
Seems this would be doable with https://github.com/invopop/jsonschema#using-go-comments, requires changes to https://github.com/suzuki-shunsuke/gen-go-jsonschema -- support for passing package to path mappings (likely multiple, so maybe a map argument?), and making aqua pass them.
More info at https://pkg.go.dev/github.com/invopop/jsonschema#Reflector.AddGoComments.
The only current use of jsonschema description in pkg/config/registry/github_cli.go could likely be removed after this.
Feature Overview
Aqua has nice Go comments for its structs, but they do not make it into JSON schemas, leaving the schemas pretty much undocumented. Making use of them when generating schemas would be good.
Why is the feature needed?
Better documentation in JSON schemas.
Example Code
No response
Note
Seems this would be doable with https://github.com/invopop/jsonschema#using-go-comments, requires changes to https://github.com/suzuki-shunsuke/gen-go-jsonschema -- support for passing package to path mappings (likely multiple, so maybe a map argument?), and making aqua pass them.
More info at https://pkg.go.dev/github.com/invopop/jsonschema#Reflector.AddGoComments.
The only current use of
jsonschemadescriptionin pkg/config/registry/github_cli.go could likely be removed after this.