camaraproject · hdamker · Dec 18, 2024 · Dec 7, 2024 · Dec 7, 2024 · Dec 7, 2024
@@ -1,7 +1,8 @@
 # Changelog QualityOnDemand
 
 ## Table of Contents
-- **[r1.2](#r12)**
+- **[r1.3](#r13)**
+- [r1.2](#r12)
 - [r1.1](#r11)
 - [v0.10.1](#v0101)
 - [v0.10.0](#v0100)
@@ -15,6 +16,89 @@
 
 **Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**
 
+# r1.3
+## Release Notes
+
+This patch release contains the definition and documentation of
+* quality-on-demand v0.11.1
+* qos-profiles v0.11.1
+* qod-provisioning v0.1.1
+
+The API definition(s) are based on
+* Commonalities v0.4.0
+* Identity and Consent Management v0.2.1
+
+Note: this release is a patch release, containing some clarifications and updates within the documentation. The API versions are fully backward-compatible to the ones in r1.2. Please see there for the main changes compared to previous 0.10.x release.
+
+## quality-on-demand v0.11.1
+
+quality-on-demand 0.11.1 is a patch version of 0.11.0 with documentation updates and clarifications. 
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/quality-on-demand.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/quality-on-demand.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/QualityOnDemand/blob/r1.3/code/API_definitions/quality-on-demand.yaml)
+
+### Added
+* Added guidance for multi-SIM scenarios in `ìnfo.description` by @eric-murray in https://github.com/camaraproject/QualityOnDemand/pull/378
+
+### Changed
+* Authorization and authentication section in `info.description` updated with text from Identity & Consent Management text v0.2.1 by @hdamker in https://github.com/camaraproject/QualityOnDemand/pull/370
+* Updated the note for the retrieve POST calls by @RandyLevensalor in https://github.com/camaraproject/QualityOnDemand/pull/372
+
+### Fixed
+* Documented that the error response QUALITY_ON_DEMAND.DURATION_OUT_OF_RANGE cannot be returned for /extend and will be removed within next version by @hdamker in https://github.com/camaraproject/QualityOnDemand/pull/382
+
+### Removed
+* n/a
+
+## qos-profiles v0.11.1
+
+qos-profiles 0.11.1 is a patch version of 0.11.0 with documentation updates and clarifications. 
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/qos-profiles.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/qos-profiles.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/QualityOnDemand/blob/r1.3/code/API_definitions/qos-profiles.yaml)
+
+### Added
+* Add QoS Profile User Story by @benhepworth in https://github.com/camaraproject/QualityOnDemand/pull/367
+* Added guidance for multi-SIM scenarios in `ìnfo.description` by @eric-murray in https://github.com/camaraproject/QualityOnDemand/pull/378
+
+### Changed
+* Authorization and authentication section in `info.description` updated with text from Identity & Consent Management text v0.2.1 by @hdamker in https://github.com/camaraproject/QualityOnDemand/pull/370
+* Updated the note for the retrieve POST calls by @RandyLevensalor in https://github.com/camaraproject/QualityOnDemand/pull/372
+
+### Fixed
+* n/a
+
+### Removed
+* n/a
+
+## qod-provisioning v0.1.1
+
+qod-provisioning v0.1.1 is a patch version of the first initial release of this new API.
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/qod-provisioning.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/qod-provisioning.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/QualityOnDemand/blob/r1.3/code/API_definitions/qod-provisioning.yaml)
+
+### Added
+* Added guidance for multi-SIM scenarios in `ìnfo.description` by @eric-murray in https://github.com/camaraproject/QualityOnDemand/pull/378
+
+### Changed
+* Authorization and authentication section in `info.description` updated with text from Identity & Consent Management text v0.2.1 by @hdamker in https://github.com/camaraproject/QualityOnDemand/pull/370
+* Updated the note for the retrieve POST calls by @RandyLevensalor in https://github.com/camaraproject/QualityOnDemand/pull/372
+
+### Fixed
+* n/a
+
+### Removed
+* n/a
+
+**Full Changelog**: https://github.com/camaraproject/QualityOnDemand/compare/r1.2...r1.3
+
 # r1.2
 ## Release Notes
 

@@ -26,22 +26,22 @@ Repository to describe, develop, document and test the QualityOnDemand API famil
 * Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest public release**.
 
 
-* **The latest public release is [r1.2](https://github.com/camaraproject/QualityOnDemand/tree/r1.2) with the following API definitions:**
+* **The latest public release is [r1.3](https://github.com/camaraproject/QualityOnDemand/tree/r1.3), a patch release of r1.2, with the following API definitions:**
 
-  * **quality-on-demand v0.11.0**  
-  [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r1.2/code/API_definitions/quality-on-demand.yaml)
-  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.2/code/API_definitions/quality-on-demand.yaml&nocors)
-  [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.2/code/API_definitions/quality-on-demand.yaml)
+  * **quality-on-demand v0.11.1**  
+  [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r1.3/code/API_definitions/quality-on-demand.yaml)
+  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/quality-on-demand.yaml&nocors)
+  [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/quality-on-demand.yaml)
 
-  * **qos-profiles v0.11.0**  
-  [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r1.2/code/API_definitions/qos-profiles.yaml)
-  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.2/code/API_definitions/qos-profiles.yaml&nocors)
-  [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.2/code/API_definitions/qos-profiles.yaml)
+  * **qos-profiles v0.11.1**  
+  [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r1.3/code/API_definitions/qos-profiles.yaml)
+  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/qos-profiles.yaml&nocors)
+  [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/qos-profiles.yaml)
 
-  * qod-provisioning v0.1.0 (new, first initial version)  
-  [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r1.2/code/API_definitions/qod-provisioning.yaml)
-  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.2/code/API_definitions/qod-provisioning.yaml&nocors)
-  [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.2/code/API_definitions/qod-provisioning.yaml)
+  * qod-provisioning v0.1.1 (new, first initial version)  
+  [[YAML]](https://github.com/camaraproject/QualityOnDemand/blob/r1.3/code/API_definitions/qod-provisioning.yaml)
+  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/qod-provisioning.yaml&nocors)
+  [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/code/API_definitions/qod-provisioning.yaml)
 
 * Previous releases and pre-releases are available here: https://github.com/camaraproject/QualityOnDemand/releases
 * For changes see [CHANGELOG.md](https://github.com/camaraproject/QualityOnDemand/blob/main/CHANGELOG.md)
@@ -55,7 +55,7 @@ Repository to describe, develop, document and test the QualityOnDemand API famil
 ## Contributing
 
 * Meetings are held virtually 
-  * Schedule: bi-weekly, Friday, 2 PM CET/CEST (13:00 UTC, 12:00 UTC during European DST). For date/time of the next meeting, see previous meeting minutes
+  * Schedule: bi-weekly, Friday, 13:00 UTC (14:00 CET, 15:00 CEST). For date/time of the next meeting, see previous meeting minutes
   * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/94112812156?password=f238d6af-c959-48d7-a862-abdb3c648e40)
   * Minutes: Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/XCPe)
 * Mailing List

