Skip to content

Add support for a human‑readable name in Dedicated Network instances #92

@sergiobrisio

Description

@sergiobrisio

Problem description
During alignment in the Dedicated Network working group (Camara), it was highlighted that the introduction of the new endpoint dedicated-network-areas solves the circular reference issue created by the original serviceArea object in the Dedicated Network API.

However, the removal of the free‑text serviceArea field unintentionally eliminates the only available place for API Consumers to store a human‑readable name associated with a created Dedicated Network instance.
This creates a functional gap:

API Providers and Consumers need a user‑friendly identifier for a dedicated network instance (e.g., “FactoryFloorAreaNetwork”, "DNNforLaptops"etc.).

The exposure of profileId / networkProfileId / qosProfileName / serviceAreaId in uuid format is insufficient for readability and for operational UIs.
Today there is no field where such a name can be stored.

Possible evolution
Introduce a new (optional?) attribute:

name:
  type: string
  description: Human‑readable name of the dedicated network instance.

The field should be added in NetworkInfo, as this object represents the instantiated network and already groups dynamic attributes such as state, start/end time, and identifiers.


Requested Change
Add name to NetworkInfo schema:

NetworkInfo:
  description: Current dedicated network information
  type: object
  properties:
    name:
      type: string
      description: A human-readable name for the dedicated network instance.

Alternative solution
Alternatively, if the group prefers, it may be added in BaseNetworkInfo, but attaching it to NetworkInfo seems more coherent, since the name applies to the created resource rather than the generic creation request.

Additional context
Once approved, I will open a PR adding the field to the dedicated-network YAML file and updating documentation accordingly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions