diff --git a/doc/testing/testplan/api_publish_service/README.md b/doc/testing/testplan/api_publish_service/README.md index 59e59e826b996a9beb034349ab742040caf8cb95..928c95e7e0342ccb2b01ca54df318c2d47ae2fc2 100644 --- a/doc/testing/testplan/api_publish_service/README.md +++ b/doc/testing/testplan/api_publish_service/README.md @@ -13,6 +13,14 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is pre-authorised (has valid apfId from CAPIF Authority) +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + + 2. Publish Service API + + 3. Retrieve {apiId} from body and Location header with new resource created from response + **Information of Test**: 1. Perform [Provider Registration] @@ -23,14 +31,6 @@ At this documentation you will have all information and related files and exampl * body [service api description] with apiName **service_1** * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - - 2. Publish Service API - - 3. Retrieve {apiId} from body and Location header with new resource created from response - **Expected Result**: 1. Response to Publish request must accomplish: @@ -41,6 +41,7 @@ At this documentation you will have all information and related files and exampl 3. Published Service API is stored in CAPIF Database + ## Test Case 2: Publish API by NON Authorised API Publisher **Test ID**: ***capif_api_publish_service-2*** @@ -53,6 +54,11 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is NOT pre-authorised (has invalid apfId from CAPIF Authority) +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Publish Service API with invalid APF ID + **Information of Test**: 1. Perform [Provider Registration] @@ -62,11 +68,6 @@ At this documentation you will have all information and related files and exampl * body [service api description] with apiName **service_1** * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Publish Service API with invalid APF ID - **Expected Result**: 1. Response to Publish request must accomplish: @@ -93,6 +94,15 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is pre-authorised (has valid apfId from CAPIF Authority) * At least 2 service APIs are published. +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Publish Service API **service_1** + 3. Retrieve {apiId1} from body and Location header with new resource created from response + 4. Publish Service API **service_2** + 5. Retrieve {apiId2} from body and Location header with new resource created from response + 6. Retrieve All published APIs and check if both are present. + **Information of Test**: 1. Perform [Provider Registration] @@ -113,15 +123,6 @@ At this documentation you will have all information and related files and exampl * Send **GET** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis** * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Publish Service API **service_1** - 3. Retrieve {apiId1} from body and Location header with new resource created from response - 4. Publish Service API **service_2** - 5. Retrieve {apiId2} from body and Location header with new resource created from response - 6. Retrieve All published APIs and check if both are present. - **Expected Result**: 1. Response to service 1 Publish request must accomplish: @@ -143,6 +144,7 @@ At this documentation you will have all information and related files and exampl 2. Response body must return an array of **ServiceAPIDescription** data. 3. Array must contain all previously published APIs. + ## Test Case 4: Retrieve all APIs Published by NON Authorised apfId **Test ID**: ***capif_api_publish_service-4*** @@ -155,6 +157,11 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is NOT pre-authorised (has invalid apfId from CAPIF Authority) +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Retrieve All published APIs + **Information of Test**: 1. Perform [Provider Registration] @@ -163,11 +170,6 @@ At this documentation you will have all information and related files and exampl * Send **GET** to **https://{CAPIF_HOSTNAME}/published-apis/v1/{APF_ID_NOT_VALID}/service-apis** * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Retrieve All published APIs - **Expected Result**: 1. Response to Publish request must accomplish: @@ -180,6 +182,7 @@ At this documentation you will have all information and related files and exampl 2. Service API is NOT stored in CAPIF Database + ## Test Case 5: Retrieve single APIs Published by Authorised apfId **Test ID**: ***capif_api_publish_service-5*** @@ -193,6 +196,16 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is pre-authorised (has valid apfId from CAPIF Authority) * At least 2 service APIs are published. +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Publish Service API **service_1**. + 3. Retrieve {apiId1} from body and Location header with new resource created from response. + 4. Publish Service API **service_2**. + 5. Retrieve {apiId2} from body and Location header with new resource created from response. + 6. Retrieve **service_1** API Detail. + 7. Retrieve **service_2** API Detail. + **Information of Test**: 1. Perform [Provider Registration] @@ -217,16 +230,6 @@ At this documentation you will have all information and related files and exampl * Send **GET** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{apiId2}** * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Publish Service API **service_1**. - 3. Retrieve {apiId1} from body and Location header with new resource created from response. - 4. Publish Service API **service_2**. - 5. Retrieve {apiId2} from body and Location header with new resource created from response. - 6. Retrieve **service_1** API Detail. - 7. Retrieve **service_2** API Detail. - **Expected Result**: 1. Response to service 1 Publish request must accomplish: @@ -267,6 +270,11 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is pre-authorised (has valid apfId from CAPIF Authority) * No published api +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Retrieve not published API Detail. + **Information of Test**: 1. Perform [Provider Registration] @@ -274,11 +282,6 @@ At this documentation you will have all information and related files and exampl * Send **GET** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{SERVICE_API_ID_NOT_VALID}** * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Retrieve not published API Detail. - **Expected Result**: 1. Response to Retrieve for NOT published API must accomplish: @@ -302,6 +305,15 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is NOT pre-authorised (has invalid apfId from CAPIF Authority) +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Publish Service API at CCF + 3. Retrieve {apiId} from body and Location header with new resource created from response. + 4. Register and onboard Invoker at CCF + 5. Store signed **Invoker Certificate** + 6. Retrieve detailed published API acting as Invoker + **Information of Test**: 1. Perform [Provider Registration] and [Invoker Onboarding] @@ -316,15 +328,6 @@ At this documentation you will have all information and related files and exampl * Send **GET** to **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/${apiId}** * Use **Invoker Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Publish Service API at CCF - 3. Retrieve {apiId} from body and Location header with new resource created from response. - 4. Register and onboard Invoker at CCF - 5. Store signed **Invoker Certificate** - 6. Retrieve detailed published API acting as Invoker - **Expected Result**: 1. Response to Retrieve Detailed published API acting as Invoker must accomplish: @@ -351,6 +354,14 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is pre-authorised (has valid apfId from CAPIF Authority) * A service APIs is published. +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Publish Service API + 3. Retrieve {apiId} from body and Location header with new resource url created from response + 4. Update published Service API. + 5. Retrieve detail of Service API + **Information of Test**: 1. Perform [Provider Registration] @@ -372,14 +383,6 @@ At this documentation you will have all information and related files and exampl * check apiName is **service_1**_modified * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Publish Service API - 3. Retrieve {apiId} from body and Location header with new resource url created from response - 4. Update published Service API. - 5. Retrieve detail of Service API - **Expected Result**: 1. Response to Publish request must accomplish: @@ -411,6 +414,11 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is pre-authorised (has valid apfId from CAPIF Authority) +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Update published Service API. + **Information of Test**: 1. Perform [Provider Registration] @@ -426,11 +434,6 @@ At this documentation you will have all information and related files and exampl * body [service api description] with overrided apiName to ***service_1**_modified*** * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Update published Service API. - **Expected Result**: 1. Response to Publish request must accomplish: @@ -459,6 +462,16 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is NOT pre-authorised (has invalid apfId from CAPIF Authority) +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Publish Service API at CCF + 3. Retrieve {apiId} from body and Location header with new resource created from response. + 4. Register and onboard Invoker at CCF + 5. Store signed **Invoker Certificate** + 6. Update published API at CCF as Invoker + 7. Retrieve detail of Service API as publisher + **Information of Test**: 1. Perform [Provider Registration] and [Invoker Onboarding] @@ -479,16 +492,6 @@ At this documentation you will have all information and related files and exampl * check apiName is **service_1** * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Publish Service API at CCF - 3. Retrieve {apiId} from body and Location header with new resource created from response. - 4. Register and onboard Invoker at CCF - 5. Store signed **Invoker Certificate** - 6. Update published API at CCF as Invoker - 7. Retrieve detail of Service API as publisher - **Expected Result**: 1. Response to Update published API acting as Invoker must accomplish: @@ -518,6 +521,14 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is pre-authorised (has valid apfId from CAPIF Authority). * A service APIs is published. +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Publish Service API + 3. Retrieve {apiId} from body and Location header with new resource created from response + 4. Remove published API at CCF + 5. Try to retreive deleted service API from CCF + **Information of Test**: 1. Perform [Provider Registration] @@ -535,14 +546,6 @@ At this documentation you will have all information and related files and exampl * Send **GET** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{serivceApiId}** * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Publish Service API - 3. Retrieve {apiId} from body and Location header with new resource created from response - 4. Remove published API at CCF - 5. Try to retreive deleted service API from CCF - **Expected Result**: 1. Response to Publish request must accomplish: @@ -577,6 +580,11 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is pre-authorised (has valid apfId from CAPIF Authority). +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Remove published API at CCF with invalid serviceId + **Information of Test**: 1. Perform [Provider Registration] @@ -585,11 +593,6 @@ At this documentation you will have all information and related files and exampl * Send **DELETE** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{SERVICE_API_ID_NOT_VALID}** * Use **APF Certificate** -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Remove published API at CCF with invalid serviceId - **Expected Result**: 1. Response to Remove published Service API at CCF: @@ -613,6 +616,12 @@ At this documentation you will have all information and related files and exampl * CAPIF subscriber is pre-authorised (has valid apfId from CAPIF Authority). +**Execution Steps**: + + 1. Register Provider at CCF and store certificates. + 2. Register Invoker and onboard Invoker at CCF + 3. Remove published API at CCF with invalid serviceId as Invoker + **Information of Test**: 1. Perform [Provider Registration] and [Invoker Onboarding] @@ -627,12 +636,6 @@ At this documentation you will have all information and related files and exampl * Send **DELETE** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{SERVICE_API_ID_NOT_VALID}** * Use **Invoker Certificate**. -**Execution Steps**: - - 1. Register Provider at CCF and store certificates. - 2. Register Invoker and onboard Invoker at CCF - 3. Remove published API at CCF with invalid serviceId as Invoker - **Expected Result**: 1. Response to Remove published Service API at CCF: