camaraproject · clundie-CL · Jun 29, 2026 · Jun 29, 2026
@@ -50,38 +50,38 @@
        description: TMF673 Geographic Address Management API User Guide v4.0.0
        url: https://www.tmforum.org/resources/specification/tmf673-geographic-address-management-api-user-guide-v4-0-0/
      properties:
        id:
          type: string
          description: The unique identifier for the property address
          minLength: 1
          maxLength: 64
          example: &property-address-id "address-123"
        addressLine1:
          type: string
          maxLength: 128
          description: The first line of the address
          example: &property-address-address-line-1 "123 Main St"
        addressLine2:
          type: string
          maxLength: 128
          description: The second line of the address
          example: &property-address-address-line-2 "Suite 456"
        streetNr:
          type: string
          maxLength: 64
          description: The street number
          example: &property-address-street-nr "123"
        streetNrSuffix:
          type: string
          maxLength: 64
          description: The suffix for the street number
          example: &property-address-street-nr-suffix "A"
        streetNrLast:
          type: string
          maxLength: 64
          description: The last street number
          example: &property-address-street-nr-last "125"
        streetNrLastSuffix:
          type: string
          maxLength: 64
          description: The suffix for the last street number
@@ -178,7 +178,8 @@
       properties:
         id:
           allOf:
-            - $ref: "#/components/schemas/UUID"
+            - $ref: "#/components/schemas/Uuid"
+          description: Unique identifier of the resource.
           readOnly: true
       required:
         - id
@@ -190,36 +191,36 @@
         createdAt:
           allOf:
             - $ref: "#/components/schemas/DateTime"
-            - description: |
-                The creation date and time of the trust domain.  It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
-                and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
-                2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z).
-            - readOnly: true
+          description: |
+            The creation date and time of the resource.  It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
+            and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
+            2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z).
+          readOnly: true
         createdBy:
           allOf:
-            - $ref: "#/components/schemas/UUID"
+            - $ref: "#/components/schemas/Uuid"
           description: |
             The ID of the user or system that created this resource.
           example: "550e8400-e29b-41d4-a716-446655440000"
           readOnly: true
         modifiedAt:
           allOf:
             - $ref: "#/components/schemas/DateTime"
-            - description: |
-                The last update date and time of the trust domain.  It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
-                and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
-                2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z).
-            - readOnly: true
+          description: |
+            The last update date and time of the resource.  It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
+            and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
+            2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z).
+          readOnly: true
         modifiedBy:
           allOf:
-            - $ref: "#/components/schemas/UUID"
+            - $ref: "#/components/schemas/Uuid"
           description: |
             The ID of the user or system that modified this resource.
           example: "660e8400-e29b-41d4-a716-446655440000"
           readOnly: true
       description: A generic schema for resources with unique identifiers and audit fields.
 
-    UUID:
+    Uuid:
       type: string
       format: uuid
       pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$'

@@ -42,7 +42,7 @@ components:
         Must be a valid UUID as defined by RFC 4122 (versions 1-5) using only lowercase hexadecimal characters.
       required: true
       schema:
-        $ref: "../NAM_Common.yaml#/components/schemas/UUID"
+        $ref: "../NAM_Common.yaml#/components/schemas/Uuid"
   schemas:
     NetworkAccessDevice:
       description: |

@@ -19,7 +19,7 @@ components:
       in: path
       required: true
       schema:
-        $ref: "../NAM_Common.yaml#/components/schemas/UUID"
+        $ref: "../NAM_Common.yaml#/components/schemas/Uuid"
       description: ID of the Reboot Request. If the Reboot Request exists but the caller lacks permission to access it, the API returns 403.
 
   schemas:
@@ -35,11 +35,11 @@ components:
         atTime:
           allOf:
             - $ref: "../NAM_Common.yaml#/components/schemas/DateTime"
-            - description: |
-                The date and time to reboot the device. Do not include 'atTime' to request immediate reboot.  It must
-                follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
-                Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or
-                2023-07-03T12:27:08.312Z).
+          description: |
+            The date and time to reboot the device. Do not include 'atTime' to request immediate reboot.  It must
+            follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
+            Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or
+            2023-07-03T12:27:08.312Z).
 
     RebootRequestCreate:
       description: Represents the creation of a reboot request, including target devices and optional scheduling. If devices is omitted, the provider MAY infer a default device. Inference rules vary by implementation. If inference is unsupported or ambiguous, creation MUST fail.
@@ -49,7 +49,7 @@ components:
             devices:
               type: array
               items:
