[GitHub] [flink-kubernetes-operator] wangyang0918 commented on a change in pull request #61: [FLINK-26510] Add javadoc to all CRD fields + generate doc page from it

[GitBox <gi...@apache.org>]

wangyang0918 commented on a change in pull request #61:
URL: https://github.com/apache/flink-kubernetes-operator/pull/61#discussion_r826714428



##########
File path: docs/content/docs/custom-resource/reference.md
##########
@@ -24,4 +22,150 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-# Reference
+# FlinkDeployment Reference
+## Spec
+
+### FlinkDeploymentSpec
+**Class**: org.apache.flink.kubernetes.operator.crd.spec.FlinkDeploymentSpec
+
+**Description**: Spec that describes a Flink application deployment.

Review comment:
       "Flink application" is a little misleading since it could be an application or session cluster.

##########
File path: flink-kubernetes-operator/src/main/java/org/apache/flink/kubernetes/operator/crd/status/JobStatus.java
##########
@@ -24,16 +24,25 @@
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
-/** Status of an individual job within the Flink deployment. */
+/** Last observed status of the Flink job within an application deployment. */
 @Experimental
 @Data
 @NoArgsConstructor
 @AllArgsConstructor
 @Builder
 public class JobStatus {
+    /** Name of the job. */
     private String jobName;
+
+    /** Flink JobId of the Job. */
     private String jobId;
+
+    /** Last observed state of the job. */
     private String state;
+
+    /** Start time of the job. */
     private String updateTime;

Review comment:
       Maybe we could add a new filed `startTime`. IIUC, updating the `updateTime` every time will not cause busy reconciliation now.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org