Merge pull request #129 from camaraproject/prepare-sim-swap-subscript…

…ions Prepare sim swap subscriptions in alpha version for the meta release
camaraproject · Jul 30, 2024 · 4b6da4d · 4b6da4d
2 parents 53e3be0 + d1bf871
commit 4b6da4d
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/code/API_definitions/sim-swap-subscriptions.yaml b/code/API_definitions/sim-swap-subscriptions.yaml
@@ -64,12 +64,13 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.1.0-alpha.1
+
 externalDocs:
   description: Product documentation at CAMARA
   url: https://github.com/camaraproject/
 servers:
-  - url: '{apiRoot}/sim-swap-subscriptions/v0'
+  - url: '{apiRoot}/sim-swap-subscriptions/v0.1alpha1'
     variables:
       apiRoot:
         default: http://localhost:9091

diff --git a/...PI_documentation/API-Readiness-Checklist_sim-swap-subscriptions-0.1.0.alpha1.md b/...PI_documentation/API-Readiness-Checklist_sim-swap-subscriptions-0.1.0.alpha1.md
@@ -0,0 +1,20 @@
+# API Readiness Checklist
+
+Checklist for sim-swap-subscriptions 0.1.0-alpha.1 in FALL24
+
+
+| 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/sim-swap-subscriptions.yaml) |
+|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |  Y   |  Y     |
+|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |  Y   |  Y  |
+|  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |  Y   |  Y  |
+|  5 | API documentation                            |   M   |         M         |    M    |    M   |  Y   | contained in API definition |
+|  6 | User stories                                 |   O   |         O         |    O    |    M   |  Y   | Not Relevant (NR)   |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  N   | NR |
+|  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |  N   | NR    |
+|  9 | Test result statement                        |   O   |         O         |    O    |    M   |  N   | NR   |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   |  Y    |
+| 11 | Change log updated                           |   M   |         M         |    M    |    M   |  N   | [link](/CHANGELOG.md) |
+
+| 12 | Previous public release was certified        |   O   |         O         |    O    |    M   |  N   | NR    |