Merge pull request #224 from gematik/HOTFIX_New_Cleanup_Endpoint_Testdriver

Hotfix new optional cleanup endpoint testdriverapi

Author: TVRiddle

README.adoc

@@ -16,8 +16,8 @@ image::meta/gematik_logo.svg[gematik,width="70%"]
 
 image:https://img.shields.io/badge/Release%20Notes-v1.1.1-red?style=plastic&logo=github&logoColor=red[link="ReleaseNotes.md"] +
 image:https://img.shields.io/badge/I_TiMessengerContactManagement-v1.0.1-blue?style=plastic&logo=github&logoColor=blue[link=/src/openapi/TiMessengerContactManagement.yaml"] +
-image:https://img.shields.io/badge/TiMessengerTestDriver-v0.9.2-purple?style=plastic&logo=github&logoColor=purple[link="/src/openapi/TiMessengerTestTreiber.yaml"]
-image:https://img.shields.io/badge/TiMessengerTestSuite-v0.9.2-purple?style=plastic&logo=github&logoColor=purple[link="https://github.com/gematik/TI-Messenger-Testsuite"] +
+image:https://img.shields.io/badge/TiMessengerTestDriver-v0.9.3-purple?style=plastic&logo=github&logoColor=purple[link="/src/openapi/TiMessengerTestTreiber.yaml"]
+image:https://img.shields.io/badge/TiMessengerTestSuite-v0.9.7-purple?style=plastic&logo=github&logoColor=purple[link="https://github.com/gematik/TI-Messenger-Testsuite"] +
 image:https://img.shields.io/badge/TI‐Messenger‐Dienst-v1.1.1-green?style=plastic&logo=github&logoColor=green[link="https://fachportal.gematik.de/fachportal-import/files/gemSpec_TI-Messenger-Dienst_V1.1.1.pdf"]
 image:https://img.shields.io/badge/TI‐Messenger‐FD-v1.1.1-green?style=plastic&logo=github&logoColor=green[link="https://fachportal.gematik.de/fachportal-import/files/gemSpec_TI-Messenger-FD_V1.1.1.pdf"]
 image:https://img.shields.io/badge/TI‐Messenger‐Client-v1.1.1-green?style=plastic&logo=github&logoColor=green[link="https://fachportal.gematik.de/fachportal-import/files/gemSpec_TI-Messenger-Client_V1.1.1.pdf"] +

ReleaseNotes.md

@@ -1,6 +1,12 @@
 <img align="right" width="250" height="47" src="images/meta/gematik_logo.svg"/> <br/>    
 
 # Release Notes api-ti-messenger
+
+## Hotfix 1.1.1-3
+
+### changed
+
+- Testdriver api: Added optional endpoint for clean up system
 
 ## Release 1.1.1 (2023-08-25)
 

src/openapi/TiMessengerTestTreiber.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: TiMessengerTestDriver
   description: REST interface to automate the test of a TI-Messenger client implementation.
-  version: 0.9.2
+  version: 0.9.3
   contact:
     name: gematik GmbH
     email: software-development@gematik.de
@@ -33,6 +33,8 @@ servers:
 tags:
   - name: info
     description: This operation returns meta data about this interface and the status of available resources
+  - name: signalTestStart
+    description: This endpoint serves the possibility to clean system before test
   - name: devices
     description: Operations for device management
   - name: account
@@ -83,6 +85,21 @@ paths:
         default:
           $ref: "#/components/responses/DefaultResponse"
 
+    post:
+      tags:
+        - signalTestStart
+      description: Implementation is optional! Testsuite sends a request to the org-admin endpoint of each involved homeserver (even if the org-admin is not named in the feature-file). There will be no claiming attempt before triggering this endpoint. After getting any response the testcase starts. This is an opportunity for the org-admin to clean user/rooms/FHIR-VZD etc. Even if errorcode returned the testsuite will start the test.
+      operationId: cleanUp
+      responses:
+        "200":
+          description: System clean
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+        default:
+          $ref: "#/components/responses/DefaultResponse"
+
   /devices:
     get:
       tags:
@@ -1658,6 +1675,12 @@ components:
         application/json:
           schema:
             $ref: "#/components/schemas/Error"
+    InternalServerError:
+      description: "Something went wrong server internally"
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"
     Unauthorized:
       description: "Unauthorized - you have to login first"
       content: