search

crossplane / upjet

A code generation framework and runtime for Crossplane providers
Apache License 2.0
293 stars 84 forks source link

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

Closed muvaf closed 11 months ago

muvaf commented 2 years ago

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.

ulucinar commented 11 months ago

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

image