Commit 2ad0cfd1 authored by Jorge Moratinos's avatar Jorge Moratinos
Browse files

Merge branch 'OCF-Doc8-documentation-of-the-helper-service' into 'develop'

Ocf doc8 documentation of the helper service

See merge request ocf/documentation!6
parents 2a478a12 61fa52d5
Loading
Loading
Loading
Loading
Loading
+4 −0
Original line number Diff line number Diff line
site
doc/testing/postman/Responses
doc/testing/postman/node_modules
doc/testing/postman/package-lock.json
.DS_Store
 No newline at end of file
+15 −1
Original line number Diff line number Diff line
@@ -6,6 +6,7 @@
- [Run All CAPIF Services locally with Docker images and deploy monitoring stack](#run-all-capif-services-locally-with-docker-images-and-deploy-monitoring-stack)
- [Run each service using Docker](#run-each-service-using-docker)
- [Run each service using Python](#run-each-service-using-python)
- [Start Your Testing with OpenCAPIF](#start-your-testing-with-opencapif)

Capif services are developed under [services folder](https://labs.etsi.org/rep/ocf/capif/-/tree/main/services).

@@ -159,3 +160,16 @@ cd <Service>
pip3 install -r requirements.txt
python3 -m <service>
```

#### Start Your Testing with OpenCAPIF

Related with OpenCAPIF Testing, the following sections help you to understand testing implemented and how to run it by yourself:

- [Test Plan Directory]: Here you can find the complete test plan definition that are accomplish by all versions released of OpenCAPIF.
- [Testing with Robot Framework]: At this section you can find all information about how to run the test suite implemented using Robot Framework.
- [Testing with Postman]: Easy way to understand the complete basic OpenCAPIF flow, acting as invoker and provider.


[Test Plan Directory]: .././testing/testplan/README.md  "Test Plan"
[Testing with Robot Framework]: .././testing/robotframework/README.md  "Robot Framework"
[Testing with Postman]: .././testing/postman/README.md  "Postman"
+1465 −0

File added.

Preview size limit exceeded, changes collapsed.

+8 −13
Original line number Diff line number Diff line
{
	"info": {
		"_postman_id": "b512e528-4b13-4be2-aed2-a61a8381360e",
		"_postman_id": "03e5f144-6a4f-4899-a917-14787d59fbef",
		"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"
		"_collection_link": "https://red-comet-993867.postman.co/workspace/Team-Workspace~bfc7c442-a60c-4bb1-8730-fdabc2df89b9/collection/31608242-03e5f144-6a4f-4899-a917-14787d59fbef?action=share&source=collection_link&creator=31608242"
	},
	"item": [
		{
@@ -264,7 +264,6 @@
					{
						"key": "",
						"value": "",
						"type": "text",
						"disabled": true
					}
				],
@@ -340,7 +339,6 @@
					{
						"key": "",
						"value": "",
						"type": "text",
						"disabled": true
					}
				],
@@ -439,7 +437,6 @@
					{
						"key": "",
						"value": "",
						"type": "text",
						"disabled": true
					}
				],
@@ -527,7 +524,6 @@
					{
						"key": "",
						"value": "",
						"type": "text",
						"disabled": true
					}
				],
@@ -603,7 +599,6 @@
					{
						"key": "",
						"value": "",
						"type": "text",
						"disabled": true
					}
				],
@@ -686,7 +681,6 @@
					{
						"key": "",
						"value": "",
						"type": "text",
						"disabled": true
					}
				],
@@ -741,7 +735,8 @@
						"exec": [
							""
						],
						"type": "text/javascript"
						"type": "text/javascript",
						"packages": {}
					}
				},
				{
@@ -750,7 +745,8 @@
						"exec": [
							""
						],
						"type": "text/javascript"
						"type": "text/javascript",
						"packages": {}
					}
				}
			],
@@ -773,13 +769,12 @@
					{
						"key": "",
						"value": "",
						"type": "text",
						"disabled": true
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n\"name\": {{USERNAME_INVOKER}}\n}",
					"raw": "{\n\"name\": \"{{USER_NAME}}\"\n}",
					"options": {
						"raw": {
							"language": "json"
@@ -961,7 +956,7 @@
						}
					]
				},
				"method": "GET",
				"method": "POST",
				"header": [],
				"url": {
					"raw": "https://{{REGISTER_HOSTNAME}}:{{REGISTER_PORT}}/refresh",