Release r1.2 (Fall'25 M4)

CHANGELOG.MD

@@ -1,7 +1,8 @@
 # Changelog Subscription Status
 
 ## Table of Contents
-- **[r1.1](#r11)**
+- **[r1.2](#r12)**
+- [r1.1](#r11)
 
 **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.**
 
@@ -13,6 +14,41 @@ The below sections record the changes for each API version in each release as fo
 * for a public release, the consolidated changes since the previous public release
 
 
+# r1.2
+
+## Release Notes
+
+
+This public release contains the definition and documentation of
+* subscription-status v0.1.0
+
+The API definition(s) are based on
+* Commonalities [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3)
+* Identity and Consent Management [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3)
+
+
+## subscription-status v0.1.0
+
+ API definition **with inline documentation**:
+[[YAML]](https://github.com/camaraproject/SubscriptionStatus/blob/r1.2/code/API_definitions/subscription-status.yaml)
+[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.2/code/API_definitions/subscription-status.yaml&nocors)
+[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.2/code/API_definitions/subscription-status.yaml)
+
+**Initial contribution of API definitions for Subscription Status**, including initial documentation.
+
+## Added
+* Initial yaml file including Subscription Status API by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/6
+* Add test file by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/9
+* Add text on undocumented errors to OAS definition by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13
+
+## Removed
+* Remove AUTHENTICATION_REQUIRED error code by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13
+
+## Changed
+* Update x-correlator format by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13
+
+**Full Changelog**: https://github.com/camaraproject/SubscriptionStatus/commits/r1.2
+
 # r1.1
 
 ## Release Notes

README.md

@@ -23,22 +23,11 @@ Sandbox API Repository to describe, develop, document, and test the Subscription
 
 ## Release Information
 
-The repository has no (pre)releases yet, work in progress is within the main branch.
-<!-- Optional: an explicit listing of the latest (pre-)release with additional information, e.g. links to the API definitions -->
-<!-- In addition use/uncomment one or multiple the following alternative options when becoming applicable -->
-<!-- Pre-releases of this sub project are available in https://github.com/camaraproject/SubscriptionStatus/releases -->
-<!-- The latest public release is available here: https://github.com/camaraproject/SubscriptionStatus/releases/latest -->
-<!-- For changes see [CHANGELOG.md](https://github.com/camaraproject/SubscriptionStatus/blob/main/CHANGELOG.md) -->
-
-
-* Note: Please be aware that the project will have 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 available release**.
-
- * Pre-release r1.1 with version 0.1.0-rc.1 of the API subscription-status is available [here](https://github.com/camaraproject/SubscriptionStatus/tree/r1.1).
-
- <br>This is a release candidate version of the API. Until the public release there are bug fixes to be expected. The release candidate is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
-  [[YAML]](https://github.com/camaraproject/SubscriptionStatus/blob/r1.1/code/API_definitions/subscription-status.yaml)
-  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml&nocors)
-  [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml)
+ * **NEW**: Public release [r1.2](https://github.com/camaraproject/SubscriptionStatus/releases/tag/r1.2) with subscription-status v0.1.0 is now available.
+  * API definition **with inline documentation**:
+  [[YAML]](https://github.com/camaraproject/SubscriptionStatus/blob/r1.2/code/API_definitions/subscription-status.yaml)
+  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.2/code/API_definitions/subscription-status.yaml&nocors)
+  [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.2/code/API_definitions/subscription-status.yaml)
 
 * For changes see [CHANGELOG.md](https://github.com/camaraproject/SubscriptionStatus/blob/main/CHANGELOG.md)
 

code/API_definitions/subscription-status.yaml

@@ -68,7 +68,7 @@ info:
     The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
     In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.
 
-  version: 0.1.0-rc.1
+  version: 0.1.0
 
   x-camara-commonalities: 0.6
   license:
@@ -78,7 +78,7 @@ externalDocs:
   description: Product documentation at CAMARA
   url: https://github.com/camaraproject/SubscriptionStatus
 servers:
-  - url: "{apiRoot}/subscription-status/v0.1rc1"
+  - url: "{apiRoot}/subscription-status/v0.1"
     variables:
       apiRoot:
         default: http://localhost:9091
@@ -194,10 +194,10 @@ components:
           description: HTTP response status code
         code:
           type: string
-          description: Code given to this error
+          description: A human-readable code to describe the error
         message:
           type: string
-          description: Detailed error description
+          description: A human-readable description of what the event represents
   responses:
     Generic400:
       description: Bad Request

code/Test_definitions/subscription-status.feature

@@ -1,7 +1,8 @@
-Feature: CAMARA SubscriptionStatus API, v0.1.0-rc.1 - Retrieve subscription status of a phone number
+Feature: CAMARA SubscriptionStatus API, v0.1.0 - Retrieve subscription status of a phone number
 
   Background: Common setup
-    Given the resource "/subscription-status/v0.1rc1/retrieve-subscription-status"
+    Given an environment at "apiRoot"
+    And the resource "/subscription-status/v0.1/retrieve-subscription-status"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"

documentation/API_documentation/subscription-status-API-Readiness-Checklist.md

@@ -1,13 +1,13 @@
 # API Readiness Checklist
 
-Checklist for subscription-status v0.1.0-rc.1 in r1.1
+Checklist for subscription-status v0.1.0 in r1.2
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
 |  1 | API definition                               |   M   |         M         |    M    |    M   |  Y   | [link](/code/API_definitions/subscription-status.yaml) |
-|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |  Y   | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) |
-|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |  Y   | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) |
-|  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |   Y  | v0.1.0-rc.1     |
+|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |   Y   | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3)  |
+|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |   Y   | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3)   |
+|  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |   Y  | v0.1.0     |
 |  5 | API documentation                            |   M   |         M         |    M    |    M   |   Y  | Embed documentation into API spec - [link](/code/subscription-status.yaml) |
 |  6 | User stories                                 |   O   |         O         |    O    |    M   |   N  | 	 |		
 |  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |   Y  | [link](/code/Test_definitions/subscription-status.feature)  |
@@ -16,4 +16,4 @@ Checklist for subscription-status v0.1.0-rc.1 in r1.1
 | 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |   Y  |      |
 | 11 | Change log updated                           |   M   |         M         |    M    |    M   |   Y  | [link](/CHANGELOG.md) |
 | 12 | Previous public release was certified        |   O   |         O         |    O    |    M   |   N  |      |
-| 13 | API description (for marketing)              |   O   |         O         |    M    |    M   |      | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/hACbBQ) |
+| 13 | API description (for marketing)              |   O   |         O         |    M    |    M   |   Y  | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/hACbBQ) |