Carrier Billing APIs Readiness Checklist MetaRelase Fall24

documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md

@@ -0,0 +1,27 @@
+# API Readiness Checklist
+
+Checklist for Carrier Billing Refund v0.1.0 in r1.1
+
+| Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+|  1 | API definition                               |   M   |         M         |    M    |    M   |  Y   | [link](/code/API_definitions/carrier_billing_refund.yaml) |
+|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |  Y   |      |
+|  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   | link |
+|  6 | User stories                                 |   O   |         O         |    O    |    M   |  N   | link |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  N   | link |
+|  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |  N   | link |
+|  9 | Test result statement                        |   O   |         O         |    O    |    M   |  N   | link |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   |      |
+| 11 | Change log updated                           |   M   |         M         |    M    |    M   |  Y   | link |
+| 12 | Previous public release was certified        |   O   |         O         |    O    |    M   |  N   |      |
+
+To fill the checklist:
+- in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release.
+- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.
+- in the Comments column, provide the link to the asset once available, and any other relevant comments.
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/x/HQBFAQ)

documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md

@@ -1,13 +1,27 @@
-# Carrier Billing API Readiness minimum criteria checklist
-
-<br>
-
-| No | Deliverables/Criteria             | Mandatory | Status (Contributed/Approved/Pending/Validated/Partly-Validated)|
-|----|-----------------------------------|-----------|------------------------|
-|  1 |API Spec                           |   Y       | Contributed            |
-|  2 |API Implementation                 |   Y       | Contributed            |
-|  3 |API Documentation                  |   Y       | Contributed            |
-|  4 |User Stories                       |   Y       | Contributed            |
-|  5 |API test cases                     |   Y       | Not Contributed        |
-|  6 |Validated by at least 2 operators  |   Y       | N/A                    |
-|  7 |Security review                    |   N       | Contributed            |
+# API Readiness Checklist
+
+Checklist for Carrier Billing v0.3.0 in r1.1.
+
+| Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
+|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
+|  1 | API definition                               |   M   |         M         |    M    |    M   |  Y   | [link](/code/API_definitions/carrier_billing.yaml) |
+|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |  Y   |      |
+|  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   | link |
+|  6 | User stories                                 |   O   |         O         |    O    |    M   |  Y   | link |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  N   | link |
+|  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |  N   | link |
+|  9 | Test result statement                        |   O   |         O         |    O    |    M   |  N   | link |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   |      |
+| 11 | Change log updated                           |   M   |         M         |    M    |    M   |  Y   | link |
+| 12 | Previous public release was certified        |   O   |         O         |    O    |    M   |  N   |      |
+
+To fill the checklist:
+- in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release.
+- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.
+- in the Comments column, provide the link to the asset once available, and any other relevant comments.
+
+Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
+
+The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/x/HQBFAQ)