doc(openapi): added Javadoc comments to all generated models

Signed-off-by: Marc Nuri <[email protected]>

Author: manusa

CHANGELOG.md

@@ -16,6 +16,7 @@
 * Fix #6802: Java generator support for required spec and status
 * Fix #5993: Support for Kubernetes v1.31 (elli)
 * Fix #6767: Support for Kubernetes v1.32 (penelope) 
+* Fix #6777: Added Javadoc comments to all generated models
 
 #### _**Note**_: Breaking changes
 

extensions/certmanager/model/src/generated/java/io/fabric8/certmanager/api/model/acme/v1/ACMEAuthorization.java

@@ -34,6 +34,9 @@
 import lombok.ToString;
 import lombok.experimental.Accessors;
 
+/**
+ * ACMEAuthorization contains data returned from the ACME server on an authorization that must be completed in order validate a DNS name on an ACME Order resource.
+ */
 @JsonDeserialize(using = com.fasterxml.jackson.databind.JsonDeserializer.None.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder({
@@ -97,52 +100,82 @@ public ACMEAuthorization(List<ACMEChallenge> challenges, String identifier, Stri
         this.wildcard = wildcard;
     }
 
+    /**
+     * Challenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process.
+     */
     @JsonProperty("challenges")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public List<ACMEChallenge> getChallenges() {
         return challenges;
     }
 
+    /**
+     * Challenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process.
+     */
     @JsonProperty("challenges")
     public void setChallenges(List<ACMEChallenge> challenges) {
         this.challenges = challenges;
     }
 
+    /**
+     * Identifier is the DNS name to be validated as part of this authorization
+     */
     @JsonProperty("identifier")
     public String getIdentifier() {
         return identifier;
     }
 
+    /**
+     * Identifier is the DNS name to be validated as part of this authorization
+     */
     @JsonProperty("identifier")
     public void setIdentifier(String identifier) {
         this.identifier = identifier;
     }
 
+    /**
+     * InitialState is the initial state of the ACME authorization when first fetched from the ACME server. If an Authorization is already 'valid', the Order controller will not create a Challenge resource for the authorization. This will occur when working with an ACME server that enables 'authz reuse' (such as Let's Encrypt's production endpoint). If not set and 'identifier' is set, the state is assumed to be pending and a Challenge will be created.
+     */
     @JsonProperty("initialState")
     public String getInitialState() {
         return initialState;
     }
 
+    /**
+     * InitialState is the initial state of the ACME authorization when first fetched from the ACME server. If an Authorization is already 'valid', the Order controller will not create a Challenge resource for the authorization. This will occur when working with an ACME server that enables 'authz reuse' (such as Let's Encrypt's production endpoint). If not set and 'identifier' is set, the state is assumed to be pending and a Challenge will be created.
+     */
     @JsonProperty("initialState")
     public void setInitialState(String initialState) {
         this.initialState = initialState;
     }
 
+    /**
+     * URL is the URL of the Authorization that must be completed
+     */
     @JsonProperty("url")
     public String getUrl() {
         return url;
     }
 
+    /**
+     * URL is the URL of the Authorization that must be completed
+     */
     @JsonProperty("url")
     public void setUrl(String url) {
         this.url = url;
     }
 
+    /**
+     * Wildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the &#42;non-wildcard&#42; version of the DNS name. For example, if '&#42;.example.com' is the DNS name being validated, this field will be 'true' and the 'identifier' field will be 'example.com'.
+     */
     @JsonProperty("wildcard")
     public Boolean getWildcard() {
         return wildcard;
     }
 
+    /**
+     * Wildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the &#42;non-wildcard&#42; version of the DNS name. For example, if '&#42;.example.com' is the DNS name being validated, this field will be 'true' and the 'identifier' field will be 'example.com'.
+     */
     @JsonProperty("wildcard")
     public void setWildcard(Boolean wildcard) {
         this.wildcard = wildcard;

extensions/certmanager/model/src/generated/java/io/fabric8/certmanager/api/model/acme/v1/ACMEChallenge.java

@@ -32,6 +32,9 @@
 import lombok.ToString;
 import lombok.experimental.Accessors;
 
+/**
+ * Challenge specifies a challenge offered by the ACME server for an Order. An appropriate Challenge resource can be created to perform the ACME challenge process.
+ */
 @JsonDeserialize(using = com.fasterxml.jackson.databind.JsonDeserializer.None.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder({
@@ -86,31 +89,49 @@ public ACMEChallenge(String token, String type, String url) {
         this.url = url;
     }
 
+    /**
+     * Token is the token that must be presented for this challenge. This is used to compute the 'key' that must also be presented.
+     */
     @JsonProperty("token")
     public String getToken() {
         return token;
     }
 
+    /**
+     * Token is the token that must be presented for this challenge. This is used to compute the 'key' that must also be presented.
+     */
     @JsonProperty("token")
     public void setToken(String token) {
         this.token = token;
     }
 
+    /**
+     * Type is the type of challenge being offered, e.g. 'http-01', 'dns-01', 'tls-sni-01', etc. This is the raw value retrieved from the ACME server. Only 'http-01' and 'dns-01' are supported by cert-manager, other values will be ignored.
+     */
     @JsonProperty("type")
     public String getType() {
         return type;
     }
 
+    /**
+     * Type is the type of challenge being offered, e.g. 'http-01', 'dns-01', 'tls-sni-01', etc. This is the raw value retrieved from the ACME server. Only 'http-01' and 'dns-01' are supported by cert-manager, other values will be ignored.
+     */
     @JsonProperty("type")
     public void setType(String type) {
         this.type = type;
     }
 
+    /**
+     * URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server.
+     */
     @JsonProperty("url")
     public String getUrl() {
         return url;
     }
 
+    /**
+     * URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server.
+     */
     @JsonProperty("url")
     public void setUrl(String url) {
         this.url = url;

extensions/certmanager/model/src/generated/java/io/fabric8/certmanager/api/model/acme/v1/ACMEChallengeSolver.java

@@ -32,6 +32,9 @@
 import lombok.ToString;
 import lombok.experimental.Accessors;
 
+/**
+ * An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided.
+ */
 @JsonDeserialize(using = com.fasterxml.jackson.databind.JsonDeserializer.None.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder({
@@ -86,31 +89,49 @@ public ACMEChallengeSolver(ACMEChallengeSolverDNS01 dns01, ACMEChallengeSolverHT
         this.selector = selector;
     }
 
+    /**
+     * An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided.
+     */
     @JsonProperty("dns01")
     public ACMEChallengeSolverDNS01 getDns01() {
         return dns01;
     }
 
+    /**
+     * An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided.
+     */
     @JsonProperty("dns01")
     public void setDns01(ACMEChallengeSolverDNS01 dns01) {
         this.dns01 = dns01;
     }
 
+    /**
+     * An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided.
+     */
     @JsonProperty("http01")
     public ACMEChallengeSolverHTTP01 getHttp01() {
         return http01;
     }
 
+    /**
+     * An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided.
+     */
     @JsonProperty("http01")
     public void setHttp01(ACMEChallengeSolverHTTP01 http01) {
         this.http01 = http01;
     }
 
+    /**
+     * An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided.
+     */
     @JsonProperty("selector")
     public CertificateDNSNameSelector getSelector() {
         return selector;
     }
 
+    /**
+     * An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided.
+     */
     @JsonProperty("selector")
     public void setSelector(CertificateDNSNameSelector selector) {
         this.selector = selector;

extensions/certmanager/model/src/generated/java/io/fabric8/certmanager/api/model/acme/v1/ACMEChallengeSolverDNS01.java

@@ -32,6 +32,9 @@
 import lombok.ToString;
 import lombok.experimental.Accessors;
 
+/**
+ * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+ */
 @JsonDeserialize(using = com.fasterxml.jackson.databind.JsonDeserializer.None.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder({
@@ -114,101 +117,161 @@ public ACMEChallengeSolverDNS01(ACMEIssuerDNS01ProviderAcmeDNS acmeDNS, ACMEIssu
         this.webhook = webhook;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("acmeDNS")
     public ACMEIssuerDNS01ProviderAcmeDNS getAcmeDNS() {
         return acmeDNS;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("acmeDNS")
     public void setAcmeDNS(ACMEIssuerDNS01ProviderAcmeDNS acmeDNS) {
         this.acmeDNS = acmeDNS;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("akamai")
     public ACMEIssuerDNS01ProviderAkamai getAkamai() {
         return akamai;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("akamai")
     public void setAkamai(ACMEIssuerDNS01ProviderAkamai akamai) {
         this.akamai = akamai;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("azureDNS")
     public ACMEIssuerDNS01ProviderAzureDNS getAzureDNS() {
         return azureDNS;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("azureDNS")
     public void setAzureDNS(ACMEIssuerDNS01ProviderAzureDNS azureDNS) {
         this.azureDNS = azureDNS;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("cloudDNS")
     public ACMEIssuerDNS01ProviderCloudDNS getCloudDNS() {
         return cloudDNS;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("cloudDNS")
     public void setCloudDNS(ACMEIssuerDNS01ProviderCloudDNS cloudDNS) {
         this.cloudDNS = cloudDNS;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("cloudflare")
     public ACMEIssuerDNS01ProviderCloudflare getCloudflare() {
         return cloudflare;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("cloudflare")
     public void setCloudflare(ACMEIssuerDNS01ProviderCloudflare cloudflare) {
         this.cloudflare = cloudflare;
     }
 
+    /**
+     * CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.
+     */
     @JsonProperty("cnameStrategy")
     public String getCnameStrategy() {
         return cnameStrategy;
     }
 
+    /**
+     * CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.
+     */
     @JsonProperty("cnameStrategy")
     public void setCnameStrategy(String cnameStrategy) {
         this.cnameStrategy = cnameStrategy;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("digitalocean")
     public ACMEIssuerDNS01ProviderDigitalOcean getDigitalocean() {
         return digitalocean;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("digitalocean")
     public void setDigitalocean(ACMEIssuerDNS01ProviderDigitalOcean digitalocean) {
         this.digitalocean = digitalocean;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("rfc2136")
     public ACMEIssuerDNS01ProviderRFC2136 getRfc2136() {
         return rfc2136;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("rfc2136")
     public void setRfc2136(ACMEIssuerDNS01ProviderRFC2136 rfc2136) {
         this.rfc2136 = rfc2136;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("route53")
     public ACMEIssuerDNS01ProviderRoute53 getRoute53() {
         return route53;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("route53")
     public void setRoute53(ACMEIssuerDNS01ProviderRoute53 route53) {
         this.route53 = route53;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("webhook")
     public ACMEIssuerDNS01ProviderWebhook getWebhook() {
         return webhook;
     }
 
+    /**
+     * Used to configure a DNS01 challenge provider to be used when solving DNS01 challenges. Only one DNS provider may be configured per solver.
+     */
     @JsonProperty("webhook")
     public void setWebhook(ACMEIssuerDNS01ProviderWebhook webhook) {
         this.webhook = webhook;