Skip to content

CRD Generator : Adding a top level description for a CRD  #7375

@hufon

Description

@hufon

When i use kubectl explain, on a custom resource made by the CRD Generator, i always get:

$ kubectl explain Applications
GROUP:      core.idp
KIND:       Application
VERSION:    v1alpha1

DESCRIPTION:
    <empty>

This top level description should be here in the CRD yaml generated.

    schema:
      openAPIV3Schema:
        description: Here's the custom description
        properties:

I try to use a JsonClassDescription annotation, but without success.

@JsonClassDescription("Application represents an application managed in the organization")
public class Application extends CustomResource<ApplicationSpec, ApplicationStatus>

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions