Scope for Spring25 release

[hdamker]

Problem description

This issue should describe the scope for the next versions of the APIs within the QualityOnDemand, targeting the Spring25 meta-release.

Expected action

Target versions (tbd)

• quality-on-demand 1.0.0
• qos-profiles 1.0.0
• qos-provisioning 0.2.0

Targets for Spring25 (proposed/to be discussed)

• "Stabilisation", with target to release the first stable version (Prio1)
  • Correction of flaws in the definition
  • Clarification and improvement of documentation
  • Incorporation of feedback from implementations
  • Alignment with Commonalities & ICM changes for Spring25
• Enhancements (Prio2)

Issues with fixes in Spring25 scope:

• Fixes done in scope of Scope for potential patch release r1.3 (v0.11.1/v0.1.1) #368

  • Authorization and Authentication section need to be aligned with ICM 0.2.0 text. #361
  • Local links within API documentation have to be release specific #363
  • Add user story for QoS Profile #341
  • Add explanation on why there is a "POST /retrieve-sessions" instead of GET #359
  • Temporary solution for Support of Multi-SIM lines in QoD APIs #362 with description of current to be expected behavior in Add guidance for multi-SIM scenarios #378

• Alignment with Commonalities 0.5.0 of Spring25 release cycle

  • Update error codes in API definitions and test cases #390
  • Update "Identifying a device from the access token" section #392
  • Both addressed in PR Update error responses and test cases to comply with Commonalities 0.5.0 #391

• Further alignment with Commonalities r2.2 and ICM r2.2

  • Alignment of QoD APIs with Commonalities release r2.2 #403
    • Apply the common artifacts for testing error scenarios for device and phoneNumber #404 in Use common artifact for device test scenarios #400
    • Add string patter to x-correlator scheme #405 in Added string pattern to x-correlator definitions #406
    • Align 429 error reponses with CAMARA_common.yaml of Commonalities r2.2 #411 in Update 429 error responses to align with Commonalities 0.5.0-rc.1 changes #412
  • Apply the changes from ICM 0.3.0 on mandatory "Authorization" section. #408

• Further corrections and review issues

  • Update examples for startedAt values in qod-provisioning.yaml #389 (done in Update error responses and test cases to comply with Commonalities 0.5.0 #391)
  • Add a simple explanation of what a QoS profile is #393 with PR Updating the intro to the QoS Profile. #395
  • Correct example in qod-provisioning-createProvisioning.feature #394
  • Adapt logic to identify the device from the access token to QoS Profiles #399 in Adapt text on identifying devices from the access token for qos-profiles.yaml #410
  • Replace terms CSP -> API provider, API invoker -> API Consumer where appropriate #402

• Enhancements

  • Add support for DSCP markings for QoD sessions #173 with PR Add L4S/DSCP support to QoS Profile #384

• Still under discussion, potentially to be included after release candidate version

  • Review Attribute Descriptions with References to External Specifc #286 - see also comment below

Issues moved into Backlog

• Support of Multi-SIM lines in QoD APIs #362 - no long-term solution yet available in Commonalities
• Extend the query capabilities for Qos Profiles #147
• Rework definition of QoS flow(s) #243

Potential new API qod-booking (separate repository)

• Potential enhancement of booking feature for qod-provision #337 - will be developed in a new repository, not within Spring25 timeframe

Backlog issues not in Spring25 scope (to be decided which of them can get even closed):

• Application IPs are not shared by OTT for QOD API #317 - discussion, no expected changes defined yet
• Potential alignment of duration format between quality-on-demand and qos-profiles #304 - not in scope of Commonalities for Spring25
• Providing developers with alternate to QoS profile #302
• Add Application Function Id (afId) or Sponsor Id #194 - obsolete, as access tokens are application provider specific
• Need to support ability to configure fallback qos #45 - potentially indirectly addressed by Extend the query capabilities for Qos Profiles #147

Additional context

[RandyLevensalor]

#243 was discussed to be included in the release. At the minimum to revise the documentation to clarify the attributes and usage, though breaking changes were discussed as well.

#286 will likely be included in this release. This is a documentation change and will be discussed further in Jan/Feb 2025 timeframe in a dedicated meeting.

[hdamker]

#286 will likely be included in this release. This is a documentation change and will be discussed further in Jan/Feb 2025 timeframe in a dedicated meeting.

@RandyLevensalor who will setup the meeting? QoD group or Commonalities?

[hdamker]

(comment added originally to the wrong issue):

We need to add the changes coming from Commonalities and ICM to the scope:

• error definitions
• changes for (implicit) subscriptions
• update of info.description texts
  Concrete issues to be created when the alpha releases of Commonalities and ICM are available.

[hdamker]

Changed the scope according to the discussion within QoD call on January 10th:

• Added new issues Correct example in qod-provisioning-createProvisioning.feature #394, Add a simple explanation of what a QoS profile is #393, Update examples for startedAt values in qod-provisioning.yaml #389, Update error codes in API definitions and test cases #390, and Update "Identifying a device from the access token" section #392 (Alignment to Commonalities 0.5.0 and corrections)
• Moved Support of Multi-SIM lines in QoD APIs #362, Extend the query capabilities for Qos Profiles #147, and Rework definition of QoS flow(s) #243 out of scope.
• Potential enhancement of booking feature for qod-provision #337 will be started as a new API within an own repository, but not be part of Spring25

[hdamker]

Added the further alignment and correction issues, which were discussed in QoD call on January 24th:

• Adapt logic to identify the device from the access token to QoS Profiles #399
• Replace terms CSP -> API provider, API invoker -> API Consumer where appropriate #402
• Alignment of QoD APIs with Commonalities release r2.2 #403
  • Apply the common artifacts for testing error scenarios for device and phoneNumber #404
  • Add string patter to x-correlator scheme #405
• Apply the changes from ICM 0.3.0 on mandatory "Authorization" section. #408

[hdamker]

Added #411 together with its PR #412