AreaType definition clash with common AreaType

[tanjadegroot]

Problem description
The QoSBooking API extends the AreaType schema which is defined by Commonalities. without renaming the schema to a local one.

Expected behavior
Quick fix: Rename the local AreaType schema to e.g. QosAreaType.
However, please consider Alternative solutions 1 & 2 below before going with the local schema, possibly in combination with Alternative solution 1.

Alternative solution

Alternative solution 1:

Using AreaName as an extension of AreaType (which refers to a geographical shape) is not the most logical way of addressing Areas. I would rather see that one can give a name to an Area. This would imply

• an additional string type attribute to the common Area schema, called areaName of type AreaName (string)
• an additional common type AreaName
• an additional enum value in the generic AreaType schema called 'FREE_GEOGRAPHICAL_SHAPE', which does not require to have actual geographic coordinates, but where the name would allow identifying the actual area (e.g. Spain, some region name, etc)

This would need an update of the CAMARA_common.yaml as well.

Alternative solution 2:

The dedicated-network-areas API provides a lot of the same and more service-area handling.
This APi is in the same API Sub Project: Connectivity Quality Management.

We could generalize the dedicated-network-areas API by renaming and adapting it to manage service-areas in general and adapt the CAMARA_common schemas accordingly. Then, if still needed, an API could create API specific extensions of the common schema.

This API could move to its own repository.

Probably many future CAMARA APIs / appllications could use the generic service-area concept.

For info: @hdamker @tlohmar @rartych

[hdamker]

@tanjadegroot renaming and generating dedicated-network-areas is already planned, see camaraproject/APIBacklog#325 and camaraproject/APIBacklog#328, it will happen after M3 (using the rc of dedicated-network-areas as the transfer state).

[Masa8106]

@tanjadegroot, thank you for your review. I will rename the local AreaType at the M3 timing. And we are now discussing that we will utilize the dedicated-network-areas API after its generalization.