diff --git a/doc/deployment_guide/deployment_guide.md b/doc/deployment_guide/deployment_guide.md
index 699f799891541e47aecc1e070acffb6c714d4908..73710c7735bc65a3c6d13ead63efb0f4fb85db6b 100644
--- a/doc/deployment_guide/deployment_guide.md
+++ b/doc/deployment_guide/deployment_guide.md
@@ -338,7 +338,7 @@ Most of the specifications can be as specified in the [Oracle Virtual Box](#112-
- Size: 60GB (at least)
- **Type**: VMDK
-
+
Also, before initiating the VM and installing the OS, we'll need to:
@@ -354,7 +354,7 @@ At Network Adapt 1, the following port-forwarding rule must be set.
| - | - | - | - | - | - |
| SSH | TCP | | **2222** | | 22 |
-
+
<h3><u>Installing the OS</h3></u>
diff --git a/doc/testing/postman/CAPIF.postman_collection.json b/doc/testing/postman/CAPIF.postman_collection.json
deleted file mode 100644
index e59a534c9944eaf505d07188267adac75557df54..0000000000000000000000000000000000000000
--- a/doc/testing/postman/CAPIF.postman_collection.json
+++ /dev/null
@@ -1,991 +0,0 @@
-{
- "info": {
- "_postman_id": "b512e528-4b13-4be2-aed2-a61a8381360e",
- "name": "CAPIF",
- "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
- "_exporter_id": "31608242",
- "_collection_link": "https://red-comet-993867.postman.co/workspace/Team-Workspace~bfc7c442-a60c-4bb1-8730-fdabc2df89b9/collection/31608242-b512e528-4b13-4be2-aed2-a61a8381360e?action=share&source=collection_link&creator=31608242"
- },
- "item": [
- {
- "name": "01-login_admin",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "var res = JSON.parse(responseBody);",
- "",
- "pm.environment.set('REFRESH_TOKEN', res.refresh_token);",
- "pm.environment.set('ADMIN_TOKEN', res.access_token);"
- ],
- "type": "text/javascript",
- "packages": {}
- }
- }
- ],
- "request": {
- "auth": {
- "type": "basic",
- "basic": [
- {
- "key": "password",
- "value": "{{ADMIN_PASSWORD}}",
- "type": "string"
- },
- {
- "key": "username",
- "value": "{{ADMIN_USER}}",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [],
- "url": {
- "raw": "https://{{REGISTER_HOSTNAME}}:{{REGISTER_PORT}}/login",
- "protocol": "https",
- "host": [
- "{{REGISTER_HOSTNAME}}"
- ],
- "port": "{{REGISTER_PORT}}",
- "path": [
- "login"
- ]
- }
- },
- "response": []
- },
- {
- "name": "02-create_user",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "var res = JSON.parse(responseBody);",
- "",
- "pm.environment.set('USER_UUID', res.uuid);",
- ""
- ],
- "type": "text/javascript",
- "packages": {}
- }
- }
- ],
- "request": {
- "auth": {
- "type": "bearer",
- "bearer": [
- {
- "key": "token",
- "value": "{{ADMIN_TOKEN}}",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [],
- "body": {
- "mode": "raw",
- "raw": "{\n \"username\": \"{{USER_NAME}}\",\n \"password\": \"{{USER_PASSWORD}}\",\n \"enterprise\": \"ETSI\",\n \"country\": \"Spain\",\n \"email\": \"example@gmail.com\",\n \"purpose\": \"Use OpenCAPIF\",\n \"phone_number\": \"+123456789\",\n \"company_web\": \"www.etsi.com\",\n \"description\": \"UserDescription\"\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "https://{{REGISTER_HOSTNAME}}:{{REGISTER_PORT}}/createUser",
- "protocol": "https",
- "host": [
- "{{REGISTER_HOSTNAME}}"
- ],
- "port": "{{REGISTER_PORT}}",
- "path": [
- "createUser"
- ]
- }
- },
- "response": []
- },
- {
- "name": "03-getauth",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "var res = JSON.parse(responseBody);",
- "",
- "pm.environment.set('CA_ROOT', res.ca_root);",
- "pm.environment.set('ACCESS_TOKEN', res.access_token);",
- "pm.environment.set('ONBOARDING_URL', res.ccf_api_onboarding_url);",
- "pm.environment.set('PUBLISH_URL', res.ccf_publish_url);",
- "pm.environment.set('DISCOVER_URL', res.ccf_discover_url);",
- "pm.environment.set('SECURITY_URL', res.ccf_security_url);",
- "pm.environment.set('ONBOARDING_URL_INVOKER', res.ccf_onboarding_url);",
- "",
- "setTimeout(() => {",
- " pm.sendRequest({",
- " url: 'http://localhost:3000/write_ca',",
- " method: 'POST',",
- " header: 'Content-Type:application/json',",
- " encoding: 'binary',",
- " body: {",
- " mode: 'raw',",
- " raw: res",
- " }",
- " }, function (err, res) {",
- " console.log(res);",
- " });",
- " }, 5000);"
- ],
- "type": "text/javascript",
- "packages": {}
- }
- }
- ],
- "request": {
- "auth": {
- "type": "basic",
- "basic": [
- {
- "key": "password",
- "value": "{{USER_PASSWORD}}",
- "type": "string"
- },
- {
- "key": "username",
- "value": "{{USER_NAME}}",
- "type": "string"
- }
- ]
- },
- "method": "GET",
- "header": [],
- "url": {
- "raw": "https://{{REGISTER_HOSTNAME}}:{{REGISTER_PORT}}/getauth",
- "protocol": "https",
- "host": [
- "{{REGISTER_HOSTNAME}}"
- ],
- "port": "{{REGISTER_PORT}}",
- "path": [
- "getauth"
- ]
- }
- },
- "response": []
- },
- {
- "name": "04-onboard_provider",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "var res = JSON.parse(responseBody);",
- "if (pm.response.code == 201){",
- " ",
- " pm.environment.set('PROVIDER_ID', res.apiProvDomId);",
- "",
- " const roleVariableMapping = {",
- " \"AEF\": { id: 'AEF_ID', cert: 'AEF_CERT' },",
- " \"APF\": { id: 'APF_ID', cert: 'APF_CERT' },",
- " \"AMF\": { id: 'AMF_ID', cert: 'AMF_CERT' }",
- " };",
- "",
- " res.apiProvFuncs.forEach(function(elemento) {",
- " const role = elemento.apiProvFuncRole;",
- " if (roleVariableMapping.hasOwnProperty(role)) {",
- " const variables = roleVariableMapping[role];",
- " pm.environment.set(variables.id, elemento.apiProvFuncId);",
- " pm.environment.set(variables.cert, elemento.regInfo.apiProvCert);",
- "",
- " }",
- " });",
- "",
- "}",
- "",
- "",
- ""
- ],
- "type": "text/javascript",
- "packages": {}
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- "",
- "var res = JSON.parse(pm.request.body.raw);",
- "",
- "res.apiProvFuncs.forEach(function(elemento) {",
- "",
- " setTimeout(() => {",
- " pm.sendRequest({",
- " url: 'http://localhost:3000/generate_csr',",
- " method: 'POST',",
- " header: 'Content-Type:application/json',",
- " encoding: 'binary',",
- " body: {",
- " mode: 'raw',",
- " raw: elemento",
- " }",
- " }, function (err, response) {",
- " j_file = JSON.parse(response.text());",
- " elemento.regInfo.apiProvPubKey = j_file.csr;",
- " pm.environment.set(elemento.apiProvFuncRole+'_KEY', j_file.key);",
- " });",
- " }, 5000);",
- "",
- "});",
- "",
- "pm.request.body.raw = res;"
- ],
- "type": "text/javascript",
- "packages": {}
- }
- }
- ],
- "protocolProfileBehavior": {
- "strictSSL": true
- },
- "request": {
- "auth": {
- "type": "bearer",
- "bearer": [
- {
- "key": "token",
- "value": "{{ACCESS_TOKEN}}",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "",
- "value": "",
- "type": "text",
- "disabled": true
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n\"apiProvFuncs\": [\n {\n \"regInfo\": {\n \"apiProvPubKey\": \"\"\n },\n \"apiProvFuncRole\": \"AEF\",\n \"apiProvFuncInfo\": \"dummy_aef\"\n },\n {\n \"regInfo\": {\n \"apiProvPubKey\": \"\"\n },\n \"apiProvFuncRole\": \"APF\",\n \"apiProvFuncInfo\": \"dummy_apf\"\n },\n {\n \"regInfo\": {\n \"apiProvPubKey\": \"\"\n },\n \"apiProvFuncRole\": \"AMF\",\n \"apiProvFuncInfo\": \"dummy_amf\"\n }\n],\n\"apiProvDomInfo\": \"This is provider\",\n\"suppFeat\": \"fff\",\n\"failReason\": \"string\",\n\"regSec\": \"{{ACCESS_TOKEN}}\"\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "https://{{CAPIF_HOSTNAME}}/{{ONBOARDING_URL}}",
- "protocol": "https",
- "host": [
- "{{CAPIF_HOSTNAME}}"
- ],
- "path": [
- "{{ONBOARDING_URL}}"
- ]
- }
- },
- "response": []
- },
- {
- "name": "05-publish_api",
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- "setTimeout(() => {",
- " pm.sendRequest({",
- " url: 'http://localhost:3000/write_cert',",
- " method: 'POST',",
- " header: 'Content-Type:application/json',",
- " encoding: 'binary',",
- " body: {",
- " mode: 'raw',",
- " raw: {cert: pm.environment.get('APF_CERT'), key:pm.environment.get('APF_KEY')}",
- " }",
- " }, function (err, response) {",
- " console.log(response)",
- " });",
- " }, 5000);",
- "",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "test",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "protocolProfileBehavior": {
- "strictSSL": true
- },
- "request": {
- "auth": {
- "type": "noauth"
- },
- "method": "POST",
- "header": [
- {
- "key": "",
- "value": "",
- "type": "text",
- "disabled": true
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "\n{\n \"apiName\": \"hello_api_demo_v2\",\n \"aefProfiles\": [\n {\n \"aefId\": \"{{AEF_ID}}\",\n \"versions\": [\n {\n \"apiVersion\": \"v1\",\n \"expiry\": \"2021-11-30T10:32:02.004Z\",\n \"resources\": [\n {\n \"resourceName\": \"hello-endpoint\",\n \"commType\": \"REQUEST_RESPONSE\",\n \"uri\": \"/hello\",\n \"custOpName\": \"string\",\n \"operations\": [\n \"POST\"\n ],\n \"description\": \"Endpoint to receive a welcome message\"\n }\n ],\n \"custOperations\": [\n {\n \"commType\": \"REQUEST_RESPONSE\",\n \"custOpName\": \"string\",\n \"operations\": [\n \"POST\"\n ],\n \"description\": \"string\"\n }\n ]\n }\n ],\n \"protocol\": \"HTTP_1_1\",\n \"dataFormat\": \"JSON\",\n \"securityMethods\": [\"Oauth\"],\n \"interfaceDescriptions\": [\n {\n \"ipv4Addr\": \"localhost\",\n \"port\": 8088,\n \"securityMethods\": [\"Oauth\"]\n }\n ]\n }\n ],\n \"description\": \"Hello api services\",\n \"supportedFeatures\": \"fffff\",\n \"shareableInfo\": {\n \"isShareable\": true,\n \"capifProvDoms\": [\n \"string\"\n ]\n },\n \"serviceAPICategory\": \"string\",\n \"apiSuppFeats\": \"fffff\",\n \"pubApiPath\": {\n \"ccfIds\": [\n \"string\"\n ]\n },\n \"ccfId\": \"string\"\n }",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "https://{{CAPIF_HOSTNAME}}/published-apis/v1/{{APF_ID}}/service-apis",
- "protocol": "https",
- "host": [
- "{{CAPIF_HOSTNAME}}"
- ],
- "path": [
- "published-apis",
- "v1",
- "{{APF_ID}}",
- "service-apis"
- ]
- }
- },
- "response": []
- },
- {
- "name": "06-onboard_invoker",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "var res = JSON.parse(responseBody);",
- "if (pm.response.code == 201){",
- " ",
- " pm.environment.set('INVOKER_ID', res.apiInvokerId);",
- " pm.environment.set('INVOKER_CERT', res.onboardingInformation.apiInvokerCertificate);",
- "}",
- "",
- "",
- ""
- ],
- "type": "text/javascript",
- "packages": {}
- }
- },
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- "",
- "var res = JSON.parse(pm.request.body.raw);",
- "",
- "",
- "setTimeout(() => {",
- " pm.sendRequest({",
- " url: 'http://localhost:3000/generate_csr_invoker',",
- " method: 'POST',",
- " header: 'Content-Type:application/json',",
- " encoding: 'binary',",
- " body: {",
- " mode: 'raw',",
- " raw: {}",
- " }",
- " }, function (err, response) {",
- " j_file = JSON.parse(response.text());",
- " res.onboardingInformation.apiInvokerPublicKey = j_file.csr;",
- " pm.environment.set('INVOKER_KEY', j_file.key);",
- " });",
- " }, 5000);",
- "",
- "",
- "pm.request.body.raw = res;"
- ],
- "type": "text/javascript",
- "packages": {}
- }
- }
- ],
- "protocolProfileBehavior": {
- "strictSSL": true
- },
- "request": {
- "auth": {
- "type": "bearer",
- "bearer": [
- {
- "key": "token",
- "value": "{{ACCESS_TOKEN}}",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "",
- "value": "",
- "type": "text",
- "disabled": true
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n \"notificationDestination\" : \"http://host.docker.internal:8086/netapp_callback\",\n \"supportedFeatures\" : \"fffffff\",\n \"apiInvokerInformation\" : \"dummy\",\n \"websockNotifConfig\" : {\n \"requestWebsocketUri\" : true,\n \"websocketUri\" : \"websocketUri\"\n },\n \"onboardingInformation\" : {\n \"apiInvokerPublicKey\" : \"\"\n },\n \"requestTestNotification\" : true\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "https://{{CAPIF_HOSTNAME}}/{{ONBOARDING_URL_INVOKER}}",
- "protocol": "https",
- "host": [
- "{{CAPIF_HOSTNAME}}"
- ],
- "path": [
- "{{ONBOARDING_URL_INVOKER}}"
- ]
- }
- },
- "response": []
- },
- {
- "name": "07-discover",
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- "setTimeout(() => {",
- " pm.sendRequest({",
- " url: 'http://localhost:3000/write_cert',",
- " method: 'POST',",
- " header: 'Content-Type:application/json',",
- " encoding: 'binary',",
- " body: {",
- " mode: 'raw',",
- " raw: {cert: pm.environment.get('INVOKER_CERT'), key:pm.environment.get('INVOKER_KEY')}",
- " }",
- " }, function (err, response) {",
- " console.log(response)",
- " });",
- " }, 5000);",
- "",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "test",
- "script": {
- "exec": [
- "var res = JSON.parse(responseBody);",
- "if (pm.response.code == 200){",
- "",
- " res.serviceAPIDescriptions.forEach(function(api) {",
- " pm.environment.set('API_SERVICE_ID', api.apiId);",
- " pm.environment.set('API_NAME', api.apiName);",
- " pm.environment.set('API_AEF_ID', api.aefProfiles[0].aefId);",
- " pm.environment.set('IPV4ADDR', api.aefProfiles[0].interfaceDescriptions[0].ipv4Addr);",
- " pm.environment.set('PORT', api.aefProfiles[0].interfaceDescriptions[0].port);",
- " pm.environment.set('URI', api.aefProfiles[0].versions[0].resources[0].uri);",
- " });",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "protocolProfileBehavior": {
- "disableBodyPruning": true,
- "strictSSL": true
- },
- "request": {
- "auth": {
- "type": "noauth"
- },
- "method": "GET",
- "header": [
- {
- "key": "",
- "value": "",
- "type": "text",
- "disabled": true
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "https://{{CAPIF_HOSTNAME}}/{{DISCOVER_URL}}{{INVOKER_ID}}",
- "protocol": "https",
- "host": [
- "{{CAPIF_HOSTNAME}}"
- ],
- "path": [
- "{{DISCOVER_URL}}{{INVOKER_ID}}"
- ]
- }
- },
- "response": []
- },
- {
- "name": "08-security_context",
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- "setTimeout(() => {",
- " pm.sendRequest({",
- " url: 'http://localhost:3000/write_cert',",
- " method: 'POST',",
- " header: 'Content-Type:application/json',",
- " encoding: 'binary',",
- " body: {",
- " mode: 'raw',",
- " raw: {cert: pm.environment.get('INVOKER_CERT'), key:pm.environment.get('INVOKER_KEY')}",
- " }",
- " }, function (err, response) {",
- " console.log(response)",
- " });",
- " }, 5000);",
- "",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "test",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript"
- }
- }
- ],
- "protocolProfileBehavior": {
- "strictSSL": true
- },
- "request": {
- "auth": {
- "type": "noauth"
- },
- "method": "PUT",
- "header": [
- {
- "key": "",
- "value": "",
- "type": "text",
- "disabled": true
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n \"securityInfo\": [\n {\n \"prefSecurityMethods\": [\n \"Oauth\"\n ],\n \"authenticationInfo\": \"string\",\n \"authorizationInfo\": \"string\",\n \"aefId\": \"{{API_AEF_ID}}\",\n \"apiId\": \"{{API_SERVICE_ID}}\"\n }\n ],\n \"notificationDestination\": \"https://mynotificationdest.com\",\n \"requestTestNotification\": true,\n \"websockNotifConfig\": {\n \"websocketUri\": \"string\",\n \"requestWebsocketUri\": true\n },\n \"supportedFeatures\": \"fff\"\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "https://{{CAPIF_HOSTNAME}}/capif-security/v1/trustedInvokers/{{INVOKER_ID}}",
- "protocol": "https",
- "host": [
- "{{CAPIF_HOSTNAME}}"
- ],
- "path": [
- "capif-security",
- "v1",
- "trustedInvokers",
- "{{INVOKER_ID}}"
- ]
- }
- },
- "response": []
- },
- {
- "name": "09-get_token",
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- "setTimeout(() => {",
- " pm.sendRequest({",
- " url: 'http://localhost:3000/write_cert',",
- " method: 'POST',",
- " header: 'Content-Type:application/json',",
- " encoding: 'binary',",
- " body: {",
- " mode: 'raw',",
- " raw: {cert: pm.environment.get('INVOKER_CERT'), key:pm.environment.get('INVOKER_KEY')}",
- " }",
- " }, function (err, response) {",
- " console.log(response)",
- " });",
- " }, 5000);",
- "",
- "",
- ""
- ],
- "type": "text/javascript"
- }
- },
- {
- "listen": "test",
- "script": {
- "exec": [
- "var res = JSON.parse(responseBody);",
- "if (pm.response.code == 200){",
- " pm.environment.set('NETAPP_SERVICE_TOKEN', res.access_token);",
- "}"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "protocolProfileBehavior": {
- "strictSSL": true,
- "disabledSystemHeaders": {}
- },
- "request": {
- "auth": {
- "type": "noauth"
- },
- "method": "POST",
- "header": [
- {
- "key": "",
- "value": "",
- "type": "text",
- "disabled": true
- }
- ],
- "body": {
- "mode": "urlencoded",
- "urlencoded": [
- {
- "key": "client_id",
- "value": "{{INVOKER_ID}}",
- "type": "text"
- },
- {
- "key": "grant_type",
- "value": "client_credentials",
- "type": "text"
- },
- {
- "key": "client_secret",
- "value": "string",
- "type": "text"
- },
- {
- "key": "scope",
- "value": "3gpp#{{API_AEF_ID}}:{{API_NAME}}",
- "type": "text"
- }
- ]
- },
- "url": {
- "raw": "https://{{CAPIF_HOSTNAME}}/capif-security/v1/securities/{{INVOKER_ID}}/token",
- "protocol": "https",
- "host": [
- "{{CAPIF_HOSTNAME}}"
- ],
- "path": [
- "capif-security",
- "v1",
- "securities",
- "{{INVOKER_ID}}",
- "token"
- ]
- }
- },
- "response": []
- },
- {
- "name": "10-call_service",
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript",
- "packages": {}
- }
- },
- {
- "listen": "test",
- "script": {
- "exec": [
- ""
- ],
- "type": "text/javascript",
- "packages": {}
- }
- }
- ],
- "protocolProfileBehavior": {
- "strictSSL": false
- },
- "request": {
- "auth": {
- "type": "bearer",
- "bearer": [
- {
- "key": "token",
- "value": "{{NETAPP_SERVICE_TOKEN}}",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [
- {
- "key": "",
- "value": "",
- "type": "text",
- "disabled": true
- }
- ],
- "body": {
- "mode": "raw",
- "raw": "{\n\"name\": {{USER_NAME}}\n}",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "http://{{IPV4ADDR}}:{{PORT}}{{URI}}",
- "protocol": "http",
- "host": [
- "{{IPV4ADDR}}"
- ],
- "port": "{{PORT}}{{URI}}"
- }
- },
- "response": []
- },
- {
- "name": "offboard_provider",
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- "setTimeout(() => {",
- " pm.sendRequest({",
- " url: 'http://localhost:3000/write_cert',",
- " method: 'POST',",
- " header: 'Content-Type:application/json',",
- " encoding: 'binary',",
- " body: {",
- " mode: 'raw',",
- " raw: {cert: pm.environment.get('AMF_CERT'), key:pm.environment.get('AMF_KEY')}",
- " }",
- " }, function (err, response) {",
- " console.log(response)",
- " });",
- " }, 5000);"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "protocolProfileBehavior": {
- "strictSSL": true
- },
- "request": {
- "auth": {
- "type": "noauth"
- },
- "method": "DELETE",
- "header": [],
- "url": {
- "raw": "https://{{CAPIF_HOSTNAME}}/{{ONBOARDING_URL}}/{{PROVIDER_ID}}",
- "protocol": "https",
- "host": [
- "{{CAPIF_HOSTNAME}}"
- ],
- "path": [
- "{{ONBOARDING_URL}}",
- "{{PROVIDER_ID}}"
- ]
- }
- },
- "response": []
- },
- {
- "name": "offboard_invoker",
- "event": [
- {
- "listen": "prerequest",
- "script": {
- "exec": [
- "setTimeout(() => {",
- " pm.sendRequest({",
- " url: 'http://localhost:3000/write_cert',",
- " method: 'POST',",
- " header: 'Content-Type:application/json',",
- " encoding: 'binary',",
- " body: {",
- " mode: 'raw',",
- " raw: {cert: pm.environment.get('INVOKER_CERT'), key:pm.environment.get('INVOKER_KEY')}",
- " }",
- " }, function (err, response) {",
- " console.log(response)",
- " });",
- " }, 5000);"
- ],
- "type": "text/javascript"
- }
- }
- ],
- "protocolProfileBehavior": {
- "strictSSL": true
- },
- "request": {
- "auth": {
- "type": "noauth"
- },
- "method": "DELETE",
- "header": [],
- "url": {
- "raw": "https://{{CAPIF_HOSTNAME}}/{{ONBOARDING_URL_INVOKER}}/{{INVOKER_ID}}",
- "protocol": "https",
- "host": [
- "{{CAPIF_HOSTNAME}}"
- ],
- "path": [
- "{{ONBOARDING_URL_INVOKER}}",
- "{{INVOKER_ID}}"
- ]
- }
- },
- "response": []
- },
- {
- "name": "remove_user",
- "request": {
- "auth": {
- "type": "bearer",
- "bearer": [
- {
- "key": "token",
- "value": "{{ADMIN_TOKEN}}",
- "type": "string"
- }
- ]
- },
- "method": "DELETE",
- "header": [],
- "body": {
- "mode": "raw",
- "raw": "",
- "options": {
- "raw": {
- "language": "json"
- }
- }
- },
- "url": {
- "raw": "https://{{REGISTER_HOSTNAME}}:{{REGISTER_PORT}}/deleteUser/{{USER_UUID}}",
- "protocol": "https",
- "host": [
- "{{REGISTER_HOSTNAME}}"
- ],
- "port": "{{REGISTER_PORT}}",
- "path": [
- "deleteUser",
- "{{USER_UUID}}"
- ]
- }
- },
- "response": []
- },
- {
- "name": "refresh_admin_token",
- "event": [
- {
- "listen": "test",
- "script": {
- "exec": [
- "var res = JSON.parse(responseBody);",
- "",
- "pm.environment.set('REFRESH_TOKEN', res.refresh_token);"
- ],
- "type": "text/javascript",
- "packages": {}
- }
- }
- ],
- "request": {
- "auth": {
- "type": "bearer",
- "bearer": [
- {
- "key": "token",
- "value": "{{REFRESH_TOKEN}}",
- "type": "string"
- }
- ]
- },
- "method": "POST",
- "header": [],
- "url": {
- "raw": "https://{{REGISTER_HOSTNAME}}:{{REGISTER_PORT}}/refresh",
- "protocol": "https",
- "host": [
- "{{REGISTER_HOSTNAME}}"
- ],
- "port": "{{REGISTER_PORT}}",
- "path": [
- "refresh"
- ]
- }
- },
- "response": []
- }
- ]
-}
\ No newline at end of file
diff --git a/doc/testing/postman/CAPIF.postman_environment.json b/doc/testing/postman/CAPIF.postman_environment.json
deleted file mode 100644
index 0ed42a99d3ea99166344b178c3fa78419f12be43..0000000000000000000000000000000000000000
--- a/doc/testing/postman/CAPIF.postman_environment.json
+++ /dev/null
@@ -1,267 +0,0 @@
-{
- "id": "872bffef-37ef-4a25-afa8-6a61de256f4b",
- "name": "CAPIF",
- "values": [
- {
- "key": "CAPIF_HOSTNAME",
- "value": "capifcore",
- "type": "default",
- "enabled": true
- },
- {
- "key": "CAPIF_PORT",
- "value": "8080",
- "type": "default",
- "enabled": true
- },
- {
- "key": "REGISTER_HOSTNAME",
- "value": "localhost",
- "type": "default",
- "enabled": true
- },
- {
- "key": "REGISTER_PORT",
- "value": "8084",
- "type": "default",
- "enabled": true
- },
- {
- "key": "USERNAME",
- "value": "ProviderONE",
- "type": "default",
- "enabled": true
- },
- {
- "key": "PASSWORD",
- "value": "pass",
- "type": "default",
- "enabled": true
- },
- {
- "key": "CALLBACK_IP",
- "value": "host.docker.internal",
- "type": "default",
- "enabled": true
- },
- {
- "key": "CALLBACK_PORT",
- "value": "8087",
- "type": "default",
- "enabled": true
- },
- {
- "key": "ADMIN_USER",
- "value": "admin",
- "type": "default",
- "enabled": true
- },
- {
- "key": "ADMIN_PASSWORD",
- "value": "password123",
- "type": "default",
- "enabled": true
- },
- {
- "key": "ADMIN_TOKEN",
- "value": "",
- "type": "default",
- "enabled": true
- },
- {
- "key": "REFRESH_TOKEN",
- "value": "",
- "type": "default",
- "enabled": true
- },
- {
- "key": "USER_NAME",
- "value": "custom_user",
- "type": "default",
- "enabled": true
- },
- {
- "key": "USER_PASSWORD",
- "value": "user_pass",
- "type": "default",
- "enabled": true
- },
- {
- "key": "USER_UUID",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "ONBOARDING_URL",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "PUBLISH_URL",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "ONBOARDING_URL_INVOKER",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "DISCOVER_URL",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "SECURITY_URL",
- "value": "",
- "type": "default",
- "enabled": true
- },
- {
- "key": "CA_ROOT",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "ACCESS_TOKEN",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "APF_KEY",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "AMF_KEY",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "AEF_KEY",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "PROVIDER_ID",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "AEF_ID",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "AEF_CERT",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "APF_ID",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "APF_CERT",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "AMF_ID",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "AMF_CERT",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "INVOKER_KEY",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "INVOKER_ID",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "INVOKER_CERT",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "API_ID",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "API_NAME",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "IPV4ADDR",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "PORT",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "URI",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "API_SERVICE_ID",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "API_AEF_ID",
- "value": "",
- "type": "any",
- "enabled": true
- },
- {
- "key": "NETAPP_SERVICE_TOKEN",
- "value": "",
- "type": "any",
- "enabled": true
- }
- ],
- "_postman_variable_scope": "environment",
- "_postman_exported_at": "2024-06-26T11:17:13.183Z",
- "_postman_exported_using": "Postman/11.2.13"
-}
\ No newline at end of file
diff --git a/doc/testing/postman/README.md b/doc/testing/postman/README.md
deleted file mode 100644
index e73dab64c1b0c63e111136e26bda66f66ed60d15..0000000000000000000000000000000000000000
--- a/doc/testing/postman/README.md
+++ /dev/null
@@ -1,143 +0,0 @@
-# Postman
-In this section we can use Postman to publish an API as a provider and use it as an invoker.
-
-## Requisites
-
-- We will need to have Node.js installed since we will use a small script to create the CSRs of the certificates.
-- An instance of CAPIF (If it is not local, certain variables would have to be modified both in the Node.js script and in the Postman environment variables).
-
-## First steps
-
-1. Install the Node dependencies <a href="./package.json" download>package.json</a> to run the script with:
-
-```
-npm i
-```
-
-1. Run the <a href="./script.js" download>script.js</a> with the following command:
-
-```
-node script.js
-```
-
-3. Import Postman collection and environment variables (<a href="./CAPIF.postman_collection.json" download>CAPIF.postman_collection.json</a> and <a href="./CAPIF.postman_environment.json" download>CAPIF.postman_environment.json</a>)
-4. Select CAPIF Environment before start testing.
-
-## Remote CAPIF
-
-If the CAPIF is not local, the host and port of both the CAPIF and the register would have to be specified in the variables, and the CAPIF_HOSTNAME in the script, necessary to obtain the server certificate.
-
-**Enviroments in Postman**
-```
-CAPIF_HOSTNAME capifcore
-CAPIF_PORT 8080
-REGISTER_HOSTNAME register
-REGISTER_PORT 8084
-```
-
-**Const in script.js**
-```
-CAPIF_HOSTNAME capifcore
-```
-
-## CAPIF Flows
-Once the first steps have been taken, we can now use Postman requests. These requests are numbered in the order that must be followed to obtain everything necessary from CAPIF.
-
-### Creation of User by Admin
-
-The first step would be for an administrator to create a user with which a provider and an invoker will be created. To do this, the admin must log in to obtain the token needed in admin requests.
-
-#### **01-Login_admin**
-
-
-
-#### **02-Creation of User**
-
-
-
-### Publication of an API
-
-The next step is to register a provider using the user created by the administrator in order to publish an API.
-
-#### **03-getauth_provider**
-
-
-
-#### **04-onboard_provider**
-
-
-
-At this point we move on to using certificate authentication in CAPIF. In Postman it is necessary to add the certificates manually and using more than one certificate for the same host as we do in CAPIF complicates things. For this reason, we use the script to overwrite a certificate and a key when it is necessary to have a specific one.
-
-To configure go to **settings** in Postman and open the **certificates** section.
-
-- Here, activate the **CA certificates** option and add the **ca_cert.pem** file found in the **Responses** folder.
-- Adds a client certificate specifying the CAPIF host being used and the files **client_cert.crt** and **client_key.key** in the **Responses** folder.
-
-
-Once this is done, the node script will be in charge of changing the certificate that is necessary in each request.
-
-#### **05-publish_api**
-
-
-
-Once the api is published, we can start it. In this case we have a test one created in python called <a href="./hello_api.py" download>hello_api.py</a> that can be executed with the following command:
-
-```
-python3 hello_api.py
-```
-
-The API publication interface is set to localhost with port 8088, so the service must be set up locally. If you wanted to build it on another site, you would have to change the interface description in the body of publish_api.
-
-With this the provider part would be finished.
-
-### Calling the API
-
-Finally, we will create an invoker with the user given by the administrator to be able to use the published api.
-
-#### **06-getauth_invoker**
-
-
-
-#### **07-onboard_invoker**
-
-
-
-At this point we move on to using certificate authentication in CAPIF. **If you did not configure the provider's certificates, you would have to do it now**.
-
-#### **08-discover**
-
-
-
-#### **09-security_context**
-
-
-
-#### **10-get_token**
-
-
-
-#### **11-call_service**
-
-
-
-With this, we would have made the API call and finished the flow.
-
-### Other requests
-
-Other requests that we have added are the following:
-
-- **offboard_provider** Performs offboarding of the provider, thereby eliminating the published APIs.
-- **offboard_invoker** Offboards the invoker, also eliminating access to the APIs of that invoker.
-- **remove_user** Delete the user.
-- **refresh_admin_token** Return a new access token to the admin.
-
-## Notes
-
-- This process is designed to teach how requests are made in Postman and the flow that should be followed to publish and use an API.
-- It is possible that if external CAPIFs are used (Public CAPIF) the test data may already be used or the API already registered.
-- It is necessary to have the Node service running to make the certificate change for the requests, otherwise it will not work.
-- We are working on adding more requests to the Postman collection.
-- This collection is a testing guide and is recommended for testing purposes only.
-
-
diff --git a/doc/testing/postman/hello_api.py b/doc/testing/postman/hello_api.py
deleted file mode 100644
index 0b2a35989ecfaa144489d1b6012f61453c91bd68..0000000000000000000000000000000000000000
--- a/doc/testing/postman/hello_api.py
+++ /dev/null
@@ -1,38 +0,0 @@
-from flask import Flask, jsonify, request
-from flask_jwt_extended import jwt_required, JWTManager, get_jwt_identity, get_jwt
-import ssl
-from werkzeug import serving
-import socket, ssl
-import OpenSSL
-from OpenSSL import crypto
-import jwt
-import pyone
-
-app = Flask(__name__)
-
-jwt_flask = JWTManager(app)
-
-
-with open("Responses/cert_server.pem", "rb") as cert_file:
- cert= cert_file.read()
-
-crtObj = crypto.load_certificate(crypto.FILETYPE_PEM, cert)
-pubKeyObject = crtObj.get_pubkey()
-pubKeyString = crypto.dump_publickey(crypto.FILETYPE_PEM,pubKeyObject)
-
-app.config['JWT_ALGORITHM'] = 'RS256'
-app.config['JWT_PUBLIC_KEY'] = pubKeyString
-
-
-@app.route("/hello", methods=["POST"])
-@jwt_required()
-def hello():
-
- request_data = request.get_json()
-
- user_name = request_data['name']
-
- return jsonify(f"Hello: {user_name}, welcome to CAPIF.")
-
-if __name__ == '__main__':
- serving.run_simple("0.0.0.0", 8088, app)
diff --git a/doc/testing/postman/package.json b/doc/testing/postman/package.json
deleted file mode 100644
index 6d612a702d5a9fa9a112f1a2f47c44f75725fa00..0000000000000000000000000000000000000000
--- a/doc/testing/postman/package.json
+++ /dev/null
@@ -1,16 +0,0 @@
-{
- "name": "node-server",
- "version": "1.0.0",
- "description": "",
- "main": "index.js",
- "scripts": {
- "test": "echo \"Error: no test specified\" && exit 1"
- },
- "author": "",
- "license": "ISC",
- "dependencies": {
- "body-parser": "^1.18.3",
- "express": "^4.16.3",
- "shelljs": "^0.8.2"
- }
- }
\ No newline at end of file
diff --git a/doc/testing/postman/script.js b/doc/testing/postman/script.js
deleted file mode 100644
index 980f81f33b4bda4f48f55dcd13d8f436dface9a5..0000000000000000000000000000000000000000
--- a/doc/testing/postman/script.js
+++ /dev/null
@@ -1,199 +0,0 @@
-// Change this variable if another host is used for CAPIF
-const CAPIF_HOSTNAME = 'capifcore';
-
-const express = require('express'),
- app = express(),
- fs = require('fs'),
- shell = require('shelljs'),
-
-
- folderPath = './Responses/',
- bodyParser = require('body-parser'),
- path = require('path');
-
-const { exec } = require('child_process');
-
-// Create the folder path in case it doesn't exist
-shell.mkdir('-p', folderPath);
-
- // Change the limits according to your response size
-app.use(bodyParser.json({limit: '50mb', extended: true}));
-app.use(bodyParser.urlencoded({ limit: '50mb', extended: true }));
-var opensslCommand = ''
-
-if (CAPIF_HOSTNAME.includes(':')){
- opensslCommand = `openssl s_client -connect ${CAPIF_HOSTNAME} | openssl x509 -text > ./Responses/cert_server.pem`;
-}
-else{
- opensslCommand = `openssl s_client -connect ${CAPIF_HOSTNAME}:443 | openssl x509 -text > ./Responses/cert_server.pem`;
-}
-
-exec(opensslCommand, (error, stdout, stderr) => {
- if (error) {
- console.error(`Error generating CSR: ${stderr}`);
- }
-});
-
-fs.writeFileSync('./Responses/client_cert.crt', '');
-fs.writeFileSync('./Responses/client_key.key', '');
-
-app.get('/', (req, res) => res.send('Hello, I write data to file. Send them requests!'));
-
-app.post('/generate_csr', (req, res) => {
-
- console.log(req.body);
- const csrFilePath = 'Responses/'+req.body.apiProvFuncRole+'_csr.pem';
- const privateKeyFilePath = 'Responses/'+req.body.apiProvFuncRole+'_key.key';
-
- const subjectInfo = {
- country: 'ES',
- state: 'Madrid',
- locality: 'Madrid',
- organization: 'Telefonica I+D',
- organizationalUnit: 'IT Department',
- emailAddress: 'admin@example.com',
- };
-
- const opensslCommand = `openssl req -newkey rsa:2048 -nodes -keyout ${privateKeyFilePath} -out ${csrFilePath} -subj "/C=${subjectInfo.country}/ST=${subjectInfo.state}/L=${subjectInfo.locality}/O=${subjectInfo.organization}/OU=${subjectInfo.organizationalUnit}/emailAddress=${subjectInfo.emailAddress}"`;
-
- exec(opensslCommand, (error, stdout, stderr) => {
- if (error) {
- console.error(`Error generating CSR: ${stderr}`);
- } else {
- console.log('CSR generated successfully:');
- fs.readFile(csrFilePath, 'utf8', (readError, csrContent) => {
- if (readError) {
- console.error(`Error reading CSR: ${readError}`);
- res.status(500).send('Error reading CSR');
- } else {
- console.log('CSR read successfully:');
- // Send the CSR content in the response
- fs.readFile(privateKeyFilePath, 'utf8', (readError, keyContent) => {
- if (readError) {
- console.error(`Error reading KEY: ${readError}`);
- res.status(500).send('Error reading KEY');
- } else {
- console.log('KEY read successfully:');
- // Send the CSR content in the response
- fs.unlink(csrFilePath, (err) => {
- if (err) {
- console.error(`Error deleting file: ${err.message}`);
- }
- });
- fs.unlink(privateKeyFilePath, (err) => {
- if (err) {
- console.error(`Error deleting file: ${err.message}`);
- }
- });
- res.send({csr: csrContent, key: keyContent});
- }
- });
- }
- });
- }
- });
-});
-
-app.post('/generate_csr_invoker', (req, res) => {
-
- console.log(req.body);
- const csrFilePath = 'Responses/invoker_csr.pem';
- const privateKeyFilePath = 'Responses/invoker_key.key';
-
- const subjectInfo = {
- country: 'ES',
- state: 'Madrid',
- locality: 'Madrid',
- organization: 'Telefonica I+D',
- organizationalUnit: 'IT Department',
- emailAddress: 'admin@example.com',
- };
-
- const opensslCommand = `openssl req -newkey rsa:2048 -nodes -keyout ${privateKeyFilePath} -out ${csrFilePath} -subj "/C=${subjectInfo.country}/ST=${subjectInfo.state}/L=${subjectInfo.locality}/O=${subjectInfo.organization}/OU=${subjectInfo.organizationalUnit}/emailAddress=${subjectInfo.emailAddress}"`;
-
- exec(opensslCommand, (error, stdout, stderr) => {
- if (error) {
- console.error(`Error generating CSR: ${stderr}`);
- } else {
- console.log('CSR generated successfully:');
- fs.readFile(csrFilePath, 'utf8', (readError, csrContent) => {
- if (readError) {
- console.error(`Error reading CSR: ${readError}`);
- res.status(500).send('Error reading CSR');
- } else {
- console.log('CSR read successfuly:');
- // Send the CSR content in the response
- fs.readFile(privateKeyFilePath, 'utf8', (readError, keyContent) => {
- if (readError) {
- console.error(`Error reading KEY: ${readError}`);
- res.status(500).send('Error reading KEY');
- } else {
- console.log('KEY read successfully:');
- // Send the CSR content in the response
- fs.unlink(csrFilePath, (err) => {
- if (err) {
- console.error(`Error deleting file: ${err.message}`);
- }
- });
- fs.unlink(privateKeyFilePath, (err) => {
- if (err) {
- console.error(`Error deleting file: ${err.message}`);
- }
- });
- res.send({csr: csrContent, key: keyContent});
- }
- });
- }
- });
- }
- });
-});
-
-
-app.post('/write_cert', (req, res) => {
- let extension = 'crt',
- fsMode = 'writeFile',
- filename = "client_cert",
- filePath = `${path.join(folderPath, filename)}.${extension}`,
- options = {encoding: 'binary'};
- fs[fsMode](filePath, req.body.cert, options, (err) => {
- if (err) {
- console.log(err);
- res.send('Error');
- }
- });
- extension = 'key';
- filename = "client_key";
- filePath = `${path.join(folderPath, filename)}.${extension}`;
- fs[fsMode](filePath, req.body.key, options, (err) => {
- if (err) {
- console.log(err);
- res.send('Error');
- }
- else {
- res.send('Success');
- }
- });
-});
-
-app.post('/write_ca', (req, res) => {
- let extension = 'pem',
- fsMode = 'writeFile',
- filename = "ca_cert",
- filePath = `${path.join(folderPath, filename)}.${extension}`,
- options = {encoding: 'binary'};
- fs[fsMode](filePath, req.body.ca_root, options, (err) => {
- if (err) {
- console.log(err);
- res.send('Error');
- }
- else {
- res.send('Success');
- }
- });
-});
-
-app.listen(3000, () => {
- console.log('ResponsesToFile App is listening now! Send them requests my way!');
- console.log(`Data is being stored at location: ${path.join(process.cwd(), folderPath)}`);
-});
\ No newline at end of file
diff --git a/doc/testing/robotframework/README.md b/doc/testing/robotframework/README.md
deleted file mode 100644
index 825881f430f041068e63932ee909ad9441b497f1..0000000000000000000000000000000000000000
--- a/doc/testing/robotframework/README.md
+++ /dev/null
@@ -1,138 +0,0 @@
-# Robot Framework
-
-## Steps to Test
-
-To run any test locally you will need *docker* and *docker-compose* installed in order run services and execute test plan. Steps will be:
-
-* **Run All Services**: See section [Run All CAPIF Services](../../gettingstarted/howtorun.md#run-all-capif-services-locally-with-docker-images)
-
-* **Run desired tests**: At this point we have 2 options:
-
- * **Using helper script**: [Script Test Execution](#script-test-execution)
- * **Build robot docker image and execute manually robot docker**: [Manual Build And Test Execution](#manual-build-and-test-execution)
-
-
-## Script Test Execution
-This script will build robot docker image if it's need and execute tests selected by "include" option. Just go to service folder, execute and follow steps.
-```
-./run_capif_tests.sh --include <TAG>
-```
-Results will be stored at <REPOSITORY_FOLDER>/results
-
-Please check parameters (include) under *Test Execution* at [Manual Build And Test Execution](#manual-build-and-test-execution).
-
-### Mock Server
-Some tests on Test Plans require mockserver. That mock server must be deployed and reachable by Robot Framework and CCF under test.
-
-To run Mock Server locally you can just execute the next script:
-```
-cd services
-./run_mock_server.sh
-
-or
-./run.sh -s
-```
-
-If you want to launch only tests that not needed mockserver, just add "--exclude mockserver" parameter to robot execution:
-```
-./run_capif_tests.sh --include <TAG> --exclude mockserver
-```
-
-After run tests the Mock Server can be removed from local deployment:
-```
-./clean_mock_server.sh
-
-or
-./clean_capif_docker_services.sh -s
-```
-
-## Manual Build And Test Execution
-
-* **Build Robot docker image**:
-```
-cd tools/robot
-docker build . -t capif-robot-test:latest
-```
-
-* **Tests Execution**:
-
-Execute all tests locally:
-```
-<PATH_TO_REPOSITORY>=path in local machine to repository cloned.
-<PATH_RESULT_FOLDER>=path to a folder on local machine to store results of Robot Framework execution.
-<CAPIF_HOSTNAME>=Is the hostname set when run.sh is executed, by default it is capifcore.
-<CAPIF_HTTP_PORT>=This is the port to reach when robot framework want to reach CAPIF deployment using http, this should be set to port without TLS set on Nginx, 8080 by default.
-<CAPIF_HTTPS_PORT>=This is the port to be used when we want to use https connection, this should be set to port with TLS set on Nginx, 443 by default
-<CAPIF_REGISTER>=This is the hostname of register service deployed. By default it is register.
-<CAPIF_REGISTER_PORT>=This is the port to be used to reach register service deployed. By default it is 8084.
-<CAPIF_VAULT>=This is the hostname of vault service. By default it is vault.
-<CAPIF_VAULT_PORT>=This is the port to be used to reach vault service. By default it is 8200.
-<CAPIF_VAULT_TOKEN>=Vault token to be used on request through vault. By default it is "read-ca-token".
-<MOCK_SERVER_URL>=Setup Mock server url to be used in notifications at tests marked with mockserver tag. By default it is not set.
-
-To execute all tests run :
-docker run -ti --rm --network="host" \
- --add-host host.docker.internal:host-gateway \
- --add-host vault:host-gateway \
- --add-host register:host-gateway \
- --add-host mock-server:host-gateway \
- -v <PATH_TO_REPOSITORY>/tests:/opt/robot-tests/tests \
- -v <PATH_RESULT_FOLDER>:/opt/robot-tests/results capif-robot-test:latest \
- --variable CAPIF_HOSTNAME:$CAPIF_HOSTNAME \
- --variable CAPIF_HTTP_PORT:$CAPIF_HTTP_PORT \
- --variable CAPIF_HTTPS_PORT:$CAPIF_HTTPS_PORT \
- --variable CAPIF_REGISTER:$CAPIF_REGISTER \
- --variable CAPIF_REGISTER_PORT:$CAPIF_REGISTER_PORT \
- --variable CAPIF_VAULT:$CAPIF_VAULT \
- --variable CAPIF_VAULT_PORT:$CAPIF_VAULT_PORT \
- --variable CAPIF_VAULT_TOKEN:$CAPIF_VAULT_TOKEN \
- --variable MOCK_SERVER_URL:$MOCK_SERVER_URL \
- --include all
-```
-
-Execute specific tests locally:
-```
-To run more specific tests, for example, only one functionality:
-<TAG>=Select one from list:
- "capif_api_acl",
- "capif_api_auditing_service",
- "capif_api_discover_service",
- "capif_api_events",
- "capif_api_invoker_management",
- "capif_api_logging_service",
- "capif_api_provider_management",
- "capif_api_publish_service",
- "capif_security_api
-
-And Run:
-docker run -ti --rm --network="host" \
- --add-host host.docker.internal:host-gateway \
- --add-host vault:host-gateway \
- --add-host register:host-gateway \
- --add-host mock-server:host-gateway \
- -v <PATH_TO_REPOSITORY>/tests:/opt/robot-tests/tests \
- -v <PATH_RESULT_FOLDER>:/opt/robot-tests/results capif-robot-test:latest \
- --variable CAPIF_HOSTNAME:$CAPIF_HOSTNAME \
- --variable CAPIF_HTTP_PORT:$CAPIF_HTTP_PORT \
- --variable CAPIF_HTTPS_PORT:$CAPIF_HTTPS_PORT \
- --variable CAPIF_REGISTER:$CAPIF_REGISTER \
- --variable CAPIF_REGISTER_PORT:$CAPIF_REGISTER_PORT \
- --variable CAPIF_VAULT:$CAPIF_VAULT \
- --variable CAPIF_VAULT_PORT:$CAPIF_VAULT_PORT \
- --variable CAPIF_VAULT_TOKEN:$CAPIF_VAULT_TOKEN \
- --variable MOCK_SERVER_URL:$MOCK_SERVER_URL \
- --include <TAG>
-```
-
-## Test result review
-
-In order to Review results after tests, you can check general report at <PATH_RESULT_FOLDER>/report.html or if you need more detailed information <PATH_RESULT_FOLDER>/log.html, example:
-
-* Report:
-
-
-* Detailed information:
-
-
-**NOTE: If you need more detail at Robot Framework Logs you can set log level option just adding to command --loglevel DEBUG**
-
diff --git a/doc/testing/robotframework/robot_log_example.png b/doc/testing/robotframework/robot_log_example.png
deleted file mode 100644
index 6c15a031e26eae47fed53b21a1e69e2f7bfa89db..0000000000000000000000000000000000000000
Binary files a/doc/testing/robotframework/robot_log_example.png and /dev/null differ
diff --git a/doc/testing/robotframework/robot_report_example.png b/doc/testing/robotframework/robot_report_example.png
deleted file mode 100644
index 1cf36d8766753d08938be73c87e958f4c8d56068..0000000000000000000000000000000000000000
Binary files a/doc/testing/robotframework/robot_report_example.png and /dev/null differ
diff --git a/doc/testing/testplan/README.md b/doc/testing/testplan/README.md
deleted file mode 100644
index 340bce285e9d96bdcb89a723a64d076b982385c7..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/README.md
+++ /dev/null
@@ -1,13 +0,0 @@
-# Test Plan Index
-List of Common API Services implemented:
-
-* [Common Operations](./common_operations/README.md)
-* [Api Invoker Management](./api_invoker_management/README.md)
-* [Api Provider Management](./api_provider_management/README.md)
-* [Api Publish Service](./api_publish_service/README.md)
-* [Api Discover Service](./api_discover_service/README.md)
-* [Api Events Service](./api_events_service/README.md)
-* [Api Security Service](./api_security_service/README.md)
-* [Api Logging Service](./api_logging_service/README.md)
-* [Api Auditing Service](./api_auditing_service/README.md)
-* [Api Access Control Policy](./api_access_control_policy/README.md)
diff --git a/doc/testing/testplan/api_access_control_policy/README.md b/doc/testing/testplan/api_access_control_policy/README.md
deleted file mode 100644
index 192495cdaa6e538852c45f4b68285b97bb71c5f7..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_access_control_policy/README.md
+++ /dev/null
@@ -1,829 +0,0 @@
-# Test Plan for CAPIF Api Access Control Policy
-At this documentation you will have all information and related files and examples of test plan for this API.
-
-## Test Case 1: Retrieve ACL
-
-**Test ID**: ***capif_api_acl-1***
-
-**Description**:
-
- This test case will check that an API Provider can retrieve ACL from CAPIF
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * API Invoker had a Security Context for Service API published.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}**
- * Use **serviceApiId** and **aefId**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
-
- 1. ACL Response:
- 1. **200 OK** Response.
- 2. body returned must accomplish **AccessControlPolicyList** data structure.
- 3. **apiInvokerPolicies** must:
- 1. contain only one object.
- 2. apiInvokerId must match apiInvokerId registered previously.
-
-
-## Test Case 2: Retrieve ACL with 2 Service APIs published
-
-**Test ID**: ***capif_api_acl-2***
-
-**Description**:
-
- This test case will check that an API Provider can retrieve ACL from CAPIF for 2 different serviceApis published.
-
-**Pre-Conditions**:
-
- * API Provider had two Service API Published on CAPIF
- * API Invoker had a Security Context for both Service APIs published.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1** and **service_2**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information for **service_1**.
- 7. Provider Get ACL information for **service_2**.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_2**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 4. Perform [Invoker Onboarding] store apiInvokerId
- 5. Discover published APIs
- 6. Create Security Context for this Invoker for both published APIs
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 7. Provider Retrieve ACL for **serviceApiId1**
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId1}?aef-id=${aef_id}**
- * Use **serviceApiId** and **aefId**
- * Use **AEF Provider Certificate**
-
- 8. Provider Retrieve ACL for serviceApiId2
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId2}?aef-id=${aef_id}**
- * Use **serviceApiId** and **aefId**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
-
- 1. ACL Response:
- 1. **200 OK** Response.
- 2. body returned must accomplish **AccessControlPolicyList** data structure.
- 3. **apiInvokerPolicies** must:
- 1. contain one object.
- 2. apiInvokerId must match apiInvokerId registered previously.
-
-## Test Case 3: Retrieve ACL with security context created by two different Invokers
-
-**Test ID**: ***capif_api_acl-3***
-
-**Description**:
-
- This test case will check that an API Provider can retrieve ACL from CAPIF containing 2 objects.
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * Two API Invokers had a Security Context for same Service API published by provider.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1** and **service_2**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker for both published APIs
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Repeat previous 3 steps in order to have a new Invoker.
-
- 7. Provider Retrieve ACL for serviceApiId
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId1}?aef-id=${aef_id}**
- * Use **serviceApiId** and **aefId**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
-
- 1. ACL Response:
- 1. **200 OK** Response.
- 2. body returned must accomplish **AccessControlPolicyList** data structure.
- 3. **apiInvokerPolicies** must:
- 1. Contain two objects.
- 2. One object must match with **apiInvokerId1** and the other one with **apiInvokerId2** an registered previously.
-
-## Test Case 4: Retrieve ACL filtered by api-invoker-id
-
-**Test ID**: ***capif_api_acl-4***
-
-**Description**:
-
- This test case will check that an API Provider can retrieve ACL filtering by apiInvokerId from CAPIF containing 1 objects.
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * Two API Invokers had a Security Context for same Service API published by provider.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1** and **service_2**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information with query parameter indicating first api-invoker-id.
- 7. Provider Get ACL information with query parameter indicating second api-invoker-id.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker for both published APIs
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Repeat previous 3 steps in order to have a new Invoker.
-
- 7. Provider Retrieve ACL for **serviceApiId1**
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}&api-invoker-id={apiInvokerId1}**
- * Use **serviceApiId**, **aefId** and **apiInvokerId1**
- * Use **AEF Provider Certificate**
-
- 8. Provider Retrieve ACL for **serviceApiId2**
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}&api-invoker-id={apiInvokerId2}**
- * Use **serviceApiId**, **aefId** and **apiInvokerId2**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
-
- 1. ACL Response:
- 1. **200 OK** Response.
- 2. body returned must accomplish **AccessControlPolicyList** data structure.
- 3. **apiInvokerPolicies** must:
- 1. Contain one objects.
- 2. Object must match with **apiInvokerId1**.
-
- 2. ACL Response:
- 1. **200 OK** Response.
- 2. body returned must accomplish **AccessControlPolicyList** data structure.
- 3. **apiInvokerPolicies** must:
- 1. Contain one objects.
- 2. Object must match with **apiInvokerId2**.
-
-## Test Case 5: Retrieve ACL filtered by supported-features
-
-**Test ID**: ***capif_api_acl-5***
-
-**Description**:
-
- **CURRENTLY NOT SUPPORTED FEATURE**
-
- This test case will check that an API Provider can retrieve ACL filtering by supportedFeatures from CAPIF containing 1 objects.
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * Two API Invokers had a Security Context for same Service API published by provider.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1** and **service_2**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information with query parameter indicating first supported-features.
- 7. Provider Get ACL information with query parameter indicating second supported-features.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker for both published APIs
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Repeat previous 3 steps in order to have a new Invoker.
-
- 7. Provider Retrieve ACL for serviceApiId
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId1}?aef-id=${aef_id}&supported-features={apiInvokerId1}**
- * Use **serviceApiId**, **aefId** and **apiInvokerId1**
- * Use **AEF Provider Certificate**
-
- 8. Provider Retrieve ACL for serviceApiId
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId1}?aef-id=${aef_id}&supported-features={apiInvokerId2}**
- * Use **serviceApiId**, **aefId** and **apiInvokerId2**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
-
- 1. ACL Response:
- 1. **200 OK** Response.
- 2. body returned must accomplish **AccessControlPolicyList** data structure.
- 3. **apiInvokerPolicies** must:
- 1. Contain one objects.
- 2. Object must match with supportedFeatures1.
-
- 2. ACL Response:
- 1. **200 OK** Response.
- 2. body returned must accomplish **AccessControlPolicyList** data structure.
- 3. **apiInvokerPolicies** must:
- 1. Contain one objects.
- 2. Object must match with supportedFeatures1.
-
-
-## Test Case 6: Retrieve ACL with aef-id not valid
-
-**Test ID**: ***capif_api_acl-6***
-
-**Description**:
-
- This test case will check that an API Provider can't retrieve ACL from CAPIF if aef-id is not valid
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * API Invoker had a Security Context for Service API published.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${AEF_ID_NOT_VALID}**
- * Use **serviceApiId** and **AEF_ID_NOT_VALID**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
-
- 1. ACL Response:
- 1. **404 Not Found** Response.
- 2. body returned must accomplish **Problem Details** data structure.
- 3. **apiInvokerPolicies** must:
- * status **404**
- * title with message "Not Found"
- * detail with message "No ACLs found for the requested service: {service_api_id}, aef_id: {aef_id}, invoker: {api_invoker_id} and supportedFeatures: {supported_features}".
- * cause with message "Wrong id".
-
-
-## Test Case 7: Retrieve ACL with service-id not valid
-
-**Test ID**: ***capif_api_acl-7***
-
-**Description**:
-
- This test case will check that an API Provider can't retrieve ACL from CAPIF if service-api-id is not valid
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * API Invoker had a Security Context for Service API published.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${NOT_VALID_SERVICE_API_ID}?aef-id=${aef_id}**
- * Use **NOT_VALID_SERVICE_API_ID** and **aef_id**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
-
- 1. ACL Response:
- 1. **404 Not Found** Response.
- 2. body returned must accomplish **Problem Details** data structure.
- 3. **apiInvokerPolicies** must:
- * status **404**
- * title with message "Not Found"
- * detail with message "No ACLs found for the requested service: {service_api_id}, aef_id: {aef_id}, invoker: {api_invoker_id} and supportedFeatures: {supported_features}".
- * cause with message "Wrong id".
-
-## Test Case 8: Retrieve ACL with service-api-id and aef-id not valid
-
-**Test ID**: ***capif_api_acl-8***
-
-**Description**:
-
- This test case will check that an API Provider can't retrieve ACL from CAPIF if service-api-id and aef-id are not valid
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * API Invoker had a Security Context for Service API published.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${NOT_VALID_SERVICE_API_ID}?aef-id=${AEF_ID_NOT_VALID}**
- * Use **NOT_VALID_SERVICE_API_ID** and **aef_id**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
-
- 1. ACL Response:
- 1. **404 Not Found** Response.
- 2. body returned must accomplish **Problem Details** data structure.
- 3. **apiInvokerPolicies** must:
- * status **404**
- * title with message "Not Found"
- * detail with message "No ACLs found for the requested service: {NOT_VALID_SERVICE_API_ID}, aef_id: {AEF_ID_NOT_VALID}, invoker: {api_invoker_id} and supportedFeatures: {supported_features}".
- * cause with message "Wrong id".
-
-
-## Test Case 9: Retrieve ACL without SecurityContext created previously by Invoker
-
-**Test ID**: ***capif_api_acl-9***
-
-**Description**:
-
- This test case will check that an API Provider can't retrieve ACL if no invoker had requested Security Context to CAPIF
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * API Invoker created but no Security Context for Service API published had been requested.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
-
- 5. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}**
- * Use **serviceApiId** and **aefId**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
-
- 1. ACL Response:
- 1. **404 Not Found** Response.
- 2. body returned must accomplish **Problem Details** data structure.
- 3. **apiInvokerPolicies** must:
- * status **404**
- * title with message "Not Found"
- * detail with message "No ACLs found for the requested service: {NOT_VALID_SERVICE_API_ID}, aef_id: {AEF_ID_NOT_VALID}, invoker: {api_invoker_id} and supportedFeatures: {supported_features}".
- * cause with message "Wrong id".
-
-## Test Case 10: Retrieve ACL filtered by api-invoker-id not present
-
-**Test ID**: ***capif_api_acl-10***
-
-**Description**:
-
- This test case will check that an API Provider get not found response if filter by not valid api-invoker-id doesn't match any registered ACL.
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * API Invoker had a Security Context for Service API published.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}&api-invoker-id={NOT_VALID_API_INVOKER_ID}**
- * Use **serviceApiId**, **aefId** and **NOT_VALID_API_INVOKER_ID**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
-
- 1. ACL Response:
- 1. **404 Not Found** Response.
- 2. body returned must accomplish **Problem Details** data structure.
- 3. **apiInvokerPolicies** must:
- * status **404**
- * title with message "Not Found"
- * detail with message "No ACLs found for the requested service: {NOT_VALID_SERVICE_API_ID}, aef_id: {AEF_ID_NOT_VALID}, invoker: {api_invoker_id} and supportedFeatures: {supported_features}".
- * cause with message "Wrong id".
-
-## Test Case 11: Retrieve ACL with APF Certificate
-
-**Test ID**: ***capif_api_acl-11***
-
-**Description**:
-
- This test case will check that an API Provider can't retrieve ACL from CAPIF using **APF Certificate**
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * API Invoker had a Security Context for Service API published.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}**
- * Use **serviceApiId** and **aefId**
- * Use APF Provider Certificate
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **401 Unauthorized**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 401
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "Certificate not authorized".
-
-## Test Case 12: Retrieve ACL with AMF Certificate
-
-**Test ID**: ***capif_api_acl-12***
-
-**Description**:
-
- This test case will check that an API Provider can't retrieve ACL from CAPIF using AMF Certificate
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * API Invoker had a Security Context for Service API published.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}**
- * Use **serviceApiId** and **aefId**
- * Use AMF Provider Certificate
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **401 Unauthorized**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 401
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "Certificate not authorized".
-
-## Test Case 13: Retrieve ACL with Invoker Certificate
-
-**Test ID**: ***capif_api_acl-13***
-
-**Description**:
-
- This test case will check that an API Provider can't retrieve ACL from CAPIF using **Invoker Certificate**
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * API Invoker had a Security Context for Service API published.
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}**
- * Use **serviceApiId** and **aefId**
- * Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **401 Unauthorized**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 401
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "Certificate not authorized".
-
-## Test Case 14: No ACL for invoker after be removed
-
-**Test ID**: ***capif_api_acl-14***
-
-**Description**:
-
- This test case will check that ACLs are removed after invoker is removed.
-
-**Pre-Conditions**:
-
- * API Provider had a Service API Published on CAPIF
- * API Invoker had a Security Context for Service API published and ACL is present
-
-**Execution Steps**:
-
- 1. Register and onboard Provider at CCF.
- 2. Publish a provider API with name **service_1**
- 3. Register and onboard Invoker at CCF
- 4. Store signed Certificate
- 5. Create Security Context
- 6. Provider Get ACL information of invoker.
- 7. Remove Invoker from CAPIF.
- 8. Provider Get ACL information of invoker.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [Invoker Onboarding] store apiInvokerId
- 4. Discover published APIs
- 5. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
- 6. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}&api-invoker-id={api-invoker-id}**
- * Use **serviceApiId**, **aefId** and **api-invoker-id**
- * Use **AEF Provider Certificate**
- 7. Remove Invoker from CAPIF
- 8. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}&api-invoker-id={api-invoker-id}**
- * Use **serviceApiId**, **aefId** and **api-invoker-id**
- * Use **AEF Provider Certificate**
-
-**Expected Result**:
- 1. ACL Response:
- 1. **200 OK** Response.
- 2. body returned must accomplish **AccessControlPolicyList** data structure.
- 3. **apiInvokerPolicies** must:
- 1. contain only one object.
- 2. apiInvokerId must match apiInvokerId registered previously.
-
- 2. ACL Response:
- 1. **404 Not Found** Response.
- 2. body returned must accomplish **Problem Details** data structure.
- 3. **apiInvokerPolicies** must:
- * status **404**
- * title with message "Not Found"
- * detail with message "No ACLs found for the requested service: {NOT_VALID_SERVICE_API_ID}, aef_id: {AEF_ID_NOT_VALID}, invoker: None and supportedFeatures: None".
- * cause with message "Wrong id".
-
-
-
-[service api description]: ../api_publish_service/service_api_description_post_example.json "Service API Description Request"
-[publisher register body]: ../api_publish_service/publisher_register_body.json "Publish register Body"
-[service security body]: ../api_security_service/service_security.json "Service Security Request"
-[security notification body]: ./security_notification.json "Security Notification Request"
-[access token req body]: ./access_token_req.json "Access Token Request"
-[example]: ./access_token_req.json "Access Token Request Example"
-[invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"
-[provider registration]: ../common_operations/README.md#register-a-provider "Provider Registration"
diff --git a/doc/testing/testplan/api_access_control_policy/service_api_description_post_example.json b/doc/testing/testplan/api_access_control_policy/service_api_description_post_example.json
deleted file mode 100644
index b725b428629509bf39a79c030f1bf93f4b6f18f6..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_access_control_policy/service_api_description_post_example.json
+++ /dev/null
@@ -1,113 +0,0 @@
-{
- "apiName": "service_1",
- "aefProfiles": [
- {
- "aefId": "string",
- "versions": [
- {
- "apiVersion": "v1",
- "expiry": "2021-11-30T10:32:02.004Z",
- "resources": [
- {
- "resourceName": "string",
- "commType": "REQUEST_RESPONSE",
- "uri": "string",
- "custOpName": "string",
- "operations": [
- "GET"
- ],
- "description": "string"
- }
- ],
- "custOperations": [
- {
- "commType": "REQUEST_RESPONSE",
- "custOpName": "string",
- "operations": [
- "GET"
- ],
- "description": "string"
- }
- ]
- }
- ],
- "protocol": "HTTP_1_1",
- "dataFormat": "JSON",
- "securityMethods": ["PSK"],
- "interfaceDescriptions": [
- {
- "ipv4Addr": "string",
- "port": 65535,
- "securityMethods": ["PSK"]
- },
- {
- "ipv4Addr": "string",
- "port": 65535,
- "securityMethods": ["PSK"]
- }
- ]
- },
- {
- "aefId": "string",
- "versions": [
- {
- "apiVersion": "v1",
- "expiry": "2021-11-30T10:32:02.004Z",
- "resources": [
- {
- "resourceName": "string",
- "commType": "REQUEST_RESPONSE",
- "uri": "string",
- "custOpName": "string",
- "operations": [
- "GET"
- ],
- "description": "string"
- }
- ],
- "custOperations": [
- {
- "commType": "REQUEST_RESPONSE",
- "custOpName": "string",
- "operations": [
- "GET"
- ],
- "description": "string"
- }
- ]
- }
- ],
- "protocol": "HTTP_1_1",
- "dataFormat": "JSON",
- "securityMethods": ["PSK"],
- "interfaceDescriptions": [
- {
- "ipv4Addr": "string",
- "port": 65535,
- "securityMethods": ["PSK"]
- },
- {
- "ipv4Addr": "string",
- "port": 65535,
- "securityMethods": ["PSK"]
- }
- ]
- }
- ],
- "description": "string",
- "supportedFeatures": "fffff",
- "shareableInfo": {
- "isShareable": true,
- "capifProvDoms": [
- "string"
- ]
- },
- "serviceAPICategory": "string",
- "apiSuppFeats": "fffff",
- "pubApiPath": {
- "ccfIds": [
- "string"
- ]
- },
- "ccfId": "string"
-}
\ No newline at end of file
diff --git a/doc/testing/testplan/api_auditing_service/README.md b/doc/testing/testplan/api_auditing_service/README.md
deleted file mode 100644
index 899dea9db452a86038af7d4ba28b55f571b153e8..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_auditing_service/README.md
+++ /dev/null
@@ -1,247 +0,0 @@
-# Test Plan for CAPIF Api Auditing Service
-At this documentation you will have all information and related files and examples of test plan for this API.
-
-## Test Case 1: Get CAPIF Log Entry.
-
-**Test ID**: ***capif_api_auditing-1***
-
-**Description**:
-
- This test case will check that a CAPIF AMF can get log entry to Logging Service
-
-**Pre-Conditions**:
-
- * CAPIF provider is pre-authorised (has valid AMF cert from CAPIF Authority)
- * Service exist in CAPIF
- * Invoker exist in CAPIF
- * Log Entry exist in CAPIF
-
-**Execution Steps**:
- 1. Register Provider and Invoker CCF
- 2. Publish Service
- 3. Create Log Entry
- 4. Get Log Entry
-
-**Information of Test**:
-
- 1. Perform [provider onboarding], [invoker onboarding]
-
- 2. Publish Service API at CCF:
- - Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- - body [service api description] with apiName **service_1**
- - Use **APF Certificate**
-
- 3. Create Log Entry:
- - Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**
- - body [log entry request body]
- - Use **AEF Certificate**
-
- 4. Get Log:
- 1. Send **GET** to **https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs?aef-id={aefId}&api-invoker-id={api-invoker-id}**
- 2. Use **AMF Certificate**
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **200 OK**
- 2. Response Body must follow **InvocationLog** data structure with:
- * aefId
- * apiInvokerId
- * logs
-
-## Test Case 2: Get CAPIF Log Entry With no Log entry in CAPIF.
-
-**Test ID**: ***capif_api_auditing-2***
-
-**Description**:
-
- This test case will check that a CAPIF AEF can create log entry to Logging Service
-
-**Pre-Conditions**:
-
- * CAPIF provider is pre-authorised (has valid AMF cert from CAPIF Authority)
- * Service exist in CAPIF
- * Invoker exist in CAPIF
-
-**Execution Steps**:
- 1. Register Provider and Invoker CCF
- 2. Publish Service
- 3. Get Log Entry
-
-**Information of Test**:
-
- 1. Perform [provider onboarding], [invoker onboarding]
-
- 2. Publish Service API at CCF:
- - Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- - body [service api description] with apiName **service_1**
- - Use **APF Certificate**
-
- 3. Get Log:
- 1. Send **GET** to **https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs?aef-id={aefId}&api-invoker-id={api-invoker-id}**
- 2. Use **AMF Certificate**
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found Log Entry in CAPIF".
- * cause with message "Not Exist Logs with the filters applied".
-
-
-## Test Case 3: Get CAPIF Log Entry without aef-id and api-invoker-id.
-
-**Test ID**: ***capif_api_auditing-3***
-
-**Description**:
-
- This test case will check that a CAPIF AEF can create log entry to Logging Service
-
-**Pre-Conditions**:
-
- * CAPIF provider is no pre-authorised (has no valid AMF cert from CAPIF Authority)
- * Service exist in CAPIF
- * Invoker exist in CAPIF
- * Log Entry exist in CAPIF
-
-**Execution Steps**:
- 1. Register Provider and Invoker CCF
- 2. Publish Service
- 3. Create Log Entry
- 4. Get Log Entry
-
-**Information of Test**:
-
- 1. Perform [provider onboarding], [invoker onboarding]
-
- 2. Publish Service API at CCF:
- - Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- - body [service api description] with apiName **service_1**
- - Use **APF Certificate**
-
- 3. Create Log Entry:
- - Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**
- - body [log entry request body]
- - Use **AEF Certificate**
-
- 4. Get Log:
- 1. Send **GET** to **https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs**
- 2. Use **AMF Certificate**
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **400 Bad Request**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 400
- * title with message "Bad Request"
- * detail with message "aef_id and api_invoker_id parameters are mandatory".
- * cause with message "Mandatory parameters missing".
-
-
-## Test Case 4: Get CAPIF Log Entry with filtter api-version.
-
-**Test ID**: ***capif_api_auditing-4***
-
-**Description**:
-
- This test case will check that a CAPIF AMF can get log entry to Logging Service
-
-**Pre-Conditions**:
-
- * CAPIF provider is pre-authorised (has valid AMF cert from CAPIF Authority)
- * Service exist in CAPIF
- * Invoker exist in CAPIF
- * Log Entry exist in CAPIF
-
-**Execution Steps**:
- 1. Register Provider and Invoker CCF
- 2. Publish Service
- 3. Create Log Entry
- 4. Get Log Entry
-
-**Information of Test**:
-
- 1. Perform [provider onboarding], [invoker onboarding]
-
- 2. Publish Service API at CCF:
- - Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- - body [service api description] with apiName **service_1**
- - Use **APF Certificate**
-
- 3. Create Log Entry:
- - Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**
- - body [log entry request body]
- - Use **AEF Certificate**
-
- 4. Get Log:
- 1. Send **GET** to **https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs?aef-id={aefId}&api-invoker-id={api-invoker-id}&api-version={v1}**
- 2. Use **AMF Certificate**
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **200 OK**
- 2. Response Body must follow **InvocationLog** data structure with:
- * aefId
- * apiInvokerId
- * logs
-
-
-## Test Case 5: Get CAPIF Log Entry with filter api-version but not exist in log entry.
-
-**Test ID**: ***capif_api_auditing-4***
-
-**Description**:
-
- This test case will check that a CAPIF AMF can get log entry to Logging Service
-
-**Pre-Conditions**:
-
- * CAPIF provider is pre-authorised (has valid AMF cert from CAPIF Authority)
- * Service exist in CAPIF
- * Invoker exist in CAPIF
- * Log Entry exist in CAPIF
-
-**Execution Steps**:
- 1. Register Provider and Invoker CCF
- 2. Publish Service
- 3. Create Log Entry
- 4. Get Log Entry
-
-**Information of Test**:
-
- 1. Perform [provider onboarding], [invoker onboarding]
-
- 2. Publish Service API at CCF:
- - Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- - body [service api description] with apiName **service_1**
- - Use **APF Certificate**
-
- 3. Create Log Entry:
- - Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**
- - body [log entry request body]
- - Use **AEF Certificate**
-
- 4. Get Log:
- 1. Send **GET** to **https://{CAPIF_HOSTNAME}/logs/v1/apiInvocationLogs?aef-id={aefId}&api-invoker-id={api-invoker-id}&api-version={v58}**
- 2. Use **AMF Certificate**
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * detail with message "Parameters do not match any log entry"
- * cause with message "No logs found".
-
-
-
-[log entry request body]: ../api_logging_service/invocation_log.json "Log Request Body"
-
-[invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"
-
-[provider onboarding]: ../common_operations/README.md#register-a-provider "Provider Onboarding"
diff --git a/doc/testing/testplan/api_discover_service/README.md b/doc/testing/testplan/api_discover_service/README.md
deleted file mode 100644
index 983756985056781638d66a5383e17274fddc8639..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_discover_service/README.md
+++ /dev/null
@@ -1,355 +0,0 @@
-# Test Plan for CAPIF Discover Service
-At this documentation you will have all information and related files and examples of test plan for this API.
-
-## Test Case 1: Discover Published service APIs by Authorised API Invoker
-
-**Test ID**: ***capif_api_discover_service-1***
-
-**Description**:
-
- This test case will check if Network App (Invoker) can discover published service APIs.
-
-**Pre-Conditions**:
-
- * Service APIs are published.
- * Network App was registered previously
- * Network App was onboarded previously with {onboardingId}
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API at CCF
- 2. Register Invoker and Onboard Invoker at CCF
- 3. Discover Service APIs by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
- 3. Request Discover Published APIs:
- * Send **GET** to **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
-
- 2. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
- 3. Response to Discover Request By Invoker:
- 1. **200 OK** response.
- 2. Response body must follow **DiscoveredAPIs** data structure:
- * Check if DiscoveredAPIs contains the API Published previously
-
-
-## Test Case 2: Discover Published service APIs by Non Authorised API Invoker
-
-**Test ID**: ***capif_api_discover_service-2***
-
-**Description**:
-
- This test case will check that an API Publisher can't discover published APIs because is not authorized.
-
-**Pre-Conditions**:
-
- * Service APIs are published.
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API at CCF
- 2. Register Invoker and Onboard Invoker at CCF
- 3. Discover Service APIs by no invoker entity
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
- 3. Request Discover Published APIs by no invoker entity:
- * Send **GET** to **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Use not **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
-
- 2. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
-
- 3. Response to Discover Request By no invoker entity:
- 1. **401 Unauthorized**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 401
- * title with message "Unauthorized"
- * detail with message "User not authorized".
- * cause with message "Certificate not authorized".
-
-
-## Test Case 3: Discover Published service APIs by not registered API Invoker
-
-**Test ID**: ***capif_api_discover_service-3***
-
-**Description**:
-
- This test case will check that a not registered invoker is forbidden to discover published APIs.
-
-**Pre-Conditions**:
-
- * Service APIs are published.
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API at CCF
- 2. Register Invoker and Onboard Invoker at CCF
- 3. Discover Service APIs by Publisher
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
- 3. Request Discover Published APIs with not valid apiInvoker:
- * Send **GET** to **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={INVOKER_NOT_REGISTERED}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
-
- 2. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
-
- 3. Response to Discover Request By Invoker:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found"
- * detail with message "API Invoker does not exist".
- * cause with message "API Invoker id not found".
-
-
-## Test Case 4: Discover Published service APIs by registered API Invoker with 1 result filtered
-
-**Test ID**: ***capif_api_discover_service-4***
-
-**Description**:
-
- This test case will check if Network App (Invoker) can discover published service APIs.
-
-**Pre-Conditions**:
-
- * At least 2 Service APIs are published.
- * Network App was registered previously
- * Network App was onboarded previously with {onboardingId}
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** and **service_2** at CCF
- 2. Register Invoker and Onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Discover filtered by api-name **service_1** Service APIs by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
- 3. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_2**
- * Use **APF Certificate**
- 4. Request Discover Published APIs filtering by api-name:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}&api-name=**service_1**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
- * filter by api-name **service_1**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
- 2. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
- 3. Response to Discover Request By Invoker:
- 1. **200 OK** response.
- 2. Response body must follow **DiscoveredAPIs** data structure:
- * Check if DiscoveredAPIs contains previously registered Service APIs published.
- 4. Response to Discover Request By Invoker:
- 1. **200 OK** response.
- 2. Response body must follow **DiscoveredAPIs** data structure:
- * Check if DiscoveredAPIs contains only Service API published with api-name **service_1**
-
-
-## Test Case 5: Discover Published service APIs by registered API Invoker filtered with no match
-
-**Test ID**: ***capif_api_discover_service-5***
-
-**Description**:
-
- This test case will check if Network App (Invoker) can discover published service APIs.
-
-**Pre-Conditions**:
-
- * At least 2 Service APIs are published.
- * Network App was registered previously
- * Network App was onboarded previously with {onboardingId}
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** and **service_2** at CCF
- 2. Register Invoker and Onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Discover filtered by api-name not published Service APIs by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
- 3. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_2**
- * Use **APF Certificate**
- 4. Request Discover Published APIs filtering by api-name not published:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}&api-name=NOT_VALID_NAME**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
- * filter by api-name NOT_VALID_NAME
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
- 2. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
- 3. Response to Discover Request By Invoker:
- 1. **200 OK** response.
- 2. Response body must follow **DiscoveredAPIs** data structure:
- * Check if DiscoveredAPIs contains previously registered Service APIs published.
- 4. Response to Discover Request By Invoker:
- 1. **404 Not Found** response.
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found"
- * detail with message "API Invoker {api_invoker_id} has no API Published that accomplish filter conditions".
- * cause with message "No API Published accomplish filter conditions".
-
-
-## Test Case 6: Discover Published service APIs by registered API Invoker not filtered
-
-**Test ID**: ***capif_api_discover_service-6***
-
-**Description**:
-
- This test case will check if Network App (Invoker) can discover published service APIs.
-
-**Pre-Conditions**:
-
- * 2 Service APIs are published.
- * Network App was registered previously
- * Network App was onboarded previously with {onboardingId}
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** and **service_2** at CCF
- 2. Register Invoker and Onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Discover without filter by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
- 3. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_2**
- * Use **APF Certificate**
- 4. Request Discover Published APIs not filtered:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
-
- 2. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
-
- 3. Response to Discover Request By Invoker:
- 1. **200 OK** response.
- 2. Response body must follow **DiscoveredAPIs** data structure:
- * Check if DiscoveredAPIs contains the 2 previously registered Service APIs published.
-
-
-
- [service api description]: ../api_publish_service/service_api_description_post_example.json "Service API **Description** Request"
- [publisher register body]: ../api_publish_service/publisher_register_body.json "Publish register Body"
- [invoker onboarding body]: ../api_invoker_management/invoker_details_post_example.json "API Invoker Request"
- [provider request body]: ../api_provider_management/provider_details_post_example.json "API Provider Enrolment Request"
- [provider request patch body]: ../api_provider_management/provider_details_enrolment_details_patch_example.json "API Provider Enrolment Patch Request"
-
- [invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"
- [provider registration]: ../common_operations/README.md#register-a-provider "Provider Registration"
diff --git a/doc/testing/testplan/api_events_service/README.md b/doc/testing/testplan/api_events_service/README.md
deleted file mode 100644
index 73106b7145ca7600a988601d0fa624903e26d087..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_events_service/README.md
+++ /dev/null
@@ -1,759 +0,0 @@
-# Test Plan for CAPIF Api Events Service
-At this documentation you will have all information and related files and examples of test plan for this API.
-
----
-## Test Case 1: Creates a new individual CAPIF Event Subscription.
-
-**Test ID**: ***capif_api_events-1***
-
-**Description**:
-
- This test case will check that a CAPIF subscriber (Invoker or Publisher) can Subscribe to Events
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid InvokerId or apfId from CAPIF Authority)
-
-**Execution Steps**:
-
- 1. Register Invoker and Onboard Invoker at CCF
- 2. Subscribe to Events
- 3. Retrieve {subscriberId} and {subscriptionId} from Location Header
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Event Subscription:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body]
- 3. Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
-
- 2. Response to Event Subscription must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
-
- 3. Event Subscriptions are stored in CAPIF Database
-
----
-## Test Case 2: Creates a new individual CAPIF Event Subscription with Invalid SubscriberId
-
-**Test ID**: ***capif_api_events-2***
-
-**Description**:
-
- This test case will check that a CAPIF subscriber (Invoker or Publisher) cannot Subscribe to Events without valid SubcriberId
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is not pre-authorised (has invalid InvokerId or apfId)
-
-**Execution Steps**:
-
- 1. Register Invoker and Onboard Invoker at CCF
- 2. Subscribe to Events
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Event Subscription:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{SUBSCRIBER_NOT_REGISTERED}/subscriptions**
- 2. body [event subscription request body]
- 3. Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
-
- 2. Response to Event Subscription must accomplish:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found"
- * detail with message "Invoker or APF or AEF or AMF Not found".
- * cause with message "Subscriber Not Found".
-
- 3. Event Subscriptions are not stored in CAPIF Database
-
----
-## Test Case 3: Deletes an individual CAPIF Event Subscription
-
-**Test ID**: ***capif_api_events-3***
-
-**Description**:
-
- This test case will check that a CAPIF subscriber (Invoker or Publisher) can Delete an Event Subscription
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid InvokerId or apfId from CAPIF Authority)
-
-**Execution Steps**:
-
- 1. Register Invoker and Onboard Invoker at CCF
- 2. Subscribe to Events
- 3. Retrieve {subscriberId} and {subscriptionId} from Location Header
- 4. Remove Event Subscription
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Event Subscription:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body]
- 3. Use **Invoker Certificate**
-
- 3. Remove Event Subscription:
- 1. Send **DELETE** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
-
- 2. Response to Event Subscription must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
-
- 3. Event Subscriptions are stored in CAPIF Database
- 4. Remove Event Subscription:
- 1. **204 No Content**
-
- 5. Event Subscription is not present at CAPIF Database.
-
----
-## Test Case 4: Deletes an individual CAPIF Event Subscription with invalid SubscriberId
-
-**Test ID**: ***capif_api_events-4***
-
-**Description**:
-
- This test case will check that a CAPIF subscriber (Invoker or Publisher) cannot Delete to Events without valid SubcriberId
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid InvokerId or apfId).
- * CAPIF subscriber is subscribed to Events.
-
-**Execution Steps**:
-
- 1. Register Invoker and Onboard Invoker at CCF
- 2. Subscribe to Events
- 3. Retrieve Location Header with subscriptionId.
- 4. Remove Event Subscribed with not valid Subscriber.
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Event Subscription:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body]
- 3. Use **Invoker Certificate**
-
- 3. Remove Event Subcription with not valid subscriber:
- 1. Send **DELETE** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{SUBSCRIBER_ID_NOT_VALID}/subscriptions/{subcriptionId}**
- 2. Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
-
- 2. Response to Event Subscription must accomplish:
- 1. 201 Created
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
-
- 3. Event Subscriptions are stored in CAPIF Database
- 4. Error Response Body must accomplish with **ProblemDetails** data structure with:
-
- * status 404
- * title with message "Not Found"
- * detail with message "Invoker or APF or AEF or AMF Not found".
- * cause with message "Subscriber Not Found".
-
----
-## Test Case 5: Deletes an individual CAPIF Event Subscription with invalid SubscriptionId
-
-**Test ID**: ***capif_api_events-5***
-
-**Description**:
-
- This test case will check that a CAPIF subscriber (Invoker or Publisher) cannot Delete an Event Subscription without valid SubscriptionId
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has invalid InvokerId or apfId).
- * CAPIF subscriber is subscribed to Events.
-
-**Execution Steps**:
-
- 1. Register Invoker and Onboard Invoker at CCF
- 2. Subscribe to Events
- 3. Retrieve Location Header with subscriptionId.
- 4. Remove Event Subscribed with not valid Subscriber.
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Event Subscription:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body]
- 3. Use **Invoker Certificate**
-
- 3. Remove Event Subcription with not valid subscriber:
- 1. Send **DELETE** to to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subcriberId}/subscriptions/{SUBSCRIPTION_ID_NOT_VALID}**
- 2. Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
-
- 2. Response to Event Subscription must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
-
- 3. Event Subscriptions are stored in CAPIF Database
- 4. Remove Event Subscription with not valid subscriber:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * detail with message "Service API not existing".
- * cause with message "Event API subscription id not found".
-
----
-## Test Case 6: Invoker receives Service API Invocation events
-
-**Test ID**: ***capif_api_events-6***, ***mockserver***
-
-**Description**:
-
- This test case will check that a CAPIF Invoker subscribed to SERVICE_API_INVOCATION_SUCCESS and SERVICE_API_INVOCATION_FAILURE, receive the notification when AEF Send **TO** logging service result of invocations to their APIs.
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid InvokerId or apfId from CAPIF Authority)
- * CAPIF provider is correctly registered and published APIs.
- * API Provider had a Service API Published on CAPIF
- * **Mock Server is up and running to receive requests.**
- * **Mock Server is clean.**
-
-**Execution Steps**:
-
- 1. Register provider and publish one API at CCF
- 2. Register Invoker and Onboard Invoker at CCF
- 3. Discover published APIs and extract apiIds and apiNames
- 4. Subscribe to **SERVICE_API_INVOCATION_SUCCESS** and **SERVICE_API_INVOCATION_FAILURE** event filtering by aefId.
- 5. Retrieve {subscriberId} and {subscriptionId} from Location Header
- 6. Emulate Success and Failure on API invocation of provider by Invoker, using Invocation Logs API.
-
-**Information of Test**:
-
- 1. Perform [provider registration]
- 2. Publish Service API at CCF:
-
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [invoker onboarding]
- 4. Discover published APIs:
-
- * Get **Api Ids** And **Api Names** from response.
-
- 5. Event Subscription to SERVICE_API_INVOCATION_SUCCESS and SERVICE_API_INVOCATION_FAILURE of provider previously registered:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body] with:
- 1. events: **['SERVICE_API_INVOCATION_SUCCESS','SERVICE_API_INVOCATION_FAILURE']**
- 2. eventFilter: only receive events from provider's aefId.
- 3. Use **Invoker Certificate**
-
- 7. Create Log Entry emulating provider receive Success and Failure api invocation from invoker:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**
- 2. body [log entry request body] with:
- 1. aefId from provider published.
- 2. apiInvokerId from invoker onboarded.
- 3. apiId of published API
- 4. apiName of published API
- 5. 200 and 400 results in two logs.
- 3. Use **AEF Certificate**
-
-**Expected Result**:
-
- 1. Response to Event Subscription must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
- 2. Response to creation of log entry on CCF must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/api-invocation-logs/{apiVersion}/{aefId}/subscriptions/{logId}**
- 3. Mock Server received messages must accomplish:
- 1. **Two Events have been received**.
- 2. Validate received events follow **EventNotification** data structure, with **invocationLog** in **eventDetail** parameter.
- 1. One should be **SERVICE_API_INVOCATION_SUCCESS** related with **200** result at Log.
- 2. The other one must be **SERVICE_API_INVOCATION_FAILURE** related with **400** result at Log.
-
----
-## Test Case 7: Invoker subscribe to Service API Available and Unavailable events
-
-**Test ID**: ***capif_api_events-7***, ***mockserver***
-
-**Description**:
-
- This test case will check that a CAPIF Invoker subscribed to SERVICE_API_AVAILABLE and SERVICE_API_UNAVAILABLE, receive the notification when AEF publish and remove it.
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid InvokerId or apfId from CAPIF Authority)
- * CAPIF provider is correctly registered and published APIs.
- * **Mock Server is up and running to receive requests.**
- * **Mock Server is clean.**
-
-**Execution Steps**:
-
- 1. Register provider and publish one API at CCF
- 2. Register Invoker and Onboard Invoker at CCF
- 3. Discover published APIs and extract apiIds and apiNames
- 4. Subscribe to **SERVICE_API_AVAILABLE** and **SERVICE_API_UNAVAILABLE** event filtering by aefId.
- 5. Retrieve {subscriberId} and {subscriptionId} from Location Header
- 6. Provider publish new API.
- 7. Provider remove published API.
-
-**Information of Test**:
-
- 1. Perform [provider registration]
- 2. Publish Service API at CCF:
-
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 3. Perform [invoker onboarding]
- 4. Discover published APIs:
-
- * Get **Api Ids** And **Api Names** from response.
-
- 5. Event Subscription to SERVICE_API_AVAILABLE and SERVICE_API_UNAVAILABLE of provider previously registered:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body] with:
- 1. events: **['SERVICE_API_AVAILABLE','SERVICE_API_UNAVAILABLE']**
- 2. eventFilter: only receive events from provider's aefId.
- 3. Use **Invoker Certificate**
-
- 6. Publish new Service API at CCF:
-
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_2**
- * Store **serviceApiId**
- * Use **APF Certificate**
-
- 7. Remove published Service API at CCF:
- * Send **DELETE** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{SERVICE_API_ID}**
- * Use **APF Certificate**
-
-
-**Expected Result**:
-
- 1. Response to Event Subscription must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
-
- 2. Mock Server received messages must accomplish:
- 1. **Two Events have been received**.
- 2. Validate received events follow **EventNotification** data structure, with **apiIds** in **eventDetail** parameter.
- 1. One should be **SERVICE_API_AVAILABLE** apiId of **service_2** published API.
- 2. The other one must be **SERVICE_API_UNAVAILABLE** apiId of **service_1** published API.
-
----
-## Test Case 8: Invoker subscribe to Service API Update
-
-**Test ID**: ***capif_api_events-8***, ***mockserver***
-
-**Description**:
-
- This test case will check that a CAPIF Invoker subscribed to SERVICE_API_UPDATE, receive the notification when AEF Update some information on API Published.
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid InvokerId or apfId from CAPIF Authority)
- * CAPIF provider is correctly registered and published APIs.
- * API Provider had a Service API Published on CAPIF
- * **Mock Server is up and running to receive requests.**
- * **Mock Server is clean.**
-
-**Execution Steps**:
-
- 1. Register Provider and publish one API at CCF
- 2. Register Invoker and Onboard Invoker at CCF
- 3. Discover published APIs and extract apiIds and apiNames
- 4. Subscribe to **SERVICE_API_UPDATE** event filtering by aefId.
- 5. Retrieve {subscriberId} and {subscriptionId} from Location Header at event subscription
- 6. Provider update information of Service API Published.
-
-**Information of Test**:
-
- 1. Check and Clean Mock Server
- 2. Perform [provider registration]
- 3. Publish Service API at CCF:
-
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use ***APF Certificate***
- * Store **serviceApiId**
-
- 4. Perform [invoker onboarding]
- 5. Discover published APIs:
-
- * Get **Api Ids** And **Api Names** from response.
-
- 6. Event Subscription to SERVICE_API_UPDATE of provider previously registered:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body] with:
- 1. events: **['SERVICE_API_UPDATE']**
- 2. eventFilter: only receive events from provider's aefId.
- 3. Use **Invoker Certificate**
-
- 7. Update published API at CCF:
- * Send **PUT** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{serivceApiId}**
- * body [service api description] with overrided **apiName** to **service_1**_modified**
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to Event Subscription must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
- 2. Response to Update Published Service API:
- 1. **200 OK**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiName **service_1**_modified**
- 3. Mock Server received messages must accomplish:
- 1. **One Event has been received**.
- 2. Validate received events follow **EventNotification** data structure, with **serviceAPIDescriptions** in **eventDetail** parameter.
- 1. Event should be **SERVICE_API_UPDATE** with **eventDetail** with modified **apiName**.
-
----
-## Test Case 9: Provider subscribe to API Invoker events
-
-**Test ID**: ***capif_api_events-9***, ***mockserver***
-
-**Description**:
-
- This test case will check that a CAPIF Provider subscribed to API Invoker events (API_INVOKER_ONBOARDED, API_INVOKER_UPDATED and API_INVOKER_OFFBOARDED), receive the notifications when Invoker is onboarded, updated and removed respectively.
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid InvokerId or apfId from CAPIF Authority)
- * CAPIF provider is correctly registered.
- * **Mock Server is up and running to receive requests.**
- * **Mock Server is clean.**
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Subscribe Provider to **API_INVOKER_ONBOARDED, API_INVOKER_UPDATED and API_INVOKER_OFFBOARDED** events.
- 3. Register Invoker and Onboard Invoker at CCF
- 4. Update Onboarding Information at CCF with a minor change on "notificationDestination"
- 5. Offboard Invoker
-
-**Information of Test**:
-
- 1. Check and Clean Mock Server
- 2. Perform [provider registration]
- 3. Event Subscription to API_INVOKER_ONBOARDED, API_INVOKER_UPDATED and API_INVOKER_OFFBOARDED events:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body] with:
- 1. events: **['API_INVOKER_ONBOARDED', 'API_INVOKER_UPDATED', 'API_INVOKER_OFFBOARDED']**
- 3. Use **Provider AMF Certificate**
- 4. Perform [invoker onboarding]
- 5. Update information of previously onboarded Invoker:
- * Send **PUT** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers/{onboardingId}**
- * Reference Request Body is: [put invoker onboarding body]
- * "notificationDestination": "**http://host.docker.internal:8086/netapp_new_callback**",
- 6. Offboard:
- * Send **DELETE** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers/{onboardingId}**
-
-**Expected Result**:
-
- 1. Response to Event Subscription must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
- 2. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
- 3. Response to Update Request (PUT) with minor change must contain:
- 1. **200 OK** response.
- 2. notificationDestination on response must contain the new value
- 4. Response to Offboard Request (DELETE) must contain:
- 1. **204 No Content**
- 5. Mock Server received messages must accomplish:
- 1. **Three Events have been received**.
- 2. Validate received events follow **EventNotification** data structure, with **apiInvokerIds** in **eventDetail** parameter.
- 1. One Event should be **API_INVOKER_ONBOARDED** with **eventDetail** with modified **apiInvokerId**.
- 2. One Event should be **API_INVOKER_UPDATED** with **eventDetail** with modified **apiInvokerId**.
- 3. One Event should be **API_INVOKER_OFFBOARDED** with **eventDetail** with modified **apiInvokerId**.
----
-## Test Case 10: Provider subscribed to ACL update event
-
-**Test ID**: ***capif_api_events-10***, ***mockserver***
-
-**Description**:
-
- This test case will check that a CAPIF Provider subscribed to ACCESS_CONTROL_POLICY_UPDATE receive a notification when ACL Changes.
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid InvokerId or apfId from CAPIF Authority)
- * CAPIF provider is correctly registered.
- * API Provider had one Service API Published on CAPIF
- * API Invoker had a Security Context for the Service API published by provider.
- * **Mock Server is up and running to receive requests.**
- * **Mock Server is clean.**
-
-**Execution Steps**:
-
- 1. Register Provider at CCF.
- 2. Publish a provider API with name **service_1**.
- 3. Register Invoker and Onboard Invoker at CCF.
- 4. Subscribe Provider to **ACCESS_CONTROL_POLICY_UPDATE** event.
- 5. Discover APIs filtered by **aef_id**
- 6. Create Security Context for Invoker.
- 7. Provider Retrieve ACL
-
-**Information of Test**:
-
- 1. Check and Clean Mock Server
- 2. Perform [provider registration]
- 3. Perform [invoker onboarding]
- 4. Event Subscription to **ACCESS_CONTROL_POLICY_UPDATE** event:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body] with:
- 1. events: **['ACCESS_CONTROL_POLICY_UPDATE']**
- 2. eventFilters: apiInvokerIds array with apiInvokerId of invoker
- 3. Use **Provider AMF Certificate**
- 5. Discover published APIs
- 6. Create Security Context for Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
- 7. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}**
- * Use **serviceApiId** and **aefId**
- * Use AEF Provider Certificate
-
-**Expected Result**:
-
- 1. Response to Event Subscription must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
- 2. Create security context:
- 1. **201 Created** response.
- 2. body returned must accomplish **ServiceSecurity** data structure.
- 3. Location Header must contain the new resource URL **{apiRoot}/capif-security/v1/trustedInvokers/{apiInvokerId}**
- 3. ACL Response:
- 1. **200 OK** Response.
- 2. body returned must accomplish **AccessControlPolicyList** data structure.
- 3. apiInvokerPolicies must:
- 1. contain only one object.
- 2. apiInvokerId must match apiInvokerId registered previously.
- 4. Mock Server received messages must accomplish:
- 1. **One Event has been received**.
- 2. Validate received event follow **EventNotification** data structure, with **accCtrlPolListExt** in **eventDetail** parameter.
- 1. One Event should be **ACCESS_CONTROL_POLICY_UPDATE** with **eventDetail** with **accCtrlPolListExt** including the **apiId** and **apiInvokerPolicies**.
-
----
-## Test Case 11: Provider receives an ACL unavailable event when invoker remove Security Context.
-
-**Test ID**: ***capif_api_events-11***, ***mockserver***
-
-**Description**:
-
- This test case will check that a CAPIF Invoker subscribed to ACCESS_CONTROL_POLICY_UNAVAILABLE will receive the notification when AEF remove Security Context created previously.
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid InvokerId or apfId from CAPIF Authority)
- * CAPIF provider is correctly registered.
- * API Provider had one Service API Published on CAPIF
- * **Mock Server is up and running to receive requests.**
- * **Mock Server is clean.**
-
-**Execution Steps**:
-
- 1. Register Provider at CCF.
- 2. Publish a provider API with name **service_1**.
- 3. Register Invoker and Onboard Invoker at CCF.
- 4. Subscribe Invoker to **ACCESS_CONTROL_POLICY_UNAVAILABLE** event.
- 5. Discover APIs filtered by **aef_id**
- 6. Create Security Context for Invoker.
- 7. Provider Retrieve ACL.
- 8. Remove Security Context for Invoker.
-
-**Information of Test**:
-
- 1. Check and Clean Mock Server
- 2. Perform [provider registration]
- 3. Perform [invoker onboarding]
- 4. Event Subscription to **ACCESS_CONTROL_POLICY_UNAVAILABLE** event:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body] with:
- 1. events: **['ACCESS_CONTROL_POLICY_UNAVAILABLE']**
- 2. eventFilters: apiInvokerIds array with apiInvokerId of invoker
- 3. Use **Invoker Certificate**
- 5. Discover published APIs
- 6. Create Security Context for Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
- 7. Provider Retrieve ACL
- * Send **GET** **https://{CAPIF_HOSTNAME}/access-control-policy/v1/accessControlPolicyList/${serviceApiId}?aef-id=${aef_id}**
- * Use **serviceApiId** and **aefId**
- * Use **AEF Provider Certificate**
- 3. Delete Security Context of Invoker by Provider:
- * Send **DELETE** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * Use **AEF Certificate**
-
-**Expected Result**:
-
- 1. Response to Event Subscription must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
- 2. Create security context:
- 1. **201 Created** response.
- 2. body returned must accomplish **ServiceSecurity** data structure.
- 3. Location Header must contain the new resource URL **{apiRoot}/capif-security/v1/trustedInvokers/{apiInvokerId}**
- 3. ACL Response:
- 1. **200 OK** Response.
- 2. body returned must accomplish **AccessControlPolicyList** data structure.
- 3. apiInvokerPolicies must:
- 1. contain only one object.
- 2. apiInvokerId must match apiInvokerId registered previously.
- 4. Delete security context:
- 1. **204 No Content** response.
- 5. Mock Server received messages must accomplish:
- 1. **One Event has been received**.
- 2. Validate received event follow **EventNotification** data structure, without **eventDetail** parameter.
- 1. One Event should be **ACCESS_CONTROL_POLICY_UNAVAILABLE** without **eventDetail**.
----
-## Test Case 12: Invoker receives an Invoker Authorization Revoked and ACL unavailable event when Provider revoke Invoker Authorization.
-
-**Test ID**: ***capif_api_events-12***, ***mockserver***
-
-**Description**:
-
- This test case will check that a CAPIF Invoker subscribed to API_INVOKER_AUTHORIZATION_REVOKED and ACCESS_CONTROL_POLICY_UNAVAILABLE receive both notification when AEF revoke invoker's authorization.
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid InvokerId or apfId from CAPIF Authority)
- * CAPIF provider is correctly registered.
- * API Provider had one Service API Published on CAPIF
- * **Mock Server is up and running to receive requests.**
- * **Mock Server is clean.**
-
-**Execution Steps**:
-
- 1. Register Provider at CCF.
- 2. Publish a provider API with name **service_1**.
- 3. Register Invoker and Onboard Invoker at CCF.
- 4. Subscribe Invoker to **ACCESS_CONTROL_POLICY_UNAVAILABLE and API_INVOKER_AUTHORIZATION_REVOKED** events.
- 5. Discover APIs filtered by **aef_id**
- 6. Create Security Context for Invoker.
- 7. Revoke Authorization by Provider.
-
-**Information of Test**:
-
- 1. Check and Clean Mock Server
- 2. Perform [provider registration]
- 3. Perform [invoker onboarding]
- 4. Event Subscription to **ACCESS_CONTROL_POLICY_UNAVAILABLE and API_INVOKER_AUTHORIZATION_REVOKED** event:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/capif-events/v1/{subscriberId}/subscriptions**
- 2. body [event subscription request body] with:
- 1. events: **['ACCESS_CONTROL_POLICY_UNAVAILABLE','API_INVOKER_AUTHORIZATION_REVOKED']**
- 2. eventFilters: apiInvokerIds array with apiInvokerId of invoker
- 3. Use **Invoker Certificate**
- 5. Discover published APIs
- 6. Create Security Context for Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
- 7. Revoke Authorization by Provider:
- * Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}/delete**
- * body [security notification body]
- * Using **AEF Certificate**.
-
-**Expected Result**:
-
- 1. Response to Event Subscription must accomplish:
- 1. **201 Created**
- 2. The URI of the created resource shall be returned in the "Location" HTTP header, following this structure: **{apiRoot}/capif-events/{apiVersion}/{subscriberId}/subscriptions/{subscriptionId}**
- 3. Response Body must follow **EventSubscription** data structure.
- 2. Create security context:
- 1. **201 Created** response.
- 2. body returned must accomplish **ServiceSecurity** data structure.
- 3. Location Header must contain the new resource URL **{apiRoot}/capif-security/v1/trustedInvokers/{apiInvokerId}**
- 4. Revoke Authorization:
- 1. **204 No Content** response.
- 5. Mock Server received messages must accomplish:
- 1. **Two Events has been received**.
- 2. Validate received event follow **EventNotification** data structure, without **eventDetail** parameter.
- 1. One Event should be **ACCESS_CONTROL_POLICY_UNAVAILABLE** without **eventDetail**.
- 2. One Event should be **API_INVOKER_AUTHORIZATION_REVOKED** without **eventDetail**.
-
----
-
-[invoker onboard request body]: ../api_invoker_management/invoker_details_post_example.json "API Invoker Request"
-[event subscription request body]: ./event_subscription.json "Event Subscription Request"
-[invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"
-[provider registration]: ../common_operations/README.md#register-a-provider "Provider Registration"
-[log entry request body]: ../api_logging_service/invocation_log.json "Log Request Body"
-[put register body]: ./invoker_details_put_example.json "API Invoker Update Request"
-[service security body]: ../api_security_service/service_security.json "Service Security Request"
-[security notification body]: ./security_notification.json "Security Notification Request"
-
-[Return To All Test Plans]: ../README.md
diff --git a/doc/testing/testplan/api_events_service/event_subscription.json b/doc/testing/testplan/api_events_service/event_subscription.json
deleted file mode 100644
index 40dc09bb1ca5236fa9cb23ff1a25ad5dccd28844..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_events_service/event_subscription.json
+++ /dev/null
@@ -1,31 +0,0 @@
-{
- "eventFilters": [
- {
- "aefIds": ["aefIds", "aefIds"],
- "apiIds": ["apiIds", "apiIds"],
- "apiInvokerIds": ["apiInvokerIds", "apiInvokerIds"]
- },
- {
- "aefIds": ["aefIds", "aefIds"],
- "apiIds": ["apiIds", "apiIds"],
- "apiInvokerIds": ["apiInvokerIds", "apiInvokerIds"]
- }
- ],
- "eventReq": {
- "grpRepTime": 5,
- "immRep": true,
- "maxReportNbr": 0,
- "monDur": "2000-01-23T04:56:07+00:00",
- "partitionCriteria": ["string1", "string2"],
- "repPeriod": 6,
- "sampRatio": 15
- },
- "events": ["SERVICE_API_AVAILABLE", "API_INVOKER_ONBOARDED"],
- "notificationDestination": "http://robot.testing",
- "requestTestNotification": true,
- "supportedFeatures": "aaa",
- "websockNotifConfig": {
- "requestWebsocketUri": true,
- "websocketUri": "websocketUri"
- }
-}
diff --git a/doc/testing/testplan/api_invoker_management/README.md b/doc/testing/testplan/api_invoker_management/README.md
deleted file mode 100644
index 076d9e7af395e100cef102c0b5251e124d136454..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_invoker_management/README.md
+++ /dev/null
@@ -1,309 +0,0 @@
-# Test Plan for CAPIF Api Invoker Management
-At this documentation you will have all information and related files and examples of test plan for this API.
-
-## Test Case 1: Onboard Network App
-
-**Test ID**: ***capif_api_invoker_management-1***
-
-**Description**:
-
- This test will try to register new Network App at CAPIF Core.
-
-**Pre-Conditions**:
-
- * Network App was not registered previously
- * Network App was not onboarded previously
- * ***Preconditions: The administrator must have previously registered the User.***
-
-**Execution Steps**:
-
- 1. Retrieve access_token by User from register
- 2. Onboard Invoker at CCF
- 3. Store signed Certificate
-
-**Information of Test**:
-
- 1. Create public and private key at invoker
-
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Onboard Invoker:
- * Send **POST** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers**
- * Reference Request Body: [invoker onboarding body]
- * "onboardingInformation"->"apiInvokerPublicKey": must contain public key generated by Invoker.
- * Send in Authorization Header the Bearer access_token obtained previously (Authorization:Bearer ${access_token})
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
-
-
-## Test Case 2: Onboard Network App Already onboarded
-
-**Test ID**: ***capif_api_invoker_management-2***
-
-**Description**:
-
- This test will check second onboard of same Network App is not allowed.
-
-**Pre-Conditions**:
-
- * Network App was registered previously
- * Network App was onboarded previously
-
-**Execution Steps**:
-
- 1. Register Network App at CCF
- 2. Onboard Network App at CCF
- 3. Store signed Certificate at Network App
- 4. Onboard Again the Network App at CCF
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Repeat Onboard Invoker:
- * Send **POST** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers**
- * Reference Request Body: [invoker onboarding body]
- * "onboardingInformation"->"apiInvokerPublicKey": must contain public key generated by Invoker.
- * Send in Authorization Header the Bearer access_token obtained previously (Authorization:Bearer ${access_token})
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
- 2. Response to Second Onboard of Network App must accomplish:
- 1. **403 Forbidden**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 403
- * title with message "Forbidden"
- * detail with message "Invoker Already registered".
- * cause with message "Identical invoker public key".
-
-
-## Test Case 3: Update Onboarded Network App
-
-**Test ID**: ***capif_api_invoker_management-3***
-
-**Description**:
-
- This test will try to update information of previous onboard Network App at CAPIF Core.
-
-**Pre-Conditions**:
-
- * Network App was registered previously
- * Network App was onboarded previously with {onboardingId}
-
-**Execution Steps**:
-
- 1. Register Invoker at CCF
- 2. Onboard Invoker at CCF
- 3. Store signed Certificate
- 4. Update Onboarding Information at CCF with a minor change on "notificationDestination"
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Update information of previously onboarded Invoker:
- * Send **PUT** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers/{onboardingId}**
- * Reference Request Body is: [put invoker onboarding body]
- * "notificationDestination": "*http://host.docker.internal:8086/netapp_new_callback*",
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
- 2. Response to Update Request (PUT) with minor change must contain:
- 1. **200 OK** response.
- 2. notificationDestination on response must contain the new value
-
-
-## Test Case 4: Update Not Onboarded Network App
-
-**Test ID**: ***capif_api_invoker_management-4***
-
-**Description**:
-
- This test will try to update information of not onboarded Network App at CAPIF Core.
-
-**Pre-Conditions**:
-
- * Network App was registered previously
- * Network App was not onboarded previously
-
-**Execution Steps**:
-
- 1. Register Invoker at CCF
- 2. Onboard Invoker at CCF
- 3. Update Onboarding Information at CCF of not onboarded
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Update information of not onboarded Invoker:
- * Send **PUT** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers/{INVOKER_NOT_REGISTERED}**
- * Reference Request Body is: [put invoker onboarding body]
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response to Update Request (PUT) must contain:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found"
- * detail with message "Please provide an existing Network App ID".
- * cause with message "Not exist Network App ID".
-
-
-## Test Case 5: Offboard Network App
-
-**Test ID**: ***capif_api_invoker_management-5***
-
-**Description**:
-
- This test case will check that a Registered Network App can be deleted.
-
-**Pre-Conditions**:
-
- * Network App was registered previously
- * Network App was onboarded previously
-
-**Execution Steps**:
-
- 1. Register Invoker at CCF
- 2. Onboard Invoker at CCF
- 3. Offboard Invoker at CCF
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Offboard:
- * Send **DELETE** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers/{onboardingId}**
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response to Offboard Request (DELETE) must contain:
- 1. **204 No Content**
-
-
-## Test Case 6: Offboard Not previsouly Onboarded Network App
-
-**Test ID**: ***capif_api_invoker_management-6***
-
-**Description**:
-
- This test case will check that a Non-Registered Network App cannot be deleted
-
-**Pre-Conditions**:
-
- * Network App was registered previously
- * Network App was not onboarded previously
-
-**Execution Steps**:
-
- 1. Register Invoker at CCF
- 2. Offboard Invoker at CCF
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Offboard:
- * Send **DELETE** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers/{INVOKER_NOT_REGISTERED}**
-
-**Expected Result**:
-
- 1. Response to Offboard Request (DELETE) must contain:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found"
- * detail with message "Please provide an existing Network App ID".
- * cause with message "Not exist Network App ID".
-
-## Test Case 7: Update Onboarded Network App Certificate
-
-**Test ID**: ***capif_api_invoker_management-7***
-
-**Description**:
-
- This test will try to update public key and get a new signed certificate by CAPIF Core.
-
-**Pre-Conditions**:
-
- * Network App was registered previously
- * Network App was onboarded previously with {onboardingId} and {public_key_1}
-
-**Execution Steps**:
-
- 1. Register Invoker at CCF
- 2. Onboard Invoker at CCF
- 3. Store signed Certificate
- 4. Update Onboarding Information at CCF with new public key
- 5. Update Onboarding Information at CCF with minor change
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding] with public_key_1.
-
- 2. Create {public_key_2}
-
- 3. Update information of previously onboarded Invoker:
- * Send **PUT** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers/{onboardingId}**
- * Reference Request Body is: [put invoker onboarding body]
- * ["onboardingInformation"]["apiInvokerPublicKey"]: {public_key_2},
- * Store new certificate.
-
- 4. Update information of previously onboarded Invoker Using new certificate:
- * Send **PUT** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers/{onboardingId}**
- * Reference Request Body is: [put invoker onboarding body]
- * "notificationDestination": "*http://host.docker.internal:8086/netapp_new_callback*",
- * Use new **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
- 2. Response to Update Request (PUT) with new public key:
- 1. **200 OK** response.
- 2. apiInvokerCertificate with new certificate on response -> store to use.
- 3. Response to Update Request (PUT) with minor change must contain:
- 1. **200 OK** response.
- 2. notificationDestination on response must contain the new value
-
-
-
-[invoker onboarding body]: ./invoker_details_post_example.json "API Invoker Request"
-[user_getauth_response_body_example]: ../common_operations/user_getauth_response_body_example.json "User GetAuth response Body Example"
-[put register body]: ./invoker_details_put_example.json "API Invoker Update Request"
-[invoker getauth body]: ./invoker_getauth_example.json "Get Auth Example"
-
-[invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"
diff --git a/doc/testing/testplan/api_invoker_management/invoker_details_post_example.json b/doc/testing/testplan/api_invoker_management/invoker_details_post_example.json
deleted file mode 100644
index c306a17e2d04f55da35a5b3638775af9d63e769f..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_invoker_management/invoker_details_post_example.json
+++ /dev/null
@@ -1,15 +0,0 @@
-{
- "notificationDestination": "http://host.docker.internal:8086/netapp_callback",
- "supportedFeatures": "fffffff",
- "apiInvokerInformation": "ROBOT_TESTING_INVOKER",
- "websockNotifConfig": {
- "requestWebsocketUri": true,
- "websocketUri": "websocketUri"
- },
- "onboardingInformation": {
- "apiInvokerPublicKey": "{PUBLIC_KEY}",
- "onboardingSecret": "onboardingSecret",
- "apiInvokerCertificate": "apiInvokerCertificate"
- },
- "requestTestNotification": true
-}
diff --git a/doc/testing/testplan/api_invoker_management/invoker_details_put_example.json b/doc/testing/testplan/api_invoker_management/invoker_details_put_example.json
deleted file mode 100644
index 37a1eefbb05a2df1058b20429477cbf17f412cb8..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_invoker_management/invoker_details_put_example.json
+++ /dev/null
@@ -1,393 +0,0 @@
-{
- "notificationDestination": "http://host.docker.internal:8086/netapp_new_callback",
- "supportedFeatures": "fffffff",
- "apiInvokerInformation": "ROBOT_TESTING_INVOKER",
- "websockNotifConfig": {
- "requestWebsocketUri": true,
- "websocketUri": "websocketUri"
- },
- "onboardingInformation": {
- "apiInvokerPublicKey": "{PUBLIC_KEY}",
- "onboardingSecret": "onboardingSecret",
- "apiInvokerCertificate": "apiInvokerCertificate"
- },
- "requestTestNotification": true,
- "apiList": [
- {
- "serviceAPICategory": "serviceAPICategory",
- "ccfId": "ccfId",
- "apiName": "apiName",
- "shareableInfo": {
- "capifProvDoms": ["capifProvDoms", "capifProvDoms"],
- "isShareable": true
- },
- "supportedFeatures": "fffffff",
- "description": "description",
- "apiSuppFeats": "fffffff",
- "apiId": "apiId",
- "aefProfiles": [
- {
- "securityMethods": ["PSK"],
- "versions": [
- {
- "apiVersion": "apiVersion",
- "resources": [
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "custOperations": [
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "expiry": "2000-01-23T04:56:07.000+00:00"
- },
- {
- "apiVersion": "apiVersion",
- "resources": [
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "custOperations": [
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "expiry": "2000-01-23T04:56:07.000+00:00"
- }
- ],
- "aefId": "aefId",
- "interfaceDescriptions": [
- {
- "securityMethods": ["PSK"],
- "port": 5248,
- "ipv4Addr": "ipv4Addr"
- },
- { "securityMethods": ["PSK"], "port": 5248, "ipv4Addr": "ipv4Addr" }
- ]
- },
- {
- "securityMethods": ["PSK"],
- "versions": [
- {
- "apiVersion": "apiVersion",
- "resources": [
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "custOperations": [
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "expiry": "2000-01-23T04:56:07.000+00:00"
- },
- {
- "apiVersion": "apiVersion",
- "resources": [
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "custOperations": [
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "expiry": "2000-01-23T04:56:07.000+00:00"
- }
- ],
- "aefId": "aefId",
- "interfaceDescriptions": [
- {
- "securityMethods": ["PSK"],
- "port": 5248,
- "ipv4Addr": "ipv4Addr"
- },
- { "securityMethods": ["PSK"], "port": 5248, "ipv4Addr": "ipv4Addr" }
- ]
- }
- ],
- "pubApiPath": { "ccfIds": ["ccfIds", "ccfIds"] }
- },
- {
- "serviceAPICategory": "serviceAPICategory",
- "ccfId": "ccfId",
- "apiName": "apiName2",
- "shareableInfo": {
- "capifProvDoms": ["capifProvDoms", "capifProvDoms"],
- "isShareable": true
- },
- "supportedFeatures": "fffffff",
- "description": "description",
- "apiSuppFeats": "fffffff",
- "apiId": "apiId",
- "aefProfiles": [
- {
- "securityMethods": ["PSK"],
- "versions": [
- {
- "apiVersion": "apiVersion",
- "resources": [
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "custOperations": [
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "expiry": "2000-01-23T04:56:07.000+00:00"
- },
- {
- "apiVersion": "apiVersion",
- "resources": [
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "custOperations": [
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "expiry": "2000-01-23T04:56:07.000+00:00"
- }
- ],
- "aefId": "aefId",
- "interfaceDescriptions": [
- {
- "securityMethods": ["PSK"],
- "port": 5248,
- "ipv4Addr": "ipv4Addr"
- },
- { "securityMethods": ["PSK"], "port": 5248, "ipv4Addr": "ipv4Addr" }
- ]
- },
- {
- "securityMethods": ["PSK"],
- "versions": [
- {
- "apiVersion": "apiVersion",
- "resources": [
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "custOperations": [
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "expiry": "2000-01-23T04:56:07.000+00:00"
- },
- {
- "apiVersion": "apiVersion",
- "resources": [
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "resourceName": "resourceName",
- "custOpName": "custOpName",
- "uri": "uri",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "custOperations": [
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- },
- {
- "operations": ["GET"],
- "description": "description",
- "custOpName": "custOpName",
- "commType": "REQUEST_RESPONSE"
- }
- ],
- "expiry": "2000-01-23T04:56:07.000+00:00"
- }
- ],
- "aefId": "aefId",
- "interfaceDescriptions": [
- {
- "securityMethods": ["PSK"],
- "port": 5248,
- "ipv4Addr": "ipv4Addr"
- },
- { "securityMethods": ["PSK"], "port": 5248, "ipv4Addr": "ipv4Addr" }
- ]
- }
- ],
- "pubApiPath": { "ccfIds": ["ccfIds", "ccfIds"] }
- }
- ]
-}
diff --git a/doc/testing/testplan/api_invoker_management/invoker_getauth_example.json b/doc/testing/testplan/api_invoker_management/invoker_getauth_example.json
deleted file mode 100644
index a66dad58adb1894b70b802193164301a429abdc1..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_invoker_management/invoker_getauth_example.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "username": "ROBOT_TESTING_INVOKER",
- "password": "password"
-}
diff --git a/doc/testing/testplan/api_logging_service/README.md b/doc/testing/testplan/api_logging_service/README.md
deleted file mode 100644
index b2437e9ed8e3d16054fa9c129b4d8993590baef6..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_logging_service/README.md
+++ /dev/null
@@ -1,235 +0,0 @@
-# Test Plan for CAPIF Api Logging Service
-At this documentation you will have all information and related files and examples of test plan for this API.
-
-## Test Case 1: Creates a new individual CAPIF Log Entry.
-
-**Test ID**: ***capif_api_logging-1***
-
-**Description**:
-
- This test case will check that a CAPIF AEF can create log entry to Logging Service
-
-**Pre-Conditions**:
-
- * CAPIF provider is pre-authorised (has valid aefId from CAPIF Authority)
- * Service exist in CAPIF
- * Invoker exist in CAPIF
-
-**Execution Steps**:
- 1. Register Provider and Invoker CCF
- 2. Publish Service
- 3. Create Log Entry
-
-**Information of Test**:
-
- 1. Perform [provider onboarding] and [invoker onboarding]
-
- 2. Publish Service API at CCF:
- - Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- - body [service api description] with apiName **service_1**
- - Use **APF Certificate**
-
- 3. Log Entry:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**
- 2. body [log entry request body]
- 3. Use **AEF Certificate**
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **InvocationLog** data structure with:
- * aefId
- * apiInvokerId
- * logs
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invocation-logs/v1/{aefId}/logs/{logId}**
-
-
-## Test Case 2: Creates a new individual CAPIF Log Entry with Invalid aefId
-
-**Test ID**: ***capif_api_logging-2***
-
-**Description**:
-
- This test case will check that a CAPIF subscriber (AEF) cannot create Log Entry without valid aefId
-
-**Pre-Conditions**:
-
- * CAPIF provider is not pre-authorised (has not valid aefId from CAPIF Authority)
- * Service exist in CAPIF
- * Invoker exist in CAPIF
-
-**Execution Steps**:
- 1. Register Provider and Invoker CCF
- 2. Publish Service
- 3. Create Log Entry
-
-**Information of Test**:
-
- 1. Perform [provider onboarding] and [invoker onboarding]
-
- 2. Publish Service API at CCF:
- - Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- - body [service api description] with apiName **service_1**
- - Use **APF Certificate**
-
- 3. Log Entry:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{not-valid-aefId}/logs**
- 2. body [log entry request body]
- 3. Use **AEF Certificate**
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found"
- * detail with message "Exposer not exist".
- * cause with message "Exposer id not found".
-
-
-## Test Case 3: Creates a new individual CAPIF Log Entry with Invalid serviceAPI
-
-**Test ID**: ***capif_api_logging-3***
-
-**Description**:
-
- This test case will check that a CAPIF subscriber (AEF) cannot create Log Entry without valid aefId
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid aefId from CAPIF Authority)
-
-**Execution Steps**:
- 1. Register Provider and Invoker CCF
- 2. Publish Service
- 3. Create Log Entry
-
-**Information of Test**:
-
- 1. Perform [provider onboarding] and [invoker onboarding]
-
- 2. Publish Service API at CCF:
- - Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- - body [service api description] with apiName **service_1**
- - Use **APF Certificate**
-
- 3. Log Entry:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**
- 2. body [log entry request body with serviceAPI apiName apiId not valid]
- 3. Use **AEF Certificate**
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found"
- * detail with message "Invoker not exist".
- * cause with message "Invoker id not found".
-
-
-## Test Case 4: Creates a new individual CAPIF Log Entry with Invalid apiInvokerId
-
-**Test ID**: ***capif_api_logging-4***
-
-**Description**:
-
- This test case will check that a CAPIF subscriber (AEF) cannot create Log Entry without valid aefId
-
-**Pre-Conditions**:
-
- * CAPIF subscriber is pre-authorised (has valid aefId from CAPIF Authority)
-
-**Execution Steps**:
- 1. Register Provider and Invoker CCF
- 2. Publish Service
- 3. Create Log Entry
-
-**Information of Test**:
-
- 1. Perform [provider onboarding] and [invoker onboarding]
-
- 2. Publish Service API at CCF:
- - Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- - body [service api description] with apiName **service_1**
- - Use **APF Certificate**
-
- 3. Log Entry:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**
- 2. body [log entry request body with invokerId not valid]
- 3. Use **AEF Certificate**
-
-**Expected Result**:
-
- 1. Response to Onboard request must accomplish:
- 1. **201 Created** response.
- 2. body returned must accomplish **APIProviderEnrolmentDetails** data structure.
- 3. For each **apiProvFuncs**, we must check:
- 1. **apiProvFuncId** is set
- 2. **apiProvCert** under **regInfo** is set properly
- 5. Location Header must contain the new resource URL **{apiRoot}/api-provider-management/v1/registrations/{registrationId}**
-
- 2. Response to Logging Service must accomplish:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found"
- * detail with message "Invoker not exist".
- * cause with message "Invoker id not found".
-
- 3. Log Entry are not stored in CAPIF Database
-
-
-## Test Case 5: Creates a new individual CAPIF Log Entry with Invalid aefId in body
-
-**Test ID**: ***capif_api_logging-5***
-
-**Description**:
-
- This test case will check that a CAPIF subscriber (AEF) cannot create Log Entry without valid aefId in body
-
-**Pre-Conditions**:
-
- * CAPIF provider is pre-authorised (has valid apfId from CAPIF Authority)
- * Service exist in CAPIF
- * Invoker exist in CAPIF
-
-**Execution Steps**:
- 1. Register Provider and Invoker CCF
- 2. Publish Service
- 3. Create Log Entry
-
-**Information of Test**:
-
- 1. Perform [provider onboarding] and [invoker onboarding]
-
- 2. Publish Service API at CCF:
- - Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- - body [service api description] with apiName **service_1**
- - Use **APF Certificate**
-
- 3. Log Entry:
- 1. Send **POST** to **https://{CAPIF_HOSTNAME}/api-invocation-logs/v1/{aefId}/logs**
- 2. body [log entry request body with bad aefId]
- 3. Use **AEF Certificate**
-
-**Expected Result**:
-
- 1. Response to Logging Service must accomplish:
- 1. **401 Unauthorized**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 401
- * title with message "Unauthorized"
- * detail with message "AEF id not matching in request and body".
- * cause with message "Not identical AEF id".
-
-
-[log entry request body]: ./invocation_log.json "Log Request Body"
-
-[invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"
-
-[provider onboarding]: ../common_operations/README.md#register-a-provider "Provider Onboarding"
-
diff --git a/doc/testing/testplan/api_logging_service/invocation_log.json b/doc/testing/testplan/api_logging_service/invocation_log.json
deleted file mode 100644
index ceabcf02016e116566cd2b13c99a87a6adcef5d3..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_logging_service/invocation_log.json
+++ /dev/null
@@ -1,45 +0,0 @@
-{
- "aefId": "aefId",
- "apiInvokerId": "apiInvokerId",
- "logs": [
- {
- "apiId": "apiId",
- "apiName": "apiName",
- "apiVersion": "string",
- "resourceName": "string",
- "uri": "string",
- "protocol": "HTTP_1_1",
- "operation": "GET",
- "result": "string",
- "invocationTime": "2023-03-30T10:30:21.404Z",
- "invocationLatency": 0,
- "inputParameters": "string",
- "outputParameters": "string",
- "srcInterface": {
- "ipv4Addr": "string",
- "ipv6Addr": "string",
- "fqdn": "string",
- "port": 65535,
- "apiPrefix": "string",
- "securityMethods": [
- "PSK",
- "Oauth"
- ]
- },
- "destInterface": {
- "ipv4Addr": "string",
- "ipv6Addr": "string",
- "fqdn": "string",
- "port": 65535,
- "apiPrefix": "string",
- "securityMethods": [
- "PSK",
- "string"
- ]
- },
- "fwdInterface": "string"
- }
- ],
- "supportedFeatures": "string"
- }
-
\ No newline at end of file
diff --git a/doc/testing/testplan/api_provider_management/README.md b/doc/testing/testplan/api_provider_management/README.md
deleted file mode 100644
index 839e8be1d8bf26dc98861bb1a01b59baf5bca554..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_provider_management/README.md
+++ /dev/null
@@ -1,408 +0,0 @@
-# Test Plan for CAPIF Api Provider Management
-At this documentation you will have all information and related files and examples of test plan for this API.
-
-## Test Case 1: Register Api Provider
-
-**Test ID**: ***capif_api_provider_management-1***
-
-**Description**:
-
- This test case will check that Api Provider can be registered con CCF
-
-**Pre-Conditions**:
-
- * Provider is pre-authorised (has valid certificate from CAPIF Authority)
-
-**Execution Steps**:
-
- 1. Create private and public key for provider and each function to register.
- 2. Register Provider.
-
-**Information of Test**:
-
- 1. Create public and private key at provider for provider itself and each function (apf, aef and amf)
-
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Register Provider:
-
- * Send **POST** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations**
- * body [provider request body]
- * Authentication Bearer with access_token
- * Store each cert in a file with according name.
-
-**Expected Result**:
-
- 1. Register Provider at Provider Management:
- 1. **201 Created** response.
- 2. body returned must accomplish **APIProviderEnrolmentDetails** data structure.
- 3. For each **apiProvFuncs**, we must check:
- 1. **apiProvFuncId** is set
- 2. **apiProvCert** under **regInfo** is set properly
- 5. Location Header must contain the new resource URL **{apiRoot}/api-provider-management/v1/registrations/{registrationId}**
-
-
-## Test Case 2: Register Api Provider Already registered
-
-**Test ID**: ***capif_api_provider_management-2***
-
-**Description**:
-
- This test case will check that a Api Provider previously registered cannot be re-registered
-
-**Pre-Conditions**:
-
- * Api Provider was registered previously and there is a {registerId} for his Api Provider in the DB
-
-**Execution Steps**:
-
- 1. Create private and public key for provider and each function to register.
- 2. Register Provider.
- 3. Re-Register Provider.
-
-**Information of Test**:
-
- 1. Create public and private key at provider for provider itself and each function (apf, aef and amf)
-
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Register Provider:
-
- * Send **POST** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations**
- * body [provider request body]
- * Authentication Bearer with access_token
- * Store each cert in a file with according name.
-
- 4. Re-Register Provider:
-
- * Same regSec than Previous registration
-
-**Expected Result**:
-
- 1. Re-Register Provider:
- 1. **403 Forbidden** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
-
- * status 403
- * title with message "Forbidden"
- * detail with message "Provider already registered".
- * cause with message "Identical provider reg sec".
-
-
-## Test Case 3: Update Registered Api Provider
-
-**Test ID**: ***capif_api_provider_management-3***
-
-**Description**:
-
- This test case will check that a Registered Api Provider can be updated
-
-**Pre-Conditions**:
-
- * Api Provider was registered previously and there is a {registerId} for his Api Provider in the DB
-
-**Execution Steps**:
-
- 1. Create private and public key for provider and each function to register.
- 2. Register Provider
- 3. Update Provider
-
-**Information of Test**:
-
- 1. Create public and private key at provider for provider itself and each function (apf, aef and amf)
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Register Provider:
-
- * Send **POST** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations**
- * body [provider request body]
- * Authentication Bearer with access_token
- * Get Resource URL from Location
-
- 4. Update Provider:
-
- * Send **PUT** to Resource URL returned at registration **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations/{registrationId}**
- * body [provider request body] with apiProvDomInfo set to ROBOT_TESTING_MOD
- * Use AMF Certificate.
-
-**Expected Result**:
-
- 1. Register Provider:
- 1. **201 Created** response.
- 2. body returned must accomplish **APIProviderEnrolmentDetails** data structure.
- 3. Location Header must contain the new resource URL **{apiRoot}/api-provider-management/v1/registrations/{registrationId}**
-
-
- 2. Update Provider:
- 1. **200 OK** response.
- 2. body returned must accomplish **APIProviderEnrolmentDetails** data structure, with:
- * apiProvDomInfo set to ROBOT_TESTING_MOD
-
-
-## Test Case 4: Update Not Registered Api Provider
-
-**Test ID**: ***capif_api_provider_management-4***
-
-**Description**:
-
- This test case will check that a Non-Registered Api Provider cannot be updated
-
-**Pre-Conditions**:
-
- * Api Provider was not registered previously
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Update Not Registered Provider
-
-**Information of Test**:
-
- 1. Create public and private key at provider for provider itself and each function (apf, aef and amf)
-
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Register Provider:
-
- * Send **POST** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations**
- * body [provider request body]
- * Authentication Bearer with access_token
- * Store each cert in a file with according name.
-
- 4. Update Not Registered Provider:
-
- * Send **PUT** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations/{API_PROVIDER_NOT_REGISTERED}**
- * body [provider request body]
- * Use AMF Certificate.
-
-**Expected Result**:
-
- 1. Update Not Registered Provider:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status 404
- * title with message "Not Found"
- * detail with message "Not Exist Provider Enrolment Details".
- * cause with message "Not found registrations to Send **THIS** api provider details".
-
-
-## Test Case 5: Partially Update Registered Api Provider
-
-**Test ID**: ***capif_api_provider_management-5***
-
-**Description**:
-
- This test case will check that a Registered Api Provider can be partially updated
-
-**Pre-Conditions**:
-
- * Api Provider was registered previously and there is a {registerId} for his Api Provider in the DB
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Register Provider
- 3. Partial update provider
-
-**Information of Test**:
-
- 1. Create public and private key at provider for provider itself and each function (apf, aef and amf)
-
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Register Provider:
-
- * Send **POST** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations**
- * body [provider request body]
- * Authentication Bearer with access_token
- * Store each cert in a file with according name.
-
- 4. Partial update provider:
-
- * Send **PATCH** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations/{registrationId}**
- * body [provider request patch body]
- * Use AMF Certificate.
-
-**Expected Result**:
-
- 1. Partial update provider at Provider Management:
- 1. **200 OK** response.
- 2. body returned must accomplish **APIProviderEnrolmentDetails** data structure, with:
- * apiProvDomInfo with "ROBOT_TESTING_MOD"
-
-
-## Test Case 6: Partially Update Not Registered Api Provider
-
-**Test ID**: ***capif_api_provider_management-6***
-
-**Description**:
-
- This test case will check that a Non-Registered Api Provider cannot be partially updated
-
-**Pre-Conditions**:
-
- * Api Provider was not registered previously
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Register Provider
- 3. Partial update provider
-
-**Information of Test**:
-
- 1. Create public and private key at provider for provider itself and each function (apf, aef and amf)
-
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Register Provider:
-
- * Send **POST** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations**
- * body [provider request body]
- * Authentication Bearer with access_token
- * Store each cert in a file with according name.
-
- 4. Partial update Provider:
-
- * Send **PATCH** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations/{API_API_PROVIDER_NOT_REGISTERED}**
- * body [provider request patch body]
- * Use AMF Certificate.
-
-**Expected Result**:
-
- 1. Partial update provider:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
-
- * status 404
- * title with message "Not Found"
- * detail with message "Not Exist Provider Enrolment Details".
- * cause with message "Not found registrations to Send **THIS** api provider details".
-
-
-## Test Case 7: Delete Registered Api Provider
-
-**Test ID**: ***capif_api_provider_management-7***
-
-**Description**:
-
- This test case will check that a Registered Api Provider can be deleted
-
-**Pre-Conditions**:
-
- * Api Provider was registered previously
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Register Provider
- 3. Delete Provider
-
-**Information of Test**:
-
- 1. Create public and private key at provider for provider itself and each function (apf, aef and amf)
-
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Register Provider:
-
- * Send **POST** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations**
- * body [provider request body]
- * Authentication Bearer with access_token
- * Store each cert in a file with according name.
-
- 4. Delete registered provider:
-
- * Send **DELETE** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations/{registrationId}**
- * Use AMF Certificate.
-
-**Expected Result**:
-
- 1. Delete Provider:
- 1. **204 No Content** response.
-
-
-## Test Case 8: Delete Not Registered Api Provider
-
-**Test ID**: ***capif_api_provider_management-8***
-
-**Description**:
-
- This test case will check that a Non-Registered Api Provider cannot be deleted
-
-**Pre-Conditions**:
-
- * Api Provider was not registered previously
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Delete Provider
-
-**Information of Test**:
-
- 1. Create public and private key at provider for provider itself and each function (apf, aef and amf)
-
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Register Provider:
-
- * Send **POST** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations**
- * body [provider request body]
- * Authentication Bearer with access_token
- * Store each cert in a file with according name.
-
- 4. Delete registered provider at Provider Management:
-
- * Send **DELETE** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations/{API_PROVIDER_NOT_REGISTERED}**
- * Use AMF Certificate.
-
-**Expected Result**:
-
- 1. Delete Provider:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status 404
- * title with message "Not Found"
- * detail with message "Not Exist Provider Enrolment Details".
- * cause with message "Not found registrations to Send **THIS** api provider details".
-
-
-[provider request body]: ./provider_details_post_example.json "API Provider Enrolment Request"
-
-[provider request patch body]: ./provider_details_enrolment_details_patch_example.json "API Provider Enrolment Patch Request"
-
-[user_getauth_response_body_example]: ../common_operations/user_getauth_response_body_example.json "User GetAuth response Body Example"
-
diff --git a/doc/testing/testplan/api_provider_management/provider_details_enrolment_details_patch_example.json b/doc/testing/testplan/api_provider_management/provider_details_enrolment_details_patch_example.json
deleted file mode 100644
index 4dac4f409eccfc7201c4eaf615b55f70c38b54e4..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_provider_management/provider_details_enrolment_details_patch_example.json
+++ /dev/null
@@ -1,29 +0,0 @@
-{
- "regSec": "<public provider key>",
- "apiProvFuncs": [
- {
- "regInfo": {
- "apiProvPubKey": "<public provider apf key>"
- },
- "apiProvFuncRole": "APF",
- "apiProvFuncInfo": "APF_ROBOT_TESTING_PROVIDER"
- },
- {
- "regInfo": {
- "apiProvPubKey": "<public provider aef key>"
- },
- "apiProvFuncRole": "AEF",
- "apiProvFuncInfo": "AEF_ROBOT_TESTING_PROVIDER"
- },
- {
- "regInfo": {
- "apiProvPubKey": "<public provider amf key>"
- },
- "apiProvFuncRole": "AMF",
- "apiProvFuncInfo": "AMF_ROBOT_TESTING_PROVIDER"
- }
- ],
- "apiProvDomInfo": "ROBOT_TESTING",
- "suppFeat": "string",
- "failReason": "string"
-}
\ No newline at end of file
diff --git a/doc/testing/testplan/api_provider_management/provider_details_post_example.json b/doc/testing/testplan/api_provider_management/provider_details_post_example.json
deleted file mode 100644
index 48e91bacf24899e55221babf610598b9d4132b61..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_provider_management/provider_details_post_example.json
+++ /dev/null
@@ -1,17 +0,0 @@
-{
- "regSec": "string",
- "apiProvFuncs": [
- {
- "apiProvFuncId": "string",
- "regInfo": {
- "apiProvPubKey": "string",
- "apiProvCert": "string"
- },
- "apiProvFuncRole": "AEF",
- "apiProvFuncInfo": "string"
- }
- ],
- "apiProvDomInfo": "string",
- "suppFeat": "string",
- "failReason": "string"
-}
\ No newline at end of file
diff --git a/doc/testing/testplan/api_provider_management/provider_getauth_example.json b/doc/testing/testplan/api_provider_management/provider_getauth_example.json
deleted file mode 100644
index 8fc82aeebfc9531651fa746bf10be11c6aa347f3..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_provider_management/provider_getauth_example.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "username": "ROBOT_TESTING_PROVIDER",
- "password": "password"
-}
diff --git a/doc/testing/testplan/api_publish_service/README.md b/doc/testing/testplan/api_publish_service/README.md
deleted file mode 100644
index 928c95e7e0342ccb2b01ca54df318c2d47ae2fc2..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_publish_service/README.md
+++ /dev/null
@@ -1,658 +0,0 @@
-# Test Plan for CAPIF Api Publish Service
-At this documentation you will have all information and related files and examples of test plan for this API.
-
-## Test Case 1: Publish API by Authorised API Publisher
-
-**Test ID**: ***capif_api_publish_service-1***
-
-**Description**:
-
- This test case will check that an API Publisher can Publish an API
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Publish Service API at CCF:
-
- * Send **POST** to **ccf_publish_url**: **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 1. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
-
- 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***
-
-**Description**:
-
- This test case will check that an API Publisher cannot Publish an API withot valid apfId
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Publish Service API with invalid APF ID at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{APF_ID_NOT_VALID}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **401 Unauthorized**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "Publisher not existing".
- * cause with message "Publisher id not found".
-
- 2. Service API is NOT stored in CAPIF Database
-
-
-## Test Case 3: Retrieve all APIs Published by Authorised apfId
-
-**Test ID**: ***capif_api_publish_service-3***
-
-**Description**:
-
- This test case will check that an API Publisher can Retrieve all API published
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Publish Service API at CCF:
- * Send **POST** to **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Get apiId
- * Use **APF Certificate**
-
- 3. Publish Other Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_2**
- * Get apiId
- * Use **APF Certificate**
-
- 4. Retrieve all published APIs:
- * Send **GET** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to service 1 Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId1}**
-
- 2. Response to service 2 Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId2}**
-
- 3. Published Service APIs are stored in CAPIF Database
-
- 4. Response to Retrieve all published APIs:
- 1. **200 OK**
- 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***
-
-**Description**:
-
- This test case will check that an API Publisher cannot Retrieve API published when apfId is not authorised
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Retrieve all published APIs:
- * Send **GET** to **https://{CAPIF_HOSTNAME}/published-apis/v1/{APF_ID_NOT_VALID}/service-apis**
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **401 Non Authorized**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "Provider not existing".
- * cause with message "Provider id not found".
-
- 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***
-
-**Description**:
-
- This test case will check that an API Publisher can Retrieve API published one by one
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Get apiId
- * Use **APF Certificate**
-
- 3. Publish Other Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_2**
- * Get apiId
- * Use **APF Certificate**
-
- 4. Retrieve **service_1** published APIs detail:
- * Send **GET** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{apiId1}**
- * Use **APF Certificate**
-
- 5. Retrieve **service_2** published APIs detail:
- * Send **GET** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{apiId2}**
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to service 1 Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId1}**
-
- 2. Response to service 2 Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId2}**
-
- 3. Published Service APIs are stored in CAPIF Database
-
- 4. Response to Retrieve **service_1** published API using apiId1:
- 1. **200 OK**
- 2. Response body must return a **ServiceAPIDescription** data.
- 3. Array must contain same information than **service_1** published registration response.
-
- 5. Response to Retrieve **service_2** published API using apiId2:
- 1. **200 OK**
- 2. Response body must return a **ServiceAPIDescription** data.
- 3. Array must contain same information than **service_2** published registration response.
-
-
-## Test Case 6: Retrieve single APIs non Published by Authorised apfId
-
-**Test ID**: ***capif_api_publish_service-6***
-
-**Description**:
-
- This test case will check that an API Publisher try to get detail of not published api.
-
-**Pre-Conditions**:
-
- * 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]
- 2. Retrieve not published APIs detail:
- * Send **GET** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{SERVICE_API_ID_NOT_VALID}**
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to Retrieve for NOT published API must accomplish:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status **404**
- * title with message "Not Found"
- * detail with message "Service API not found".
- * cause with message "No Service with specific credentials exists".
-
-
-## Test Case 7: Retrieve single APIs Published by NON Authorised apfId
-
-**Test ID**: ***capif_api_publish_service-7***
-
-**Description**:
-
- This test case will check that an API Publisher cannot Retrieve detailed API published when apfId is not authorised
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Get apiId
- * Use **APF Certificate**
-
- 3. Retrieve detailed published APIs:
- * Send **GET** to **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/${apiId}**
- * Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Retrieve Detailed published API acting as Invoker must accomplish:
- 1. **401 Unauthorized**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "User not authorized".
- * cause with message "Certificate not authorized".
-
- 2. Service API is NOT stored in CAPIF Database
-
-
-## Test Case 8: Update API Published by Authorised apfId with valid serviceApiId
-
-**Test ID**: ***capif_api_publish_service-8***
-
-**Description**:
-
- This test case will check that an API Publisher can Update published API with a valid serviceApiId
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Get apiId
- * get resource url from location Header.
- * Use **APF Certificate**
-
- 3. Update published API at CCF:
- * Send **PUT** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{serivceApiId}**
- * body [service api description] with overrided apiName to **service_1**_modified
- * Use **APF Certificate**
-
- 4. Retrieve detail of service API:
- * Send **GET** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{serivceApiId}**
- * check apiName is **service_1**_modified
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
-
- 2. Response to Update Published Service API:
- 1. **200 OK**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiName **service_1**_modified
-
- 3. Response to Retrieve detail of Service API:
- 1. **200 OK**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiName **service_1**_modified.
-
-
-## Test Case 9: Update APIs Published by Authorised apfId with invalid serviceApiId
-
-**Test ID**: ***capif_api_publish_service-9***
-
-**Description**:
-
- This test case will check that an API Publisher cannot Update published API with a invalid serviceApiId
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Get apiId
- * Use **APF Certificate**
-
- 3. Update published API at CCF:
- * Send **PUT** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{SERVICE_API_ID_NOT_VALID}**
- * body [service api description] with overrided apiName to ***service_1**_modified***
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
-
- 2. Response to Update Published Service API:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status **404**
- * title with message "Not Found"
- * detail with message "Service API not found".
- * cause with message "Service API id not found".
-
-## Test Case 10: Update APIs Published by NON Authorised apfId
-
-**Test ID**: ***capif_api_publish_service-10***
-
-**Description**:
-
- This test case will check that an API Publisher cannot Update API published when apfId is not authorised
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Get apiId
- * Use **APF Certificate**
-
- 3. Update published API at CCF:
- * Send **PUT** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
- * body [service api description] with overrided apiName to ***service_1**_modified***
- * Use **Invoker Certificate**
-
- 4. Retrieve detail of service API:
- * Send **GET** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{serivceApiId}**
- * check apiName is **service_1**
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to Update published API acting as Invoker must accomplish:
- 1. **401 Unauthorized**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "User not authorized".
- * cause with message "Certificate not authorized".
-
- 2. Response to Retrieve Detail of Service API:
- 1. **200 OK**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiName **service_1**.
-
-
-## Test Case 11: Delete API Published by Authorised apfId with valid serviceApiId
-
-**Test ID**: ***capif_api_publish_service-11***
-
-**Description**:
-
- This test case will check that an API Publisher can Delete published API with a valid serviceApiId
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Get apiId
- * Use **APF Certificate**
-
- 3. Remove published Service API at CCF:
- * Send **DELETE** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
- * Use **APF Certificate**
- 4. Retrieve detail of service API:
- * Send **GET** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{serivceApiId}**
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to Publish request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **ServiceAPIDescription** data structure with:
- * apiId
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/published-apis/v1/{apfId}/service-apis/{serviceApiId}**
-
- 2. Published Service API is stored in CAPIF Database
-
- 3. Response to Remove published Service API at CCF:
- 1. **204 No Content**
-
- 4. Response to Retrieve for DELETED published API must accomplish:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found"
- * detail with message "Service API not found".
- * cause with message "No Service with specific credentials exists".
-
-
-## Test Case 12: Delete APIs Published by Authorised apfId with invalid serviceApiId
-
-**Test ID**: ***capif_api_publish_service-12***
-
-**Description**:
-
- This test case will check that an API Publisher cannot Delete with invalid serviceApiId
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Remove published Service API at CCF with invalid serviceId:
- * Send **DELETE** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{SERVICE_API_ID_NOT_VALID}**
- * Use **APF Certificate**
-
-**Expected Result**:
-
- 1. Response to Remove published Service API at CCF:
- 1. **404 Not Found**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status 404
- * title with message "Not Found"
- * detail with message "Service API not found".
- * cause with message "Service API id not found".
-
-
-## Test Case 13: Delete APIs Published by NON Authorised apfId
-
-**Test ID**: ***capif_api_publish_service-12***
-
-**Description**:
-
- This test case will check that an API Publisher cannot Delete API published when apfId is not authorised
-
-**Pre-Conditions**:
-
- * 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]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Get apiId
- * Use **APF Certificate**
-
- 3. Remove published Service API at CCF with invalid serviceId as Invoker:
- * Send **DELETE** to resource URL **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis/{SERVICE_API_ID_NOT_VALID}**
- * Use **Invoker Certificate**.
-
-**Expected Result**:
-
- 1. Response to Remove published Service API at CCF:
- 1. **401 Unauthorized**
- 2. Error Response Body must accomplish with **ProblemDetails** data structure with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "User not authorized".
- * cause with message "Certificate not authorized".
-
-
- [service api description]: ./service_api_description_post_example.json "Service API Description Request"
- [publisher register body]: ./publisher_register_body.json "Publish register Body"
- [invoker onboarding body]: ../api_invoker_management/invoker_details_post_example.json "API Invoker Request"
- [provider request body]: ../api_provider_management/provider_details_post_example.json "API Provider Enrolment Request"
- [provider request patch body]: ../api_provider_management/provider_details_enrolment_details_patch_example.json "API Provider Enrolment Patch Request"
-
- [invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"
- [provider registration]: ../common_operations/README.md#register-a-provider "Provider Registration"
-
diff --git a/doc/testing/testplan/api_publish_service/publisher_register_body.json b/doc/testing/testplan/api_publish_service/publisher_register_body.json
deleted file mode 100644
index fc26db2141eab904b1f2f8d96e963f2ec0efcbe1..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_publish_service/publisher_register_body.json
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "password": "password",
- "username": "ROBOT_TESTING_PUBLISHER",
- "role": "provider",
- "description": "Testing",
- "cn": "ROBOT_TESTING_PUBLISHER"
-}
diff --git a/doc/testing/testplan/api_publish_service/service_api_description_post_example.json b/doc/testing/testplan/api_publish_service/service_api_description_post_example.json
deleted file mode 100644
index b725b428629509bf39a79c030f1bf93f4b6f18f6..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_publish_service/service_api_description_post_example.json
+++ /dev/null
@@ -1,113 +0,0 @@
-{
- "apiName": "service_1",
- "aefProfiles": [
- {
- "aefId": "string",
- "versions": [
- {
- "apiVersion": "v1",
- "expiry": "2021-11-30T10:32:02.004Z",
- "resources": [
- {
- "resourceName": "string",
- "commType": "REQUEST_RESPONSE",
- "uri": "string",
- "custOpName": "string",
- "operations": [
- "GET"
- ],
- "description": "string"
- }
- ],
- "custOperations": [
- {
- "commType": "REQUEST_RESPONSE",
- "custOpName": "string",
- "operations": [
- "GET"
- ],
- "description": "string"
- }
- ]
- }
- ],
- "protocol": "HTTP_1_1",
- "dataFormat": "JSON",
- "securityMethods": ["PSK"],
- "interfaceDescriptions": [
- {
- "ipv4Addr": "string",
- "port": 65535,
- "securityMethods": ["PSK"]
- },
- {
- "ipv4Addr": "string",
- "port": 65535,
- "securityMethods": ["PSK"]
- }
- ]
- },
- {
- "aefId": "string",
- "versions": [
- {
- "apiVersion": "v1",
- "expiry": "2021-11-30T10:32:02.004Z",
- "resources": [
- {
- "resourceName": "string",
- "commType": "REQUEST_RESPONSE",
- "uri": "string",
- "custOpName": "string",
- "operations": [
- "GET"
- ],
- "description": "string"
- }
- ],
- "custOperations": [
- {
- "commType": "REQUEST_RESPONSE",
- "custOpName": "string",
- "operations": [
- "GET"
- ],
- "description": "string"
- }
- ]
- }
- ],
- "protocol": "HTTP_1_1",
- "dataFormat": "JSON",
- "securityMethods": ["PSK"],
- "interfaceDescriptions": [
- {
- "ipv4Addr": "string",
- "port": 65535,
- "securityMethods": ["PSK"]
- },
- {
- "ipv4Addr": "string",
- "port": 65535,
- "securityMethods": ["PSK"]
- }
- ]
- }
- ],
- "description": "string",
- "supportedFeatures": "fffff",
- "shareableInfo": {
- "isShareable": true,
- "capifProvDoms": [
- "string"
- ]
- },
- "serviceAPICategory": "string",
- "apiSuppFeats": "fffff",
- "pubApiPath": {
- "ccfIds": [
- "string"
- ]
- },
- "ccfId": "string"
-}
\ No newline at end of file
diff --git a/doc/testing/testplan/api_security_service/README.md b/doc/testing/testplan/api_security_service/README.md
deleted file mode 100644
index 7b871ccea5303a8cb253c429648ef9996f44f2c1..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_security_service/README.md
+++ /dev/null
@@ -1,1287 +0,0 @@
-# Test Plan for CAPIF Api Security Service
-At this documentation you will have all information and related files and examples of test plan for this API.
-
-## Test Case 1: Create a security context for an API invoker
-
-**Test ID**: ***capif_security_api-1***
-
-**Description**:
-
- This test case will check that an API Invoker can create a Security context
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority)
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Store signed Certificate
- 3. Create Security Context
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
- 2. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Create security context:
- 1. **201 Created** response.
- 2. body returned must accomplish **ServiceSecurity** data structure.
- 3. Location Header must contain the new resource URL **{apiRoot}/capif-security/v1/trustedInvokers/{apiInvokerId}**
-
-
-## Test Case 2: Create a security context for an API invoker with Provider role
-
-**Test ID**:: ***capif_security_api-2***
-
-**Description**:
-
- This test case will check that an Provider cannot create a Security context with valid apiInvokerId.
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID), but user that create Security Context with Provider role
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Register Provider at CCF
- 3. Create Security Context using Provider certificate
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Create Security Context for this Invoker but using Provider certificate.
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **AEF Certificate**
-
-**Expected Result**:
-
- 1. Create security context using Provider certificate:
- 1. **401 Unauthorized** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "User role must be invoker".
-
- 2. No context stored at DB
-
-
-## Test Case 3: Create a security context for an API invoker with Provider entity role and invalid apiInvokerId
-
-**Test ID**:: ***capif_security_api-3***
-
-**Description**:
-
- This test case will check that an Provider cannot create a Security context with invalid apiInvokerID.
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID), but user that create Security Context with Provider role
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Create Security Context using Provider certificate
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Create Security Context for this not valid apiInvokerId and using Provider certificate.
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}**
- * body [service security body]
- * Using **AEF Certificate**
-
-**Expected Result**:
-
- 1. Create security context using Provider certificate:
- 1. **401 Unauthorized** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "User role must be invoker".
- 2. No context stored at DB
-
-
-## Test Case 4: Create a security context for an API invoker with Invoker entity role and invalid apiInvokerId
-
-**Test ID**:: ***capif_security_api-4***
-
-**Description**:
-
- This test case will check that an Invoker cannot create a Security context with valid apiInvokerId.
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID), but user that create Security Context with invalid apiInvokerId
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Create Security Context using Provider certificate
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Create Security Context for this Invoker:
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}**
- * body [service security body]
- * Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Create security context using Provider certificate:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **404**
- * title with message "Not Found"
- * detail with message "Invoker not found".
- * cause with message "API Invoker not exists or invalid ID".
-
- 2. No context stored at DB
-
-
-## Test Case 5: Retrieve the Security Context of an API Invoker
-
-**Test ID**:: ***capif_security_api-5***
-
-**Description**:
-
- This test case will check that an provider can retrieve the Security context of an API Invoker
-
-**Pre-Conditions**:
-
- * Provider is pre-authorised (has valid apfId from CAPIF Authority) and API Invoker has created a valid Security Context
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Register Provider at CCF
- 3. Create Security Context using Provider certificate
- 4. Retrieve Security Context by Provider
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Create Security Context for this Invoker.
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**
-
- 3. Retrieve Security Context of Invoker by Provider:
- * Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * Using **AEF Certificate**
-
-**Expected Result**:
-
- 1. Retrieve security context:
- 1. **200 OK** response.
- 2. body returned must accomplish **ServiceSecurity** data structure.
-
-
-## Test Case 6: Retrieve the Security Context of an API Invoker with invalid apiInvokerID
-
-**Test ID**:: ***capif_security_api-6***
-
-**Description**:
-
- This test case will check that an provider can retrieve the Security context of an API Invoker
-
-**Pre-Conditions**:
-
- * Provider is pre-authorised (has valid apfId from CAPIF Authority) and API Invoker has created a valid Security Context
-
-**Execution Steps**:
-
- 2. Register Provider at CCF
- 3. Create Security Context using Provider certificate
- 4. Retrieve Security Context by Provider of invalid invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Retrieve Security Context of invalid Invoker by Provider:
- * Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}**
- * Using **AEF Certificate**.
-
-**Expected Result**:
-
- 1. Retrieve security context:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **404**
- * title with message "Not Found"
- * detail with message "Invoker not found".
- * cause with message "API Invoker not exists or invalid ID".
-
-
-## Test Case 7: Retrieve the Security Context of an API Invoker with invalid apfId
-
-**Test ID**:: ***capif_security_api-7***
-
-**Description**:
-
- This test case will check that an Provider cannot retrieve the Security context of an API Invoker without valid apfId
-
-**Pre-Conditions**:
-
- * API Exposure Function is not pre-authorised (has invalid apfId)
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Store signed Certificate
- 3. Create Security Context
- 4. Retrieve Security Context as Provider.
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**
-
- 3. Retrieve Security Context as Invoker role:
- * Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * Using **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Create security context:
- 1. **401 Unauthorized** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "User role must be aef".
-
-
-## Test Case 8: Delete the Security Context of an API Invoker
-
-**Test ID**:: ***capif_security_api-8***
-
-**Description**:
-
- This test case will check that an Provider can delete a Security context
-
-**Pre-Conditions**:
-
- * Provider is pre-authorised (has valid apfId from CAPIF Authority) and API Invoker has created a valid Security Context
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Register Provider at CCF
- 3. Create Security Context using Provider certificate
- 4. Delete Security Context by Provider
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Create Security Context for this Invoker but using Provider certificate.
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **AEF Certificate**
-
- 3. Delete Security Context of Invoker by Provider:
- * Send **DELETE** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * Use **AEF Certificate**
-
- 4. Retrieve Security Context of Invoker by Provider:
- * Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * Using **AEF Certificate**
-
-**Expected Result**:
-
- 1. Delete security context:
- 1. **204 No Content** response.
-
- 2. Retrieve security context:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **404**
- * title with message "Not Found"
- * detail with message "Security context not found".
- * cause with message "API Invoker not exists or invalid ID".
-
-
-## Test Case 9: Delete the Security Context of an API Invoker with Invoker entity role
-
-**Test ID**:: ***capif_security_api-9***
-
-**Description**:
-
- This test case will check that an Invoker cannot delete a Security context
-
-**Pre-Conditions**:
-
- * Provider is pre-authorised (has valid apfId from CAPIF Authority) and API Invoker has created a valid Security Context
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Create Security Context using Provider certificate
- 3. Delete Security Context by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Create Security Context for this Invoker:
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**
-
- 3. Delete Security Context of Invoker:
- * Send **DELETE** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Delete security context:
- 1. **401 Unauthorized** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "User role must be aef".
-
-
-## Test Case 10: Delete the Security Context of an API Invoker with Invoker entity role and invalid apiInvokerID
-
-**Test ID**:: ***capif_security_api-10***
-
-**Description**:
-
- This test case will check that an Invoker cannot delete a Security context with invalid
-
-**Pre-Conditions**:
-
- * Invoker is pre-authorised.
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Delete Security Context by invoker
-
-**Information of Test**:
-
- 1. Perform [Invoker Onboarding]
-
- 2. Delete Security Context of Invoker:
- * Send **DELETE** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}**
- * Use **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Delete security context:
- 1. **401 Unauthorized** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "User role must be aef".
-
-
-## Test Case 11: Delete the Security Context of an API Invoker with invalid apiInvokerID
-
-**Test ID**:: ***capif_security_api-11***
-
-**Description**:
-
- This test case will check that an Provider cannot delete a Security context of invalid apiInvokerId
-
-**Pre-Conditions**:
-
- * Provider is pre-authorised (has valid apfId from CAPIF Authority).
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Delete Security Context by provider
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Delete Security Context of Invoker by Provider:
- * Send **DELETE** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}**
- * Use **AEF Certificate**
-
-**Expected Result**:
-
- 1. Retrieve security context:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **404**
- * title with message "Not Found"
- * detail with message "Invoker not found".
- * cause with message "API Invoker not exists or invalid ID".
-
-
-## Test Case 12: Update the Security Context of an API Invoker
-
-**Test ID**:: ***capif_security_api-12***
-
-**Description**:
-
- This test case will check that an API Invoker can update a Security context
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Register Provider at CCF
- 3. Create Security Context By Invoker
- 4. Update Security Context By Invoker
- 5. Retrieve Security Context By Provider
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Create Security Context for this Invoker:
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
-
- 3. Update Security Context of Invoker:
- * Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}/update**
- * body [service security body] but with notification destination modified to **http://robot.testing2**
- * Using **Invoker Certificate**.
-
- 4. Retrieve Security Context of Invoker by Provider:
- * Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * Using **AEF Certificate**.
-
-**Expected Result**:
-
- 1. Update security context:
- 1. **200 OK** response.
- 2. body returned must accomplish **ServiceSecurity** data structure.
-
- 2. Retrieve security context:
- 1. **200 OK** response.
- 2. body returned must accomplish **ServiceSecurity** data structure.
- 1. Check is this returned object match with modified one.
-
-
-## Test Case 13: Update the Security Context of an API Invoker with Provider entity role
-
-**Test ID**:: ***capif_security_api-13***
-
-**Description**:
-
- This test case will check that an Provider cannot update a Security context
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized.
- * Invoker has created the Security Context previously.
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Register Provider at CCF
- 3. Create Security Context
- 4. Update Security Context as Provider
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Create Security Context for this Invoker:
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
-
- 3. Update Security Context of Invoker by Provider:
- * Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}/update**
- * body [service security body] but with notification destination modified to **http://robot.testing2**
- * Using **AEF Certificate**
-
-**Expected Result**:
-
- 1. Update security context:
- 1. **401 Unauthorized** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "User role must be invoker".
-
-
-## Test Case 14: Update the Security Context of an API Invoker with AEF entity role and invalid apiInvokerId
-
-**Test ID**:: ***capif_security_api-14***
-
-**Description**:
-
- This test case will check that an Provider cannot update a Security context of invalid apiInvokerId
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized.
- * Invoker has created the Security Context previously.
-
-**Execution Steps**:
-
- 1. Register Provider at CCF
- 2. Update Security Context as Provider
-
-**Information of Test**:
-
- 1. Perform [Provider Registration]
-
- 2. Update Security Context of Invoker by Provider:
- * Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}/update**
- * body [service security body]
- * Using **AEF Certificate**
-
-**Expected Result**:
-
- 1. Update security context:
- 1. **401 Unauthorized** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "User role must be invoker".
-
-
-## Test Case 15: Update the Security Context of an API Invoker with invalid apiInvokerID
-
-**Test ID**:: ***capif_security_api-15***
-
-**Description**:
-
- This test case will check that an API Invoker cannot update a Security context not valid apiInvokerId
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority)
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Update Security Context
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Update Security Context of Invoker:
- * Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}/update**
- * body [service security body]
- * Using **Invoker Certificate**.
-
-**Expected Result**:
-
-1. Retrieve security context:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **404**
- * title with message "Not Found"
- * detail with message "Invoker not found".
- * cause with message "API Invoker not exists or invalid ID".
-
-
-## Test Case 16: Revoke the authorization of the API invoker for APIs.
-
-**Test ID**:: ***capif_security_api-16***
-
-**Description**:
-
- This test case will check that a Provider can revoke the authorization for APIs
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Register Provider at CCF
- 3. Create Security Context by Invoker
- 4. Revoke Security Context by Provider
- 5. Retrieve Security Context by Provider
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Create Security Context By Invoker:
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**
-
- 3. Revoke Authorization by Provider:
- * Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}/delete**
- * body [security notification body]
- * Using **AEF Certificate**.
-
- 4. Retrieve Security Context by Provider:
- * Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * Using **AEF Certificate**.
-
-**Expected Result**:
-
- 1. Revoke Authorization:
- 1. **204 No Content** response.
-
- 2. Retrieve security context:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **404**
- * title with message "Not Found"
- * detail with message "Security context not found".
- * cause with message "API Invoker has no security context".
-
-
-## Test Case 17: Revoke the authorization of the API invoker for APIs without valid apfID.
-
-**Test ID**:: ***capif_security_api-17***
-
-**Description**:
-
- This test case will check that an Invoker can't revoke the authorization for APIs
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Register Provider at CCF
- 3. Create Security Context
- 4. Revoke Security Context by invoker
- 5. Retrieve Security Context
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Create Security Context for this Invoker:
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
-
- 3. Revoke Authorization by invoker:
- * Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}/delete**
- * body [security notification body]
- * Using **Invoker Certificate**
-
- 4. Retrieve Security Context of Invoker by Provider:
- * Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * Using Provider Certificate
-
-**Expected Result**:
-
- 1. Revoke Security Context by invoker:
- 1. **401 Unauthorized** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **401**
- * title with message "Unauthorized"
- * detail with message "Role not authorized for this API route".
- * cause with message "User role must be provider".
-
- 3. Retrieve security context:
- 1. **200 OK** response.
- 2. body returned must accomplish **ServiceSecurity** data structure.
- 1. Check is this returned object match with created one.
-
-
-## Test Case 18: Revoke the authorization of the API invoker for APIs with invalid apiInvokerId.
-
-**Test ID**:: ***capif_security_api-18***
-
-**Description**:
-
- This test case will check that an API Exposure Function cannot revoke the authorization for APIs for invalid apiInvokerId
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register and onboard Invoker at CCF
- 2. Register Provider at CCF
- 3. Create Security Context
- 4. Revoke Security Context by Provider
- 5. Retrieve Security Context
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Create Security Context for this Invoker:
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
-
- 3. Revoke Authorization by Provider:
- * Send **POST** **https://{CAPIF_HOSTNAME}/trustedInvokers/{API_INVOKER_NOT_VALID}/delete**
- * body [security notification body]
- * Using **AEF Certificate**.
-
- 4. Retrieve Security Context of Invoker by Provider:
- * Send **GET** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}?authenticationInfo=true&authorizationInfo=true**
- * This request will ask with parameter to retrieve authenticationInfo and authorizationInfo
- * Using **AEF Certificate**.
-
-**Expected Result**:
-
- 1. Revoke Security Context by invoker:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails** data structure, with:
- * status **404**
- * title with message "Not Found"
- * detail with message "Invoker not found".
- * cause with message "API Invoker not exists or invalid ID".
-
- 3. Retrieve security context:
- 1. **200 OK** response.
- 2. body returned must accomplish **ServiceSecurity** data structure.
- 1. Check is this return one object that match with created one.
-
-
-## Test Case 19: Retrieve access token
-
-**Test ID**:: ***capif_security_api-19***
-
-**Description**:
-
- This test case will check that an API Invoker can retrieve a security access token OAuth 2.0.
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerId)
- * Service API of Provider is published
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
- 2. Register and onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Create Security Context According to Service APIs discovered.
- 5. Request Access Token
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
-
- 3. Request Discover Published APIs not filtered:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
-
- 4. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
- * Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
-
- 5. Request Access Token by invoker:
- * Sent POST **https://{CAPIF_HOSTNAME}/securities/{securityId}/token**:
- * body [access token req body] and example [example]
- * ***securityId*** is apiInvokerId.
- * ***grant_type=client_credentials***.
- * Create Scope properly for request: ***3gpp#{aef_id}:{api_name}***
- * Using **Invoker Certificate**.
-
-**Expected Result**:
-
- 1. Response to Request of Access Token:
- 1. **200 OK**
- 2. body must follow **AccessTokenRsp** with:
- 1. access_token present
- 2. token_type=Bearer
-
-## Test Case 20: Retrieve access token by Provider
-
-**Test ID**:: ***capif_security_api-20***
-
-**Description**:
-
- This test case will check that an API Exposure Function cannot revoke the authorization for APIs for invalid apiInvokerId
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerID from CAPIF Authority) and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
- 2. Register and onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Create Security Context According to Service APIs discovered.
- 5. Request Access Token by Provider
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
-
- 3. Request Discover Published APIs not filtered:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
-
- 4. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
- * Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
-
- 5. Request Access Token by provider:
- * Sent POST **https://{CAPIF_HOSTNAME}/securities/{securityId}/token**:
- * body [access token req body]
- * ***securityId*** is apiInvokerId
- * ***grant_type=client_credentials***
- * Using **AEF Certificate**
-
-**Expected Result**:
-
- 1. Response to Request of Access Token:
- 1. **401 Unauthorized** response.
- 2. body returned must accomplish **AccessTokenErr** data structure, with:
- * error unauthorized_client
- * error_description=Role not authorized for this API route
-
-
-## Test Case 21: Retrieve access token by Provider with invalid apiInvokerId
-
-**Test ID**:: ***capif_security_api-21***
-
-**Description**:
-
- This test case will check that an API Exposure Function cannot retrieve a security access token without valid apiInvokerId
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
- 2. Register and onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Create Security Context According to Service APIs discovered.
- 5. Request Access Token by Provider
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
-
- 3. Request Discover Published APIs not filtered:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
-
- 4. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
- * Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
-
- 5. Request Access Token by provider:
- * Sent POST **https://{CAPIF_HOSTNAME}/securities/{API_INVOKER_NOT_VALID}/token**.
- * body [access token req body]
- * ***securityId*** is apiInvokerId
- * ***grant_type=client_credentials***
- * Using **AEF Certificate**
-
-**Expected Result**:
-
- 1. Response to Request of Access Token:
- 1. **401 Unauthorized** response.
- 2. body returned must accomplish **AccessTokenErr** data structure, with:
- * error unauthorized_client
- * error_description=Role not authorized for this API route
-
-
-## Test Case 22: Retrieve access token with invalid apiInvokerId
-
-**Test ID**:: ***capif_security_api-22***
-
-**Description**:
-
- This test case will check that an API Invoker can't retrieve a security access token without valid apiInvokerId
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised (has valid apiInvokerId)
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
- 2. Register and onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Create Security Context According to Service APIs discovered.
- 5. Request Access Token by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
- 3. Request Discover Published APIs not filtered:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
- 4. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
- * Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
- 5. Request Access Token by invoker:
- * Sent POST **https://{CAPIF_HOSTNAME}/securities/{API_INVOKER_NOT_VALID}/token**.
- * body [access token req body]
- * ***securityId*** is apiInvokerId
- * ***grant_type=client_credentials***
- * Using **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Request of Access Token:
- 1. **404 Not Found** response.
- 2. body returned must accomplish **ProblemDetails29571** data structure, with:
- * status 404
- * title Not Found
- * detail Security context not found
- * cause API Invoker has no security context
-
-
-**NOTE: ProblemDetails29571 is the definition present for this request at swagger of ProblemDetails, and this is different from definition of ProblemDetails across other CAPIF Services**
-
-
-## Test Case 23: Retrieve access token with invalid client_id
-
-**Test ID**:: ***capif_security_api-23***
-
-**Description**:
-
- This test case will check that an API Exposure Function cannot retrieve a security access token without valid client_id at body
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
- 2. Register and onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Create Security Context According to Service APIs discovered.
- 5. Request Access Token by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
-
- 3. Request Discover Published APIs not filtered:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
-
- 4. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
- * Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
-
- 5. Request Access Token by invoker:
- * Sent POST **https://{CAPIF_HOSTNAME}/securities/{securityId}/token**.
- * body [access token req body]
- * ***securityId*** is apiInvokerId
- * ***grant_type=client_credentials***
- * **client_id is not-valid**
- * Using **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Request of Access Token:
- 1. **400 Bad Request** response.
- 2. body returned must accomplish **AccessTokenErr** data structure, with:
- * error invalid_client
- * error_description=Client Id not found
-
-
-## Test Case 24: Retrieve access token with unsupported grant_type
-
-**Test ID**:: ***capif_security_api-24***
-
-**Description**:
-
- This test case will check that an API Exposure Function cannot retrieve a security access token with unsupported grant_type
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
- 2. Register and onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Create Security Context According to Service APIs discovered.
- 5. Request Access Token by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
-
- 3. Request Discover Published APIs not filtered:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
-
- 4. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
- * Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
-
- 5. Request Access Token by invoker:
- * Sent POST **https://{CAPIF_HOSTNAME}/securities/{securityId}/token**.
- * body [access token req body]
- * ***securityId*** is apiInvokerId
- * ***grant_type=not_valid***
- * Using **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Request of Access Token:
- 1. **400 Bad Request** response.
- 2. body returned must accomplish **AccessTokenErr** data structure, with:
- * error unsupported_grant_type
- * error_description=Invalid value for `grant_type` \\(${grant_type}\\), must be one of \\['client_credentials'\\] - 'grant_type'
-
-## Test Case 25: Retrieve access token with invalid scope
-
-**Test ID**:: ***capif_security_api-25***
-
-**Description**:
-
- This test case will check that an API Exposure Function cannot retrieve a security access token with complete invalid scope
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
- 2. Register and onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Create Security Context According to Service APIs discovered.
- 5. Request Access Token by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
-
- 3. Request Discover Published APIs not filtered:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
-
- 4. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
- * Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
-
- 5. Request Access Token by invoker:
- * Sent POST **https://{CAPIF_HOSTNAME}/securities/{securityId}/token**.
- * body [access token req body]
- * ***securityId*** is apiInvokerId
- * ***grant_type=client_credentials***
- * ***scope=not-valid-scope***
- * Using **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Request of Access Token:
- 1. **400 Bad Request** response.
- 2. body returned must accomplish **AccessTokenErr** data structure, with:
- * error invalid_scope
- * error_description=The first characters must be '3gpp'
-
-
-## Test Case 26: Retrieve access token with invalid aefid at scope
-
-**Test ID**:: ***capif_security_api-26***
-
-**Description**:
-
- This test case will check that an API Exposure Function cannot retrieve a security access token with invalid aefId at scope
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
- 2. Register and onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Create Security Context According to Service APIs discovered.
- 5. Request Access Token by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
-
- 3. Request Discover Published APIs not filtered:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
-
- 4. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
- * Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
-
- 5. Request Access Token by invoker:
- * Sent POST **https://{CAPIF_HOSTNAME}/securities/{securityId}/token**.
- * body [access token req body]
- * ***securityId*** is apiInvokerId
- * ***grant_type=client_credentials***
- * ***scope=3gpp#1234:**service_1***
- * Using **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Request of Access Token:
- 1. **400 Bad Request** response.
- 2. body returned must accomplish **AccessTokenErr** data structure, with:
- * error invalid_scope
- * error_description=One of aef_id not belongs of your security context
-
-
-## Test Case 27: Retrieve access token with invalid apiName at scope
-
-**Test ID**:: ***capif_security_api-27***
-
-**Description**:
-
- This test case will check that an API Exposure Function cannot retrieve a security access token with invalid apiName at scope
-
-**Pre-Conditions**:
-
- * API Invoker is pre-authorised and Provider is also authorized
-
-**Execution Steps**:
-
- 1. Register Provider at CCF, store certificates and Publish Service API **service_1** at CCF
- 2. Register and onboard Invoker at CCF
- 3. Discover Service APIs by Invoker.
- 4. Create Security Context According to Service APIs discovered.
- 5. Request Access Token by Invoker
-
-**Information of Test**:
-
- 1. Perform [Provider Registration] and [Invoker Onboarding]
-
- 2. Publish Service API at CCF:
- * Send **POST** to ccf_publish_url **https://{CAPIF_HOSTNAME}/published-apis/v1/{apfId}/service-apis**
- * body [service api description] with apiName **service_1**
- * Use **APF Certificate**
-
- 3. Request Discover Published APIs not filtered:
- * Send **GET** to ccf_discover_url **https://{CAPIF_HOSTNAME}/service-apis/v1/allServiceAPIs?api-invoker-id={apiInvokerId}**
- * Param api-invoker-id is mandatory
- * Using **Invoker Certificate**
-
- 4. Create Security Context for this Invoker
- * Send **PUT** **https://{CAPIF_HOSTNAME}/trustedInvokers/{apiInvokerId}**
- * body [service security body]
- * Using **Invoker Certificate**.
- * Create Security Information Body with one **securityInfo** for each aef present at each serviceAPIDescription present at Discover.
-
- 5. Request Access Token by invoker:
- * Sent POST **https://{CAPIF_HOSTNAME}/securities/{securityId}/token**.
- * body [access token req body]
- * ***securityId*** is apiInvokerId
- * ***grant_type=client_credentials***
- * ***scope=3gpp#{aef_id}:not-valid***
- * Using **Invoker Certificate**
-
-**Expected Result**:
-
- 1. Response to Request of Access Token:
- 1. **400 Bad Request** response.
- 2. body returned must accomplish **AccessTokenErr** data structure, with:
- * error invalid_scope
- * error_description=One of the api names does not exist or is not associated with the aef id provided
-
-
- [Return To All Test Plans]: ../README.md
- [service security body]: ./service_security.json "Service Security Request"
- [security notification body]: ./security_notification.json "Security Notification Request"
- [access token req body]: ./access_token_req.json "Access Token Request"
- [example]: ./access_token_req.json "Access Token Request Example"
-
- [invoker onboarding]: ../common_operations/README.md#onboard-an-invoker "Invoker Onboarding"
- [provider registration]: ../common_operations/README.md#register-a-provider "Provider Registration"
-
-
diff --git a/doc/testing/testplan/api_security_service/access_token_req.json b/doc/testing/testplan/api_security_service/access_token_req.json
deleted file mode 100644
index 8504736e1fb40d49c3bcb4c6a8bca4dbb6d9f855..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_security_service/access_token_req.json
+++ /dev/null
@@ -1,6 +0,0 @@
-{
- "client_id": "client_id",
- "client_secret": "client_secret",
- "grant_type": "client_credentials",
- "scope": "scope"
-}
\ No newline at end of file
diff --git a/doc/testing/testplan/api_security_service/access_token_req_example.json b/doc/testing/testplan/api_security_service/access_token_req_example.json
deleted file mode 100644
index 070a717db975b76a80792117b50957ce4267cf6b..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_security_service/access_token_req_example.json
+++ /dev/null
@@ -1,5 +0,0 @@
-{
- "client_id": "bb260b4d0b3a0f954fa23f42d979ca",
- "grant_type": "client_credentials",
- "scope": "3gpp#af7e4cf70063814770e7b00b87273e:service_1"
-}
diff --git a/doc/testing/testplan/api_security_service/security_notification.json b/doc/testing/testplan/api_security_service/security_notification.json
deleted file mode 100644
index 6b94eb5497ed8b6bde547dda6a4abc71783bc998..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_security_service/security_notification.json
+++ /dev/null
@@ -1,9 +0,0 @@
-{
- "aefId": "aefId",
- "apiIds": [
- "apiIds",
- "apiIds"
- ],
- "apiInvokerId": "api_invoker_id",
- "cause": "OVERLIMIT_USAGE"
-}
\ No newline at end of file
diff --git a/doc/testing/testplan/api_security_service/service_security.json b/doc/testing/testplan/api_security_service/service_security.json
deleted file mode 100644
index ad7bc1ad5c64f6dc979a294044b5b44f5f43c68a..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/api_security_service/service_security.json
+++ /dev/null
@@ -1,25 +0,0 @@
-{
- "notificationDestination": "http://robot.testing",
- "supportedFeatures": "fffffff",
- "securityInfo": [{
- "authenticationInfo": "authenticationInfo",
- "authorizationInfo": "authorizationInfo",
- "interfaceDetails": {
- "ipv4Addr": "127.0.0.1",
- "securityMethods": ["PSK"],
- "port": 5248
- },
- "prefSecurityMethods": ["PSK", "PKI", "OAUTH"],
- },
- {
- "authenticationInfo": "authenticationInfo",
- "authorizationInfo": "authorizationInfo",
- "prefSecurityMethods": ["PSK", "PKI", "OAUTH"],
- "aefId": "aefId"
- }],
- "websockNotifConfig": {
- "requestWebsocketUri": true,
- "websocketUri": "websocketUri"
- },
- "requestTestNotification": true
-}
diff --git a/doc/testing/testplan/common_operations/README.md b/doc/testing/testplan/common_operations/README.md
deleted file mode 100644
index 48d31a83533b4880dbf7eaba12d06388e20e3f4a..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/common_operations/README.md
+++ /dev/null
@@ -1,118 +0,0 @@
-# Common Operations
-
-## Register new user
-
-In order to use OpenCAPIF we must add a new user. This new user can onboard/register any Invokers or Providers.
-
-That new user **must be created by administrator** of Register Service and with the credentials shared by administrator, the new user can get the **access_token** by requesting it to Register service.
-
-The steps to register a new user at Register Service are:
-
-### Admin create User
-1) **Login as Admin to get access_token:**
-
- * Send **POST** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/login**
- * **Include basic Auth Header with Admin credentials**
- * Get **access_token** and **refresh_token** from response
-
-
-
-2) **Create User:**
-
- * Send **POST** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/createUser**
- * Include Admin **access_token** in **Authorization Bearer Header**
- * Body [user_registration_body]
-
-
-
-### User Retrieve access token and other information
-1) **Retrieve access_token by User:**
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include **basic Auth Header with User credentials**
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
-
-
-## Onboard an Invoker
-
-### Steps to perform operation
-***Preconditions: The administrator must have previously registered the User.***
-
- 1. Create public and private key at invoker
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Onboard Invoker:
-
- * Send **POST** to **https://{CAPIF_HOSTNAME}/api-invoker-management/v1/onboardedInvokers**
- * Reference Request Body: [invoker onboarding body]
- * "onboardingInformation"->"apiInvokerPublicKey": must contain public key generated by Invoker.
- * Send in Authorization Header the Bearer access_token obtained previously (Authorization:Bearer ${access_token})
-
-### Checks to ensure onboarding
-
- 2. Response to Get Auth:
- 1. **200 OK**
- 2. ***access_token*** returned.
-
- 3. Response to Onboard request must accomplish:
- 1. **201 Created**
- 2. Response Body must follow **APIInvokerEnrolmentDetails** data structure with:
- * apiInvokerId
- * onboardingInformation->apiInvokerCertificate must contain the public key signed.
- 3. Response Header **Location** must be received with URI to new resource created, following this structure: **{apiRoot}/api-invoker-management/{apiVersion}/onboardedInvokers/{onboardingId}**
-
-### Example Flow
-
-
-## Register a Provider
-
-### Steps to Perform operation
- 1. Create public and private key at provider for provider itself and each function (apf, aef and amf)
- 2. Retrieve access_token by User:
-
- * Send **GET** to **https://${CAPIF_REGISTER}:${CAPIF_REGISTER_PORT}/getauth**
- * Include basic Auth Header with Admin user/password
- * Retrieve **access_token** and the urls needed for next requests from response body [user_getauth_response_body_example]
-
- 3. Register Provider:
-
- * Send **POST** **https://{CAPIF_HOSTNAME}/api-provider-management/v1/registrations**
- * body [provider request body]
- * Send in Authorization Header the Bearer access_token obtained previously (Authorization:Bearer ${access_token})
- * Store each cert in a file with according name.
-
-### Checks to ensure provider registration
- 1. Response to Register:
- 1. **201 Created**
-
- 2. Response to Get Auth:
- 1. **200 OK**
- 2. ***access_token*** returned.
-
- 3. Register Provider at Provider Management:
- 1. **201 Created** response.
- 2. body returned must accomplish **APIProviderEnrolmentDetails** data structure.
- 3. For each **apiProvFuncs**, we must check:
- 1. **apiProvFuncId** is set
- 2. **apiProvCert** under **regInfo** is set properly
- 4. Location Header must contain the new resource URL **{apiRoot}/api-provider-management/v1/registrations/{registrationId}**
-
-### Example Flow
-
-
-
-[user_registration_body]: ./user_registration_body.json "User Registration Body"
-[user_getauth_response_body_example]: ./user_getauth_response_body_example.json "User GetAuth response Body Example"
-
-[invoker onboarding body]: ../api_invoker_management/invoker_details_post_example.json "API Invoker Request"
-[invoker getauth body]: ../api_invoker_management/invoker_getauth_example.json "Get Auth Example"
-
-[provider request body]: ../api_provider_management/provider_details_post_example.json "API Provider Enrolment Request"
-
-
-[Return To All Test Plans]: ../README.md
diff --git a/doc/testing/testplan/common_operations/user_getauth_response_body_example.json b/doc/testing/testplan/common_operations/user_getauth_response_body_example.json
deleted file mode 100644
index a4a71feba3522d8678a453eb5d8b82180dc82312..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/common_operations/user_getauth_response_body_example.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
- "access_token": "eyJhbGciOiJS...",
- "ca_root": "-----BEGIN CERTIFICATE----- ...",
- "ccf_api_onboarding_url": "api-provider-management/v1/registrations",
- "ccf_discover_url": "service-apis/v1/allServiceAPIs?api-invoker-id=",
- "ccf_onboarding_url": "api-invoker-management/v1/onboardedInvokers",
- "ccf_publish_url": "published-apis/v1/<apfId>/service-apis",
- "ccf_security_url": "capif-security/v1/trustedInvokers/<apiInvokerId>",
- "message": "Token and CA root returned successfully"
-}
\ No newline at end of file
diff --git a/doc/testing/testplan/common_operations/user_registration_body.json b/doc/testing/testplan/common_operations/user_registration_body.json
deleted file mode 100644
index 123c1e16bf5ef55eab5dc90927b3715856a0c0ab..0000000000000000000000000000000000000000
--- a/doc/testing/testplan/common_operations/user_registration_body.json
+++ /dev/null
@@ -1,6 +0,0 @@
-{
- "username": "customUser",
- "password": "password",
- "description": "description",
- "email": "customuser@telefonica.com"
-}
\ No newline at end of file