crd-ref-docs icon indicating copy to clipboard operation
crd-ref-docs copied to clipboard

Published 20 hours ago • verified publisher icon elastic

Adding `fieldPath` to CRD validation rules removes the whole API group doc

Open pmalek opened this issue 1 year ago • 3 comments

Problem statement

controller-tools 0.16.0 introduced support for fieldPath in CRD validation rules: https://github.com/kubernetes-sigs/controller-tools/pull/932

When adding those code markers crd-ref-docs removes the whole API group documentation for some reason.

Acceptance criteria

  • [ ] As a user I can use fieldPath for my CRD validation rules and get documentation generated using crd-ref-docs.

pmalek avatar Sep 19 '24 11:09 pmalek

Just tested bumping sigs.k8s.io/controller-tools to v0.17.0 and it seems to do the trick.

Any chance we can get https://github.com/elastic/crd-ref-docs/pull/102 merged and then a bump to 0.17.0?

@thbkrkr can you help here?

pmalek avatar Jan 08 '25 15:01 pmalek

sigs.k8s.io/controller-tools has been updated to v0.17.0 in:

  • https://github.com/elastic/crd-ref-docs/pull/122

thbkrkr avatar Jan 08 '25 17:01 thbkrkr

sigs.k8s.io/controller-tools has been updated to v0.17.0 in:

  • https://github.com/elastic/crd-ref-docs/pull/122

Thanks! Any chance to release 0.1.1 with these changes?

pmalek avatar Jan 08 '25 20:01 pmalek