search

crdsdev / doc

Automatic documentation for CustomResourceDefinitions
https://doc.crds.dev
Apache License 2.0
225 stars 35 forks source link

CRD version support #137

Open tylerauerbeck opened 3 years ago

tylerauerbeck commented 3 years ago

Does this tool only support specific versions of the CRD spec (i.e. support v1, but not v1beta1?)

I see instances where it picks up v1 fine (ex: https://doc.crds.dev/github.com/redhat-cop/global-load-balancer-operator), but in instances of v1beta1 it seems to index the repo, but doesn't pick up any of the CRDS (ex: https://doc.crds.dev/github.com/redhat-cop/group-sync-operator). Didn't see this listed anywhere, so just wanted to confirm.

Sorry in advance if I've just overlooked docs or issues that already point this out.

hasheddan commented 3 years ago

@tylerauerbeck thanks for the bug report! So this actually doesn't have to do with v1 / v1beta1 (you can see https://doc.crds.dev/github.com/redhat-cop/group-sync-operator@v0.0.7 works fine). However, I found the issue to be that there is a YAML linebreak in the description of one of the fields (---) (https://github.com/redhat-cop/group-sync-operator/blob/33d6b4c736bfb290d333b4536504450c3a937062/config/crd/bases/redhatcop.redhat.io_groupsyncs.yaml#L759). I am actually fairly surprised this field is not being quoted by controller-gen, but I'll try to see if I can sanitize this value to make it not trip up the parser.