Update doc and models for display_label (#7442)

* Adjust all example in the doc + add topic section

* Remove all display_labels in base

* Ip fabric

* nautobot1

* Round of refactoring

* netbox

* Refactor the rest

Author: BaptisteGi

docs/docs/guides/artifact.mdx

@@ -25,8 +25,7 @@ version: "1.0"
 nodes:
   - name: Device
     namespace: Network
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     inherit_from:
       - CoreArtifactTarget
     attributes:

docs/docs/guides/computed-attributes.mdx

@@ -93,8 +93,7 @@ version: "1.0"
 nodes:
   - name: Site
     namespace: Location
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text
@@ -108,8 +107,7 @@ nodes:
 
   - name: Circuit
     namespace: Infra
-    display_labels:
-      - circuit_id__value
+    display_label: "{{ circuit_id__value }}"
     attributes:
       - name: circuit_id
         kind: Text
@@ -131,8 +129,7 @@ nodes:
   - name: CircuitEndpoint
     namespace: Infra
     label: Circuit endpoint
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text

docs/docs/guides/generator.mdx

@@ -129,8 +129,7 @@ nodes:
     label: Widget
     human_friendly_id:
       - name__value
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text
@@ -143,8 +142,7 @@ nodes:
     label: Resource
     human_friendly_id:
       - name__value
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text

docs/docs/guides/jinja2-transform.mdx

@@ -26,8 +26,7 @@ version: "1.0"
 nodes:
   - name: Device
     namespace: Network
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text

docs/docs/guides/object-template.mdx

@@ -33,8 +33,7 @@ nodes:
     label: "Interface"
     include_in_menu: true
     icon: "mdi:ethernet"
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     order_by:
       - name__value
     uniqueness_constraints:
@@ -64,8 +63,7 @@ nodes:
     human_friendly_id: ["name__value"]
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text
@@ -87,8 +85,7 @@ nodes:
     human_friendly_id: ["name__value"]
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text

docs/docs/guides/profiles.mdx

@@ -42,8 +42,7 @@ nodes:
     generate_profile: true # Enable profile generation (default)
     include_in_menu: true
     icon: "mdi:ethernet"
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     order_by:
       - name__value
     attributes:

docs/docs/guides/python-transform.mdx

@@ -28,8 +28,7 @@ version: "1.0"
 nodes:
   - name: Device
     namespace: Network
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text

docs/docs/guides/resource-manager.mdx

@@ -55,8 +55,7 @@ generics:
     include_in_menu: false
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text
@@ -95,8 +94,7 @@ nodes:
     include_in_menu: true
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text
@@ -116,8 +114,7 @@ nodes:
     human_friendly_id: ["name__value"]
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text

docs/docs/topics/schema-attr-kind-number-pool.mdx

@@ -27,8 +27,7 @@ generics:
     default_filter: name__value
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text
@@ -119,8 +118,7 @@ generics:
     default_filter: name__value
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text

docs/docs/topics/schema.mdx

@@ -587,6 +587,41 @@ Order uniqueness constraint elements from most selective (returning fewer matche
 
 :::
 
+### Display Label
+
+The `display_label` property allows you to define a custom label for nodes in the Infrahub UI. This label is used in various parts of the interface, such as list views and detail views, to provide a more user-friendly representation of the node.
+
+The `display_label` supports template syntax, allowing you to combine multiple attributes and relationships to create a meaningful label.
+
+Display label value is automatically computed and saved when the object is created or updated.
+
+In the example below, the `display_label` for the `DcimCircuit` node is defined to show both the `reference_id` attribute and `provider` relationship.
+
+```yaml {4} showLineNumbers
+nodes:
+  - name: Circuit
+    namespace: Dcim
+    display_label: "{{ reference_id__value }} ({{ provider__name__value }})"
+    attributes:
+      - name: reference_id
+        kind: Text
+        unique: true
+    relationships:
+      - name: provider
+        peer: DcimProvider
+        optional: false
+        cardinality: one
+```
+
+:::success
+This will create a display label like `CIR12345 (ProviderName)`.
+:::
+
+:::warning Limitations
+Relationships used in the `display_label` must be of cardinality `one`.
+Display label supports only one level of relationships.
+:::
+
 ### Human friendly identifier (hfid)
 
 In addition to the internal ID automatically generated for each object (UUID), Infrahub provide a way to define a set of fields that will constitute a human friendly identifier (HFID).
@@ -716,8 +751,7 @@ generics:
     default_filter: name__value
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: "{{ name__value }}"
     attributes:
       - name: name
         kind: Text
@@ -798,7 +832,7 @@ nodes:
 #### List of inheritable properties
 
 - **human_friendly_id**: A user-friendly identifier for the entity.
-- **display_labels**: Labels used for display purposes.
+- **display_label**: Label used for display purposes.
 - **default_filter**: The default filter applied to the entity.
 - **menu_placement**: Defines where the entity appears in menus.
 - **uniqueness_constraints**: Constraints ensuring unique values for certain attributes.