5G-MAG / rt-common-shared

Tools common to various projects
Other
3 stars 7 forks source link

Uplift to TS 26.512 v17.4.0: Update 5GMS OpenAPI YAML overrides #22

Closed davidjwbbc closed 1 year ago

davidjwbbc commented 1 year ago

Context

3GPP SA4 has agreed CR0032r1 [S4-230267] to update TS 26.512 Rel-17. This will hopefully be approved at SA#99 Plenary as part of the CR Pack SP-230253.

One part of these changes is the introduction of multiple entry point paths, up to one per distributionConfiguration, instead of just a single entryPointPath in the ContentHostingConfiguration. This is a compatibility breaking change in the specification which affects the interfaces at reference points M1 and M5.

The new OpenAPI YAML for TS26512_M1_ContentHostingProvisioning.yaml removes entryPointPath at the top level on the ContentHostingConfiguration object and introduces a new optional distributionConfigurations[].entryPoint object. This new entryPoint object has 3 properties:

The TS26512_M5_ServiceAccessInformation.yaml OpenAPI YAML remove the old single mediaPlayerEntry and replaces it with a new entryPoints array. Each entry in the array is an object with 3 properties:

The M3 interface definition references the ContentHostingConfiguration schema from TS26512_M1_ContentHostingProvisioning.yaml. The M3 interface OpenAPI YAML should increment its version number to indicate the inclusion of the new ContentHostingConfiguration.

Changes

  1. Install the v17.4.0 TS26512_M1_ContentHostingProvisioning.yaml in 5gms/5G_APIs-overrides
  2. Install the v17.4.0 TS26512_M5_ServiceAccessInformation.yaml in 5gms/5G_APIs-overrides
  3. Install the v17.4.0 TS26512_CommonData.yaml in 5gms/5G_APIs-overrides
  4. Update the version number in 5gms/5G_APIs-overrides/M3_ContentHostingProvisioning.yaml to indicate the inclusion of the new structure, i.e. change the version number to 0.1.0.

Related issues

This is a prerequisite for 5G-MAG/rt-5gms-application-function#51 and 5G-MAG/rt-5gms-application-server#??.