webapi-tests.postman_collection.json

{
	"info": {
		"_postman_id": "7b715c8e-5ec4-4efe-83dd-408b04390369",
		"name": "webapi-tests",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "verify app is running",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "http://{{hostname}}",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					]
				}
			},
			"response": []
		},
		{
			"name": "list workspaces",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "http://{{hostname}}/workspace",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"workspace"
					]
				}
			},
			"response": []
		},
		{
			"name": "list workflows",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "http://{{hostname}}/workflow",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"workflow"
					]
				}
			},
			"response": []
		},
		{
			"name": "create new workspace",
			"event": [
				{
					"listen": "test",
					"script": {
						"exec": [
							"var jsonData = pm.response.json();",
							"var ws_id = jsonData[\"@id\"].split(\"/\").pop()",
							"pm.collectionVariables.set(\"tmp_workspace_id\", ws_id);"
						],
						"type": "text/javascript"
					}
				}
			],
			"protocolProfileBehavior": {
				"disabledSystemHeaders": {}
			},
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "content-type",
						"value": "multipart/form-data",
						"type": "default",
						"disabled": true
					}
				],
				"body": {
					"mode": "formdata",
					"formdata": [
						{
							"key": "workspace",
							"type": "file",
							"src": "example_ws.ocrd.zip"
						}
					]
				},
				"url": {
					"raw": "http://{{hostname}}/workspace",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"workspace"
					]
				}
			},
			"response": []
		},
		{
			"name": "update workspace",
			"request": {
				"method": "PUT",
				"header": [],
				"body": {
					"mode": "formdata",
					"formdata": [
						{
							"key": "workspace",
							"type": "file",
							"src": "example_ws.ocrd.zip"
						}
					]
				},
				"url": {
					"raw": "http://{{hostname}}/workspace/{{example_workspace_id}}",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"workspace",
						"{{example_workspace_id}}"
					]
				}
			},
			"response": []
		},
		{
			"name": "update workflow",
			"request": {
				"auth": {
					"type": "basic",
					"basic": [
						{
							"key": "password",
							"value": "{{password}}",
							"type": "string"
						},
						{
							"key": "username",
							"value": "{{username}}",
							"type": "string"
						}
					]
				},
				"method": "PUT",
				"header": [],
				"body": {
					"mode": "formdata",
					"formdata": [
						{
							"key": "nextflow_script",
							"type": "file",
							"src": "nextflow-wo-venv.nf"
						}
					]
				},
				"url": {
					"raw": "http://{{hostname}}/workflow/{{example_workflow_id}}",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"workflow",
						"{{example_workflow_id}}"
					]
				}
			},
			"response": []
		},
		{
			"name": "run workflow",
			"event": [
				{
					"listen": "test",
					"script": {
						"exec": [
							"var jsonData = pm.response.json();",
							"var job_id = jsonData[\"@id\"].split(\"/\").pop()",
							"pm.collectionVariables.set(\"tmp_job_id\", job_id);"
						],
						"type": "text/javascript"
					}
				}
			],
			"protocolProfileBehavior": {
				"disabledSystemHeaders": {
					"accept-encoding": true
				}
			},
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n    \"workspace_id\": \"{{example_workspace_id}}\"\n}"
				},
				"url": {
					"raw": "http://{{hostname}}/workflow/{{example_workflow_id}}",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"workflow",
						"{{example_workflow_id}}"
					]
				}
			},
			"response": []
		},
		{
			"name": "request wf-job status",
			"event": [
				{
					"listen": "test",
					"script": {
						"exec": [
							""
						],
						"type": "text/javascript"
					}
				}
			],
			"protocolProfileBehavior": {
				"disabledSystemHeaders": {
					"accept": true
				}
			},
			"request": {
				"method": "GET",
				"header": [
					{
						"key": "Accept",
						"value": "application/vnd.ocrd+zip",
						"type": "default"
					}
				],
				"url": {
					"raw": "http://{{hostname}}/workflow/{{example_workflow_id}}/{{tmp_job_id}}",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"workflow",
						"{{example_workflow_id}}",
						"{{tmp_job_id}}"
					]
				}
			},
			"response": []
		},
		{
			"name": "download example workspace zip",
			"event": [
				{
					"listen": "test",
					"script": {
						"exec": [
							""
						],
						"type": "text/javascript"
					}
				}
			],
			"protocolProfileBehavior": {
				"disabledSystemHeaders": {
					"accept": true
				}
			},
			"request": {
				"method": "GET",
				"header": [
					{
						"key": "Accept",
						"value": "application/vnd.ocrd+zip",
						"type": "default"
					}
				],
				"url": {
					"raw": "http://{{hostname}}/workspace/{{example_workspace_id}}",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"workspace",
						"{{example_workspace_id}}"
					]
				}
			},
			"response": []
		},
		{
			"name": "run dummy processor",
			"event": [
				{
					"listen": "test",
					"script": {
						"exec": [
							"var jsonData = pm.response.json();",
							"var job_id = jsonData[\"@id\"].split(\"/\").pop()",
							"pm.collectionVariables.set(\"tmp_processor_job_id\", job_id);"
						],
						"type": "text/javascript"
					}
				}
			],
			"request": {
				"method": "POST",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n    \"workspace_id\": \"{{tmp_workspace_id}}\",\n    \"input_file_grps\": \"OCR-D-IMG\",\n    \"output_file_grps\": \"OCR-D-DUMMY\"\n}"
				},
				"url": {
					"raw": "http://{{hostname}}/processor/ocrd-dummy",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"processor",
						"ocrd-dummy"
					],
					"query": [
						{
							"key": "",
							"value": null,
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "get dummy processor info",
			"protocolProfileBehavior": {
				"disableBodyPruning": true
			},
			"request": {
				"method": "GET",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n    \"workspace_id\": \"{{tmp_workspace_id}}\",\n    \"input_file_grps\": \"OCR-D-IMG\",\n    \"output_file_grps\": \"OCR-D-DUMMY\"\n}"
				},
				"url": {
					"raw": "http://{{hostname}}/processor/ocrd-dummy",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"processor",
						"ocrd-dummy"
					],
					"query": [
						{
							"key": "",
							"value": null,
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "get processor job",
			"protocolProfileBehavior": {
				"disableBodyPruning": true
			},
			"request": {
				"method": "GET",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n    \"workspace_id\": \"{{tmp_workspace_id}}\",\n    \"input_file_grps\": \"OCR-D-IMG\",\n    \"output_file_grps\": \"OCR-D-DUMMY\"\n}"
				},
				"url": {
					"raw": "http://{{hostname}}/processor/ocrd-dummy/{{tmp_processor_job_id}}",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"processor",
						"ocrd-dummy",
						"{{tmp_processor_job_id}}"
					],
					"query": [
						{
							"key": "",
							"value": null,
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "list processors",
			"protocolProfileBehavior": {
				"disableBodyPruning": true
			},
			"request": {
				"method": "GET",
				"header": [
					{
						"key": "Content-Type",
						"value": "application/json",
						"type": "default"
					}
				],
				"body": {
					"mode": "raw",
					"raw": "{\n    \"workspace_id\": \"{{tmp_workspace_id}}\",\n    \"input_file_grps\": \"OCR-D-IMG\",\n    \"output_file_grps\": \"OCR-D-DUMMY\"\n}"
				},
				"url": {
					"raw": "http://{{hostname}}/processor",
					"protocol": "http",
					"host": [
						"{{hostname}}"
					],
					"path": [
						"processor"
					],
					"query": [
						{
							"key": "",
							"value": null,
							"disabled": true
						}
					]
				}
			},
			"response": []
		}
	],
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	],
	"variable": [
		{
			"key": "hostname",
			"value": "localhost:8000",
			"type": "default"
		},
		{
			"key": "example_workspace_id",
			"value": "postman-test-ws",
			"type": "default"
		},
		{
			"key": "example_workflow_id",
			"value": "postman-test-wf",
			"type": "default"
		},
		{
			"key": "tmp_workspace_id",
			"value": "x"
		},
		{
			"key": "tmp_job_id",
			"value": "x"
		},
		{
			"key": "tmp_processor_job_id",
			"value": "",
			"type": "default"
		}
	]
}