Differentiate descriptions of Address and Endpoint (#179)

Author: MarianMacik

api/v1alpha08/sonataflow_types.go

@@ -120,12 +120,14 @@ type SonataFlowSpec struct {
 // SonataFlowStatus defines the observed state of SonataFlow
 type SonataFlowStatus struct {
 	api.Status `json:",inline"`
+	// Address is used as a part of Addressable interface (status.address.url) for knative
 	// +optional
 	Address duckv1.Addressable `json:"address,omitempty"`
 	// keeps track of how many failure recovers a given workflow had so far
 	RecoverFailureAttempts int         `json:"recoverFailureAttempts,omitempty"`
 	LastTimeRecoverAttempt metav1.Time `json:"lastTimeRecoverAttempt,omitempty"`
-	Endpoint               *apis.URL   `json:"endpoint,omitempty"`
+	// Endpoint is an externally accessible URL of the workflow
+	Endpoint *apis.URL `json:"endpoint,omitempty"`
 }
 
 func (s *SonataFlowStatus) GetTopLevelConditionType() api.ConditionType {

bundle/manifests/sonataflow.org_sonataflows.yaml

@@ -2150,11 +2150,8 @@ spec:
             description: SonataFlowStatus defines the observed state of SonataFlow
             properties:
               address:
-                description: "Addressable provides a generic mechanism for a custom
-                  resource definition to indicate a destination for message delivery.
-                  \n Addressable is the schema for the destination information. This
-                  is typically stored in the object's `status`, as this information
-                  may be generated by the controller."
+                description: Address is used as a part of Addressable interface (status.address.url)
+                  for knative
                 properties:
                   CACerts:
                     description: CACerts is the Certification Authority (CA) certificates
@@ -2196,6 +2193,7 @@ spec:
                   type: object
                 type: array
               endpoint:
+                description: Endpoint is an externally accessible URL of the workflow
                 type: string
               lastTimeRecoverAttempt:
                 format: date-time

config/crd/bases/sonataflow.org_sonataflows.yaml

@@ -2151,11 +2151,8 @@ spec:
             description: SonataFlowStatus defines the observed state of SonataFlow
             properties:
               address:
-                description: "Addressable provides a generic mechanism for a custom
-                  resource definition to indicate a destination for message delivery.
-                  \n Addressable is the schema for the destination information. This
-                  is typically stored in the object's `status`, as this information
-                  may be generated by the controller."
+                description: Address is used as a part of Addressable interface (status.address.url)
+                  for knative
                 properties:
                   CACerts:
                     description: CACerts is the Certification Authority (CA) certificates
@@ -2197,6 +2194,7 @@ spec:
                   type: object
                 type: array
               endpoint:
+                description: Endpoint is an externally accessible URL of the workflow
                 type: string
               lastTimeRecoverAttempt:
                 format: date-time

operator.yaml

@@ -2581,11 +2581,8 @@ spec:
             description: SonataFlowStatus defines the observed state of SonataFlow
             properties:
               address:
-                description: "Addressable provides a generic mechanism for a custom
-                  resource definition to indicate a destination for message delivery.
-                  \n Addressable is the schema for the destination information. This
-                  is typically stored in the object's `status`, as this information
-                  may be generated by the controller."
+                description: Address is used as a part of Addressable interface (status.address.url)
+                  for knative
                 properties:
                   CACerts:
                     description: CACerts is the Certification Authority (CA) certificates
@@ -2627,6 +2624,7 @@ spec:
                   type: object
                 type: array
               endpoint:
+                description: Endpoint is an externally accessible URL of the workflow
                 type: string
               lastTimeRecoverAttempt:
                 format: date-time