XRDs have empty top-level description field with kubectl explain

[mbbush]

What happened?

When I specify a description field for my XRDs at the top level, the way I would normally do for an openapiv3 spec, it shows up as <empty> when I call kubectl explain on the custom resource type.

How can we reproduce it?

When I define a CompositeResourceDefinition using kubectl apply -f pointing to a file containing the following yaml, and then run kubectl explain xmissingdescriptions (or similar on xmissingdescriptions.spec) I see

DESCRIPTION:
     <empty>

rather than the descriptions I included.

apiVersion: apiextensions.crossplane.io/v1
kind: CompositeResourceDefinition
metadata:
  name: xmissingdescriptions.example.com
spec:
  claimNames:
    kind: MissingDescription
    plural: missingdescriptions
  group: example.com
  names:
    kind: XMissingDescription
    plural: xmissingdescriptions
  versions:
    - name: v1alpha1
      served: true
      referenceable: true
      schema:
        openAPIV3Schema:
          type: object
          description: I would like to have this description show up in kubectl explain, but it does not.
          properties:
            spec:
              type: object
              description: I would also like this description to show up in kubectl explain.
              properties:
                id:
                  description: I can put a description here.
                  type: string
                parameters:
                  type: object
                  description: I can put a description here too.
                  properties:
                    stringParameter:
                      type: string
                      description: This shows up fine in kubectl explain.
                    objectParameter:
                      type: object
                      description: This shows up as well.
              required:
                - id
                - parameters
            status:
              type: object

What environment did it happen in?

Crossplane version: 1.11
Client Version: v1.26.2
Kustomize Version: v4.5.7
Server Version: v1.24.13-eks-0a21954

[negz]

Good catch! I'm guessing we're just not propagating that field correctly in the xcrd package. if that's the case it should be an easy fix.

crossplane/internal/xcrd/crd.go

Line 52 in 46d4681

// ForCompositeResource derives the CustomResourceDefinition for a composite

[PriyanshuAhlawat]

Hi, I will like to work on this

[jbw976]

Cool @PriyanshuAhlawat! Feel free to open a PR with a fix and testing/verification 🤩

[jbw976]

@PriyanshuAhlawat have you gotten a chance to start working on this issue? Do you need any help getting started? I've included it in v1.13 milestone (late july) for now in the assumption that you'll be working on it, but please let us know any expectations for progress here, thank you! 🙇

[PriyanshuAhlawat]

@jbw976 sorry I have been busy with my university exams since mid June but I will start working on it from next week if that's not a problem.😓

[PriyanshuAhlawat]

Apology cannot work on it, schedule is full of many tasks.

[cpurev]

Hello, I would like to work on this. How do I get started?

[Azanul]

@jbw976 If this is still required, I'd like to work on it.

[zakisk]

hey @jbw976 @negz I am new here, can you please explain what's going wrong here I would like to work and engage in crossplane open source space.

[mbbush]

I've never written in Go before, and would welcome feedback on my PR #4371