From 88bfc6fd1d780ae554fd15822fe4e9d7ca892e2b Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Wed, 29 May 2024 15:22:07 +0200 Subject: [PATCH 1/4] Update API-Readiness-Checklist.md --- documentation/API-Readiness-Checklist.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/documentation/API-Readiness-Checklist.md b/documentation/API-Readiness-Checklist.md index 8e045f2f..9ca5041a 100644 --- a/documentation/API-Readiness-Checklist.md +++ b/documentation/API-Readiness-Checklist.md @@ -1,5 +1,7 @@ # API Readiness minimum criteria checklist -| No | Deliverables/Criteria | Mandatory | Reference template | +**PLEASE NOTE: This document is deprecated as the updated [API Readiness Checklist](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) was developed within Release Management Working Group.** + +~~| No | Deliverables/Criteria | Mandatory | Reference template | |----|-------------- |-----------|-------------------- | | 1 |API Spec | Y | OAS3 (https://spec.openapis.org/oas/v3.0.3)| | 2 |API Implementation | N | | @@ -7,5 +9,5 @@ |4 |User Stories | Y | https://github.com/camaraproject/Commonalities/blob/main/documentation/Userstory-template.md | | 5 |API test cases and documentation | Y | A Gherkin feature file will be added to the main subproject repo and this will fulfil the minimum criteria of readiness w.r.t API test cases and documentation. If subprojects also intend to add test implementations, an aligned single implementation that is agreed amongst all provider implementors could be added to the main subproject repo. If no alignment is possible, each provider implementor will add the test implementation to their own repos | | 6 |Tested by at least 2 operators | Y | | -| 7 |Security review | Y | Spec contributions should include a security scheme section that complies with the AuthN&AuthZ techniques agreed in Commonalities. | +| 7 |Security review | Y | Spec contributions should include a security scheme section that complies with the AuthN&AuthZ techniques agreed in Commonalities. |~~ From e67477160b15d749fb6a666bec551bb12638c22a Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Tue, 11 Jun 2024 11:06:32 +0200 Subject: [PATCH 2/4] Update API-Readiness-Checklist.md --- documentation/API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-Readiness-Checklist.md b/documentation/API-Readiness-Checklist.md index 9ca5041a..985d25ba 100644 --- a/documentation/API-Readiness-Checklist.md +++ b/documentation/API-Readiness-Checklist.md @@ -1,5 +1,5 @@ # API Readiness minimum criteria checklist -**PLEASE NOTE: This document is deprecated as the updated [API Readiness Checklist](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) was developed within Release Management Working Group.** +**PLEASE NOTE: This document is DEPRECATED as the updated [API Readiness Checklist](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) was developed within Release Management Working Group.** ~~| No | Deliverables/Criteria | Mandatory | Reference template | |----|-------------- |-----------|-------------------- | From cdb1e762da007aaf49ff306c7ff08e3c9b694a20 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Wed, 12 Jun 2024 16:49:36 +0200 Subject: [PATCH 3/4] Update API-Readiness-Checklist.md The old content was removed --- documentation/API-Readiness-Checklist.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/documentation/API-Readiness-Checklist.md b/documentation/API-Readiness-Checklist.md index 985d25ba..43fe4224 100644 --- a/documentation/API-Readiness-Checklist.md +++ b/documentation/API-Readiness-Checklist.md @@ -1,13 +1,2 @@ # API Readiness minimum criteria checklist **PLEASE NOTE: This document is DEPRECATED as the updated [API Readiness Checklist](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) was developed within Release Management Working Group.** - -~~| No | Deliverables/Criteria | Mandatory | Reference template | -|----|-------------- |-----------|-------------------- | -| 1 |API Spec | Y | OAS3 (https://spec.openapis.org/oas/v3.0.3)| -| 2 |API Implementation | N | | -| 3 |API Documentation | Y |The API specification should include all the needed documentation. | -|4 |User Stories | Y | https://github.com/camaraproject/Commonalities/blob/main/documentation/Userstory-template.md | -| 5 |API test cases and documentation | Y | A Gherkin feature file will be added to the main subproject repo and this will fulfil the minimum criteria of readiness w.r.t API test cases and documentation. If subprojects also intend to add test implementations, an aligned single implementation that is agreed amongst all provider implementors could be added to the main subproject repo. If no alignment is possible, each provider implementor will add the test implementation to their own repos | -| 6 |Tested by at least 2 operators | Y | | -| 7 |Security review | Y | Spec contributions should include a security scheme section that complies with the AuthN&AuthZ techniques agreed in Commonalities. |~~ - From d0fa71b41fcf277706d5d59a803e732a45604d3e Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Thu, 13 Jun 2024 14:08:18 +0200 Subject: [PATCH 4/4] Update documentation/API-Readiness-Checklist.md Co-authored-by: Shilpa Padgaonkar <77152136+shilpa-padgaonkar@users.noreply.github.com> --- documentation/API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API-Readiness-Checklist.md b/documentation/API-Readiness-Checklist.md index 43fe4224..0a2f56c3 100644 --- a/documentation/API-Readiness-Checklist.md +++ b/documentation/API-Readiness-Checklist.md @@ -1,2 +1,2 @@ # API Readiness minimum criteria checklist -**PLEASE NOTE: This document is DEPRECATED as the updated [API Readiness Checklist](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) was developed within Release Management Working Group.** +**PLEASE NOTE: This document is DEPRECATED as the updated [API Readiness Checklist](https://github.com/camaraproject/ReleaseManagement/blob/main/documentation/API-Readiness-Checklist.md) is now maintained within the Release Management Working Group.**