-                $ref: "../NAM_Common.yaml#/components/schemas/UUID"
+                $ref: "../NAM_Common.yaml#/components/schemas/Uuid"
               maxItems: 100
               description: >-
                 List of devices to reboot. When undefined, the reboot targets the 'default' device (simple use case that
@@ -86,11 +86,13 @@ components:
   examples:
     RebootRequestCreateImmediateDefaultDevice:
       summary: Example of a Reboot Request for immediate reboot
+      description: Request an immediate reboot of the inferred default device by omitting 'atTime' and 'devices'.
       value:
         message: "reboot to correct performance"
 
     RebootRequestCreateScheduledMultipleDevices:
       summary: Example of a Reboot Request for scheduled reboot of multiple devices
+      description: Request a scheduled reboot of multiple explicitly listed devices at a future 'atTime'.
       value:
         message: "Scheduled reboot for maintenance"
         atTime: *date-time

@@ -33,7 +33,8 @@ components:
       properties:
         id:
           allOf:
-            - $ref: "../NAM_Common.yaml#/components/schemas/UUID"
+            - $ref: "../NAM_Common.yaml#/components/schemas/Uuid"
+          description: Unique identifier of the service site.
           readOnly: true
         name:
           type: string

@@ -44,7 +44,7 @@ components:
   schemas:
     ServiceId:
       allOf:
-        - $ref: "../NAM_Common.yaml#/components/schemas/UUID"
+        - $ref: "../NAM_Common.yaml#/components/schemas/Uuid"
       description: |
         A unique identifier that represents a service account associated with this resource.
 

@@ -47,7 +47,7 @@ components:
       in: path
       required: true
       schema:
-        $ref: "../NAM_Common.yaml#/components/schemas/UUID"
+        $ref: "../NAM_Common.yaml#/components/schemas/Uuid"
       description: |
         The unique identifier of the Trust Domain Device. If the device exists but the caller
         lacks permission to access it, the API returns 403.
@@ -184,12 +184,12 @@ components:
         selectedProtocol:
           allOf:
             - $ref: "#/components/schemas/BootstrappingProtocol"
-            - readOnly: true
-              description: |
-                The bootstrapping protocol selected by the server for onboarding this
-                device. Present only in responses. Determined by intersecting the
-                device's configured protocols with the Trust Domain's capabilities,
-                respecting protocolPreference ordering if provided.
+          readOnly: true
+          description: |
+            The bootstrapping protocol selected by the server for onboarding this
+            device. Present only in responses. Determined by intersecting the
+            device's configured protocols with the Trust Domain's capabilities,
+            respecting protocolPreference ordering if provided.
         DPP:
           $ref: "#/components/schemas/DppBootstrappingConfig"
         MATTER:
@@ -239,11 +239,11 @@ components:
         selectedType:
           allOf:
             - $ref: "#/components/schemas/CredentialType"
-            - readOnly: true
-              description: |
-                The credential type the server selected. Present only in responses.
-                Determined by matching supportedTypes against the Trust Domain's
-                access configuration.
+          readOnly: true
+          description: |
+            The credential type the server selected. Present only in responses.
+            Determined by matching supportedTypes against the Trust Domain's
+            access configuration.
 
     AssignDeviceCredential:
       type: object
@@ -338,39 +338,39 @@ components:
         bootstrappingInfo:
           allOf:
             - $ref: "#/components/schemas/BootstrappingInfo"
-            - description: |
-                Provisioning protocol configurations that define how this device can be
-                onboarded to the Trust Domain. Each property identifies a bootstrapping
-                protocol and its configuration. A device may support multiple protocols.
-                Use `protocolPreference` to express the device's preferred protocol ordering
-                for deterministic server selection.
-
-                **Update Semantics**
-                - On update (PATCH), the object replaces the previous object entirely when
-                  included. Partial merge semantics are not defined; clients MUST supply the
-                  complete desired configuration for this field.
+          description: |
+            Provisioning protocol configurations that define how this device can be
+            onboarded to the Trust Domain. Each property identifies a bootstrapping
+            protocol and its configuration. A device may support multiple protocols.
+            Use `protocolPreference` to express the device's preferred protocol ordering
+            for deterministic server selection.
+
+            **Update Semantics**
+            - On update (PATCH), the object replaces the previous object entirely when
+              included. Partial merge semantics are not defined; clients MUST supply the
+              complete desired configuration for this field.
         deviceCredential:
           $ref: "#/components/schemas/DeviceCredential"
 
     TrustDomainDeviceCreate:
       allOf:
         - $ref: "#/components/schemas/TrustDomainDeviceUpdate"
+        - properties:
+            externalId:
+              type: string
+              minLength: 1
+              maxLength: 255
+              description: |
+                A manufacturer or user-assigned identifier for the device (e.g., serial number,
+                model code, or asset tag). This is distinct from the system-generated UUID `id`
+                and can be used for cross-referencing the device with external systems.
+              example: "SN-12345-ABCDE"
       description: |
         Represents the creation payload for registering a new device to a Trust Domain.
         Extends TrustDomainDeviceUpdate with additional creation-only fields and required field constraints.
       required:
         - deviceName
         - enabled
-      properties:
-        externalId:
-          type: string
-          minLength: 1
-          maxLength: 255
-          description: |
-            A manufacturer or user-assigned identifier for the device (e.g., serial number,
-            model code, or asset tag). This is distinct from the system-generated UUID `id`
-            and can be used for cross-referencing the device with external systems.
-          example: "SN-12345-ABCDE"
 
     TrustDomainDevice:
       allOf:
@@ -430,6 +430,7 @@ components:
 
     TrustDomainDeviceCreateIoT:
       summary: Register an IoT device with DPP bootstrapping and server-generated credential.
+      description: Registers an IoT device that bootstraps over DPP and requests a server-generated credential.
       value:
         deviceName: "Smart Thermostat"
         externalId: "SN-THERMO-001"
@@ -442,12 +443,14 @@ components:
 
     TrustDomainDeviceCreateMinimal:
       summary: Register a device with minimal required fields.
+      description: Registers a device supplying only the required fields (deviceName and enabled).
       value:
         deviceName: "Guest Laptop"
         enabled: true
 
     TrustDomainDeviceCreateMatter:
       summary: Register a Matter device.
+      description: Registers a Matter device that bootstraps using Matter onboarding information.
       value:
         deviceName: "Smart Light Bulb"
         externalId: "MATTER-BULB-42"

@@ -183,6 +183,7 @@ components:
           type: array
           items:
             type: string
+            description: A destination address format supported by the egress allowed list policy.
             enum: ["IP", "FQDN", "CIDR"]
           maxItems: 3
           description: Supported destination address formats
@@ -204,6 +205,7 @@ components:
           type: array
           items:
             type: string
+            description: A Wi-Fi security mode type supported by the API provider.
             enum:
               - "WPA2-Personal"
               - "WPA3-Personal"

@@ -64,7 +64,7 @@ components:
       in: path
       required: true
       schema:
-        $ref: "../NAM_Common.yaml#/components/schemas/UUID"
+        $ref: "../NAM_Common.yaml#/components/schemas/Uuid"
       description: ID of the Trust Domain. If the Trust Domain exists but the caller lacks permission to access it, the API returns 403.
 
   schemas:
@@ -90,12 +90,12 @@ components:
         expiration:
           allOf:
             - $ref: "../NAM_Common.yaml#/components/schemas/DateTime"
-            - description: |
-                The expiration date and time of the network.  It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
-                and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
-                2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z).
+          description: |
+            The expiration date and time of the network.  It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
+            and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
+            2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z).
 
