Enhancement of 'ref' mechanism

pkg/concepts/type.go

@@ -72,12 +72,24 @@ type Type struct {
 	annotatedSupport
 	namedSupport
 
-	owner      *Version
-	kind       TypeKind
-	attributes AttributeSlice
-	values     EnumValueSlice
-	element    *Type
-	index      *Type
+	owner            *Version
+	kind             TypeKind
+	attributes       AttributeSlice
+	values           EnumValueSlice
+	element          *Type
+	index            *Type
+	explicitDeclared bool
+}
+
+// ExplicitDeclared returns true if this type is explicitDeclared
+// with a reference
+func (t *Type) ExplicitDeclared() bool {
+	return t.explicitDeclared
+}
+
+// SetExplicitDeclared sets ExplicitDeclared
+func (t *Type) SetExplicitDeclared(value bool) {
+	t.explicitDeclared = value
 }
 
 // Owner returns the version that owns this type.
@@ -193,6 +205,14 @@ func (t *Type) AddAttribute(attribute *Attribute) {
 	}
 }
 
+func (t *Type) AddAttributes(attributes AttributeSlice) {
+	if attributes.Len() > 0 {
+		for _, att := range attributes {
+			t.AddAttribute(att)
+		}
+	}
+}
+
 // FindAttribute returns the attribute with the given name, or nil if no such attribute exists.
 func (t *Type) FindAttribute(name *names.Name) *Attribute {
 	for _, attribute := range t.attributes {

pkg/generators/golang/json_generator.go

@@ -700,7 +700,7 @@ func (g *JSONSupportGenerator) generateStructTypeSource(typ *concepts.Type) {
 					{{ $fieldTag := fieldTag . }}
 					{{ $fieldMask := bitMask . }}
 					case "{{ $fieldTag }}":
-						{{ generateReadValue "value" .Type .Link .LinkOwner}}
+						{{ generateReadValue "value" .Type .Link .LinkOwner }}
 						object.{{ $fieldName }} = value
 						object.bitmap_ |= {{ $fieldMask }}
 				{{ end }}
@@ -1351,7 +1351,7 @@ func (g *JSONSupportGenerator) generateReadValue(variable string, typ *concepts.
 			{{ .Variable }} := {{ readRefTypeFunc .Type .LinkOwner }}(iterator)
 		{{ else if .Type.IsList }}
 			{{ if .Link }}
-			 	{{ $selectorFromLinkOwner := selectorFromLinkOwner .LinkOwner}}
+			 	{{ $selectorFromLinkOwner := selectorFromLinkOwner .LinkOwner }}
 				{{ $structName := structName .Type }}
 				{{ .Variable }} := &{{ $selectorFromLinkOwner }}{{ $structName }}{}
 				for {
@@ -1485,7 +1485,7 @@ func (g *JSONSupportGenerator) generateWriteValue(value string,
 					}
 					item := {{ .Value }}[key]
 					stream.WriteObjectField(key)
-					{{ generateWriteValue "item" .Type.Element false .LinkOwner}}
+					{{ generateWriteValue "item" .Type.Element false .LinkOwner }}
 				}
 				stream.WriteObjectEnd()
 			} else {

pkg/language/reader.go

@@ -431,10 +431,34 @@ func (r *Reader) ExitClassDecl(ctx *ClassDeclContext) {
 	}
 
 	if path := annotations.ReferencePath(typ); path != "" {
+		// If the type has a reference set ExplicitDeclared
+		typ.SetExplicitDeclared(true)
+		r.removeLinkedAttributes(typ)
 		r.handleClassRef(typ, path)
 	}
 }
 
+func (r *Reader) removeLinkedAttributes(typ *concepts.Type) {
+	for _, types := range r.version.Types() {
+		for _, attribute := range types.Attributes() {
+			// It could be that the type is already in an attribute of the service
+			// It needs to add the SetExplicitDeclared to it. {
+			if attribute.Type().Name() == typ.Name() {
+				attribute.SetLinkOwner(nil)
+				attribute.Type().SetExplicitDeclared(true)
+			}
+			if attribute.Type().IsList() || attribute.Type().IsMap() {
+				if attribute.Type().Element().Name().String() == typ.Name().String() {
+					attribute.SetLinkOwner(nil)
+					attribute.Type().SetExplicitDeclared(true)
+					attribute.Type().Element().SetExplicitDeclared(true)
+					attribute.Type().Element().SetOwner(typ.Owner())
+				}
+			}
+		}
+	}
+}
+
 func (r *Reader) handleClassRef(typ *concepts.Type, path string) {
 	if len(r.inputs) > 1 {
 		panic("referenced service with multiple inputs in undefined")
@@ -462,7 +486,6 @@ func (r *Reader) handleClassRef(typ *concepts.Type, path string) {
 	// Once loading the service, we find the reference type
 	// then recursively iterate the type tree and add the types to the current version.
 	if referencedType := refVersion.FindType(names.ParseUsingSeparator(referencedTypeName, "_")); referencedType != nil {
-		r.version.AddType(referencedType)
 		r.recursivelyAddTypeToVersion(typ, referencedType)
 	}
 }
@@ -474,9 +497,25 @@ func (r *Reader) recursivelyAddTypeToVersion(currType *concepts.Type,
 		return
 	}
 	for _, attribute := range referencedType.Attributes() {
+		// If attribute is explicitDeclared, it needs to change it's owner to be the same as currType
 		if attribute.Link() {
 			// If the attribute is a Link set the LinkOwner
-			// to the attribute type Owner
+			// to the attribute type Owner, if it is also a list it should change the owner of the
+			// element type
+			existingAttType := r.version.FindType(attribute.Type().Name())
+			if existingAttType != nil && existingAttType.ExplicitDeclared() {
+				attribute.Type().SetOwner(r.version)
+				// Stop the iteration over the attributes of this type
+				continue
+			} else if attribute.Type().IsList() || attribute.Type().IsMap() {
+				existingAttType = r.version.FindType(attribute.Type().Element().Name())
+				if existingAttType != nil && existingAttType.ExplicitDeclared() {
+					attribute.Type().SetOwner(r.version)
+					attribute.Type().Element().SetOwner(r.version)
+					continue
+				}
+			}
+			// Otherwise add the setLinkOwner to the attribute
 			attribute.SetLinkOwner(attribute.Type().Owner())
 		} else if attribute.Type().IsList() || attribute.Type().IsMap() {
 			r.version.AddType(attribute.Type())
@@ -485,9 +524,13 @@ func (r *Reader) recursivelyAddTypeToVersion(currType *concepts.Type,
 			r.recursivelyAddTypeToVersion(currType, attribute.Type())
 		}
 	}
-	if r.version.FindType(referencedType.Name()) == nil {
-		r.version.AddType(referencedType)
+
+	existingType := r.version.FindType(referencedType.Name())
+	if existingType != nil && existingType.ExplicitDeclared() {
+		referencedType.SetExplicitDeclared(true)
 	}
+	r.version.AddType(referencedType)
+
 }
 
 func (r *Reader) ExitStructDecl(ctx *StructDeclContext) {

pkg/language/ref_test.go

@@ -206,8 +206,7 @@ var _ = Describe("Read Model with ref annotation", func() {
 		attributeFoo := class.FindAttribute(names.ParseUsingCase("Foo"))
 		Expect(attributeFoo).ToNot(BeNil())
 		Expect(attributeFoo.Type().IsList()).To(BeTrue())
-		Expect(attributeFoo.LinkOwner().Name().String()).To(Equal("v1"))
-		Expect(attributeFoo.Type().Owner().Name().String()).To(Equal("v1"))
+		Expect(attributeFoo.Type().Owner().Name().String()).To(Equal("v1_alpha1"))
 		myAttributeType := version.FindType(names.ParseUsingCase("MyAttribute"))
 		Expect(myAttributeType).ToNot(BeNil())
 		Expect(myAttributeType.Owner().Name().String()).To(Equal("v1_alpha1"))
@@ -267,8 +266,7 @@ var _ = Describe("Read Model with ref annotation", func() {
 		attributeFoo := class.FindAttribute(names.ParseUsingCase("Foo"))
 		Expect(attributeFoo).ToNot(BeNil())
 		Expect(attributeFoo.Type().IsList()).To(BeTrue())
-		Expect(attributeFoo.LinkOwner().Name().String()).To(Equal("v1"))
-		Expect(attributeFoo.Type().Owner().Name().String()).To(Equal("v1"))
+		Expect(attributeFoo.Type().Owner().Name().String()).To(Equal("v1_alpha1"))
 		myAttributeType := version.FindType(names.ParseUsingCase("MyAttribute"))
 		Expect(myAttributeType).ToNot(BeNil())
 		Expect(myAttributeType.Owner().Name().String()).To(Equal("v1_alpha1"))
@@ -331,8 +329,7 @@ var _ = Describe("Read Model with ref annotation", func() {
 		attributeFoo := class.FindAttribute(names.ParseUsingCase("Foo"))
 		Expect(attributeFoo).ToNot(BeNil())
 		Expect(attributeFoo.Type().IsList()).To(BeTrue())
-		Expect(attributeFoo.LinkOwner().Name().String()).To(Equal("v1"))
-		Expect(attributeFoo.Type().Owner().Name().String()).To(Equal("v1"))
+		Expect(attributeFoo.Type().Owner().Name().String()).To(Equal("v1_alpha1"))
 		myAttributeType := version.FindType(names.ParseUsingCase("MyAttribute"))
 		Expect(myAttributeType).ToNot(BeNil())
 		Expect(myAttributeType.Owner().Name().String()).To(Equal("v1_alpha1"))

tests/model/aro_hcp/v1_alpha1/cluster_resource.model

@@ -39,4 +39,9 @@ resource Cluster {
     locator NodePools {
         target NodePools
     }
-}
+
+	// Reference to the resource that manages the detailed status of the cluster.
+	locator Status {
+		target ClusterStatus
+	}
+}

tests/model/aro_hcp/v1_alpha1/cluster_status_resource.model

@@ -0,0 +1,23 @@
+/*
+Copyright (c) 2025 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Manages a specific cluster status.
+resource ClusterStatus {
+    // Retrieves the details of the node pool.
+    method Get {
+        out Body ClusterStatus
+    }
+}

tests/model/aro_hcp/v1_alpha1/cluster_status_type.model

@@ -0,0 +1,19 @@
+/*
+Copyright (c) 2025 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+@ref(path = "/clusters_mgmt/v1/cluster_status")
+class ClusterStatus {
+}

tests/model/aro_hcp/v1_alpha1/cluster_type.model

@@ -16,4 +16,4 @@ limitations under the License.
 
 @ref(path = "/clusters_mgmt/v1/cluster")
 class Cluster {
-}
+}

tests/model/aro_hcp/v1_alpha1/clusters_resource.model

@@ -76,4 +76,4 @@ resource Clusters {
 		target Cluster
 		variable ID
 	}
-}
+}

tests/model/aro_hcp/v1_alpha1/node_pool_type.model

@@ -16,4 +16,4 @@ limitations under the License.
 
 @ref(path = "/clusters_mgmt/v1/node_pool")
 class NodePool {
-}
+}

tests/model/aro_hcp/v1_alpha1/node_pools_resource.model

@@ -72,4 +72,4 @@ resource NodePools {
 		target NodePool
 		variable ID
 	}
-}
+}

tests/model/clusters_mgmt/v1/cluster_resource.model

@@ -41,4 +41,14 @@ resource Cluster {
 	locator IdentityProviders {
 		target IdentityProviders
 	}
+
+	// Reference to the NodePool resource
+	locator NodePools{
+		target NodePools
+	}
+
+	// Reference to the resource that manages the detailed status of the cluster.
+	locator Status {
+		target ClusterStatus
+	}
 }

tests/model/clusters_mgmt/v1/cluster_status_resource.model

@@ -0,0 +1,23 @@
+/*
+Copyright (c) 2025 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Manages a specific cluster status.
+resource ClusterStatus {
+    // Retrieves the details of the node pool.
+    method Get {
+        out Body ClusterStatus
+    }
+}

tests/model/clusters_mgmt/v1/cluster_status_type.model

@@ -0,0 +1,24 @@
+/*
+Copyright (c) 2025 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Overall state of a cluster.
+class ClusterStatus {
+    // State value
+    State ClusterState
+
+    // Human readable value
+    Message String
+}

tests/model/clusters_mgmt/v1/cluster_type.model

@@ -35,7 +35,10 @@ class Cluster {
 	// User defined properties for tagging and querying.
 	Properties [String]String
 
-	// Overall state of the cluster.
+	// Overall status of the cluster.
+	Status ClusterStatus
+
+	// Overall state of the cluster
 	State ClusterState
 
 	// Flag indicating if the cluster is managed (by Red Hat) or
@@ -67,4 +70,9 @@ class Cluster {
 
 	// Floating point value used for tests.
 	Factor Float
+
+	// List of node pools on this cluster.
+    // NodePool is a scalable set of worker nodes attached to a hosted cluster.
+    link NodePools []NodePool
+
 }

tests/model/clusters_mgmt/v1/node_pool_resource.model

@@ -0,0 +1,32 @@
+/*
+Copyright (c) 2025 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Manages a specific nodepool.
+resource NodePool {
+    // Retrieves the details of the node pool.
+    method Get {
+        out Body NodePool
+    }
+
+    // Updates the node pool.
+    method Update {
+        in out Body NodePool
+    }
+
+    // Deletes the node pool.
+    method Delete {
+    }
+}