@@ -70,15 +70,15 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.1.1
   x-camara-commonalities: 0.4.0
 
 externalDocs:
   description: Project documentation at CAMARA
   url: https://github.com/camaraproject/QualityOnDemand
 
 servers:
-  - url: "{apiRoot}/qod-provisioning/vwip"
+  - url: "{apiRoot}/qod-provisioning/v0.1"
     variables:
       apiRoot:
         default: http://localhost:9091

@@ -14,7 +14,7 @@ info:
     - Discovery of all QoS profiles offered by the network operator
     - Retrieve the characteristics of a specific QoS profile by name
 
-    How QoS profiles are mapped to connectivity characteristics are subject to agreements between the communication service provider and the API invoker. Within the CAMARA project, you can find a sample for such a mapping of QoS profiles. [CAMARA QoS Profiles Mapping Table (REFERENCE DRAFT)](https://github.com/camaraproject/QualityOnDemand/blob/main/documentation/API_documentation/QoSProfile_Mapping_Table.md)
+    How QoS profiles are mapped to connectivity characteristics are subject to agreements between the communication service provider and the API invoker. Within the CAMARA project, you can find a sample for such a mapping of QoS profiles. [CAMARA QoS Profiles Mapping Table (REFERENCE DRAFT)](https://github.com/camaraproject/QualityOnDemand/blob/r1.3/documentation/API_documentation/QoSProfile_Mapping_Table.md)
 
     # Authorization and authentication
 
@@ -62,7 +62,7 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.11.1
   x-camara-commonalities: 0.4.0
 
 
@@ -71,7 +71,7 @@ externalDocs:
   url: https://github.com/camaraproject/QualityOnDemand
 
 servers:
-  - url: "{apiRoot}/qos-profiles/vwip"
+  - url: "{apiRoot}/qos-profiles/v0.11"
     variables:
       apiRoot:
         default: http://localhost:9091

@@ -10,7 +10,7 @@ info:
 
     The QoD API offers the application developers the capability to request for stable latency (reduced jitter) or throughput for some specified application data flows between application clients (within a user device) and Application Servers (backend services). The developer has a pre-defined set of Quality of Service (QoS) profiles which they could choose from depending on their latency or throughput requirements.
 
-    ![QoD API Overview](https://raw.githubusercontent.com/camaraproject/QualityOnDemand/main/documentation/API_documentation/resources/QoD_latency_overview.PNG)
+    ![QoD API Overview](https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/documentation/API_documentation/resources/QoD_latency_overview.PNG)
 
     The usage of the API is based on QoS session resources, which can be created (based on available QoS profiles), queried and deleted. The deletion of a requested session can be triggered by the API consumer or can be triggered automatically once the QoS session has reached its limit.
 
@@ -54,7 +54,7 @@ info:
 
     Following diagram shows the interaction between different components
 
-    ![QoD Management API](https://raw.githubusercontent.com/camaraproject/QualityOnDemand/main/documentation/API_documentation/resources/QoD_details.PNG)
+    ![QoD Management API](https://raw.githubusercontent.com/camaraproject/QualityOnDemand/r1.3/documentation/API_documentation/resources/QoD_details.PNG)
 
     # Authorization and authentication
 
@@ -104,15 +104,15 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.11.1
   x-camara-commonalities: 0.4.0
 
 externalDocs:
   description: Project documentation at Camara
   url: https://github.com/camaraproject/QualityOnDemand
 
 servers:
-  - url: "{apiRoot}/quality-on-demand/vwip"
+  - url: "{apiRoot}/quality-on-demand/v0.11"
     variables:
       apiRoot:
         default: http://localhost:9091

@@ -1,4 +1,4 @@
-Feature: CAMARA QoD Provisioning API, v0.1.0 - Operation createProvisioning
+Feature: CAMARA QoD Provisioning API, v0.1.1 - Operation createProvisioning
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,4 +1,4 @@
-Feature: CAMARA QoD Provisioning API, v0.1.0 - Operation deleteProvisioning
+Feature: CAMARA QoD Provisioning API, v0.1.1 - Operation deleteProvisioning
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,4 +1,4 @@
-Feature: CAMARA QoD Provisioning API, v0.1.0 - Operation getProvisioningById
+Feature: CAMARA QoD Provisioning API, v0.1.1 - Operation getProvisioningById
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,4 +1,4 @@
-Feature: CAMARA QoD Provisioning API, v0.1.0 - Operation retrieveProvisioningByDevice
+Feature: CAMARA QoD Provisioning API, v0.1.1 - Operation retrieveProvisioningByDevice
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,4 +1,4 @@
-Feature: CAMARA QoS Profiles API, v0.11.0 - Operation getQosProfile
+Feature: CAMARA QoS Profiles API, v0.11.1 - Operation getQosProfile
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,4 +1,4 @@
-Feature: CAMARA QoS Profiles API, v0.11.0 - Operation retrieveQoSProfiles
+Feature: CAMARA QoS Profiles API, v0.11.1 - Operation retrieveQoSProfiles
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,4 +1,4 @@
-Feature: CAMARA Quality On Demand API, v0.11.0 - Operation createSession
+Feature: CAMARA Quality On Demand API, v0.11.1 - Operation createSession
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,4 +1,4 @@
-Feature: CAMARA Quality On Demand API, v0.11.0 - Operation deleteSession
+Feature: CAMARA Quality On Demand API, v0.11.1 - Operation deleteSession
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,4 +1,4 @@
-Feature: CAMARA Quality On Demand API, v0.11.0 - Operation extendQosSessionDuration
+Feature: CAMARA Quality On Demand API, v0.11.1 - Operation extendQosSessionDuration
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,4 +1,4 @@
-Feature: CAMARA Quality On Demand API, v0.11.0 - Operation getSession
+Feature: CAMARA Quality On Demand API, v0.11.1 - Operation getSession
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,4 +1,4 @@
-Feature: CAMARA Quality On Demand API, v0.11.0 - Operation retrieveSessionsByDevice
+Feature: CAMARA Quality On Demand API, v0.11.1 - Operation retrieveSessionsByDevice
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:

@@ -1,6 +1,6 @@
 # API Readiness Checklist
 
-Checklist for qod-provisioning v0.1.0 in r1.2
+Checklist for qod-provisioning v0.1.1 in r1.3
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|------|

@@ -1,6 +1,6 @@
 # API Readiness Checklist
 
-Checklist for qos-profiles v0.11.0 in r1.2
+Checklist for qos-profiles v0.11.1 in r1.3
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
@@ -9,7 +9,7 @@ Checklist for qos-profiles v0.11.0 in r1.2
 |  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |  Y   |      |
 |  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |  Y   |      |
 |  5 | API documentation                            |   M   |         M         |    M    |    M   |  Y   | inline within YAML |
-|  6 | User stories                                 |   O   |         O         |    O    |    M   |  N   |      |
+|  6 | User stories                                 |   O   |         O         |    O    |    M   |  Y   | [/documentation/API_documentation/QoSProfile_User_Story.md](/documentation/API_documentation/QoSProfile_User_Story.md) |
 |  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  Y   | [/code/Test_definitions](/code/Test_definitions) |
 |  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |  N   |      |
 |  9 | Test result statement                        |   O   |         O         |    O    |    M   |  N   |      |

@@ -1,6 +1,6 @@
 # API Readiness Checklist
 
-Checklist for quality-on-demand v0.11.0 in r1.2
+Checklist for quality-on-demand v0.11.1 in r1.3
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|