You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The CRDGenerator should be able to generate those references by searching for an annotation.
Describe the solution you'd like
Suggested annotation:
@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface ExternalDocs {
/** * A short description of the target documentation. * * @return the documentation description **/Stringdescription() default"";
/** * The URL for the target documentation. Value must be in the format of a URL. * * @return the documentation URL **/Stringurl() default"";
}
externalDocs should only appear in the resulting schema if at least url or description is not empty.
Is your enhancement related to a problem? Please describe
The JSONSchemaProps in CRDs allow to reference external documentation resources:
https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#externaldocumentation-v1-apiextensions-k8s-io
The CRDGenerator should be able to generate those references by searching for an annotation.
Describe the solution you'd like
Suggested annotation:
externalDocs
should only appear in the resulting schema if at least url or description is not empty.Describe alternatives you've considered
No response
Additional context
Example tests:
https://github.com/baloo42/crd-generator-victools/blob/main/test/src/test/java/io/fabric8/crd/generator/victools/approvaltests/externaldocs/ExternalDocSpec.java
https://github.com/baloo42/crd-generator-victools/blob/main/test/src/test/resources/io/fabric8/crd/generator/victools/approvaltests/CRDGeneratorVictoolsApprovalTest.approvalTest.externaldocs.samples.fabric8.io.v1.approved.yml
The text was updated successfully, but these errors were encountered: