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.

Sign up for GitHub

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

Jump to bottom

Ref and Selector field documentation should include the target type #77

Closed
muvaf opened this issue Aug 23, 2022 · 1 comment
Closed

Ref and Selector field documentation should include the target type #77

muvaf opened this issue Aug 23, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@muvaf
Copy link
Member

muvaf commented Aug 23, 2022

What problem are you facing?

It's hard to figure out which CRD they can reference or select just by looking at the field name

How could Terrajet help solve your problem?

We can add type name to field doc when we add these fields to the struct.
@muvaf muvaf added documentation enhancement New feature or request and removed documentation labels Aug 23, 2022
@ulucinar
Copy link
Collaborator

I think we now have this documentation in the generated OpenAPI v3 schema. An examplehttps://github.com/upbound/provider-aws/blob/main/package/crds/kinesis.aws.upbound.io_streamconsumers.yaml#L116C59-L116C59 is:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@luebken @jeanduplessis @muvaf @ulucinar