-                If omitted, the trust domain will not automatically expire.
+            If omitted, the trust domain will not automatically expire.
         policies:
           $ref: "../Policy.yaml#/components/schemas/Policies"
         accessDetails:
@@ -140,15 +140,15 @@ components:
     TrustDomainCreate:
       allOf:
         - $ref: "#/components/schemas/TrustDomainUpdate"
+        - properties:
+            serviceId:
+              $ref: "../Services/Services.yaml#/components/schemas/ServiceId"
       description: Represents the creation of a new trust domain within the network access management system.
       required:
         - name
         - enabled
         - accessDetails
         - serviceId
-      properties:
-        serviceId:
-          $ref: "../Services/Services.yaml#/components/schemas/ServiceId"
 
     TrustDomain:
       allOf:
@@ -174,6 +174,7 @@ components:
 
     TrustDomainCreateWpa2Personal:
       summary: Create a Trust Domain with WPA2-Personal Wi-Fi access.
+      description: Creates a Trust Domain with a single WPA2-Personal Wi-Fi access detail that specifies an SSID.
       value:
         name: "Primary WiFi Network"
         description: "Request defines a Trust Domain with WPA2-Personal Wi-Fi access. The request specifies an SSID, implying the SSID is created on the network infrastructure."
@@ -184,6 +185,7 @@ components:
 
     TrustDomainCreateInferredSsid:
       summary: Create a Trust Domain with inferred SSID Wi-Fi access.
+      description: Creates a Trust Domain that omits the SSID, applying access to an existing SSID on the network infrastructure.
       value:
         name: "Inferred SSID Network"
         description: "Request defines a Trust Domain with inferred SSID Wi-Fi access. The request omits the SSID, implying the Trust Domain is applied to an existing SSID on the network infrastructure."
@@ -197,6 +199,7 @@ components:
 
     TrustDomainCreateEphemeral:
       summary: Create a Trust Domain with ephemeral access details.
+      description: Creates a time-limited Trust Domain using an 'expiration' timestamp and a max-devices policy.
       value:
         name: "Ephemeral Network"
         description: "Request defines a Trust Domain with ephemeral access details."
@@ -210,6 +213,7 @@ components:
 
     TrustDomainCreateThreadStructured:
       summary: Create a Trust Domain with Thread structured access details.
+      description: Creates a Trust Domain with a Thread structured access detail.
       value:
         name: "Thread Structured Network"
         description: "Request defines a Trust Domain with Thread structured access details."
@@ -220,6 +224,7 @@ components:
 
     TrustDomainCreateQoSPolicies:
       summary: Create a Trust Domain with QoS policies.
+      description: Creates a Trust Domain with bandwidth QoS policies applied to the domain.
       value:
         name: "QoS Policy Network"
         description: "Request defines a Trust Domain with QoS policies."