New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
crd-generator and annotations #2959
Comments
I'm not sure about this. I think @metacosm can provide some insights on whether it's supported or if it's a valid use case |
@rohanKanojia |
So far it's not supported yet (unless I missed something). In scope of #2670 and from a discussion in #2611, there was a proposal for something like this:
|
Enums are supported. We could add more annotations to support more descriptive CRDs, indeed. |
This issue has been automatically marked as stale because it has not had any activity since 90 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions! |
I would also be happy about such a functionality. We have learned from the Spring framework that the documentation for so-called configuration properties is generated from the Java doc. I don't know how the generation is done here. The use of Java-Doc would of course be interesting. |
This issue has been automatically marked as stale because it has not had any activity since 90 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions! |
This issue has been automatically marked as stale because it has not had any activity since 90 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions! |
Hi @andreaTP, |
Does the crd-generator have the ability to parse annotations in the Spec and Status classes to add description, enum, min/max values, required attributes etc... on the properties so the are generated in the yaml ?
In the usage, it is mentioned:
Several annotations are available to override the default behavior if it doesn't fit your needs
Here are my objects:
and the resulting YAML:
I would like the output to be something like this:
Are the annotations mentioned in the usage meant to generate this type of information in the YAML ?
The text was updated successfully, but these errors were encountered: