From 6f7d025cae6be907a58453e2309067cd015611bc Mon Sep 17 00:00:00 2001
From: Beff42 <83531917+Beff42@users.noreply.github.com>
Date: Fri, 16 Feb 2024 10:48:47 +0100
Subject: [PATCH] =?UTF-8?q?Adds=20better=20documentation=20of=20where=20th?=
 =?UTF-8?q?e=20mxid=20is=20required=20in=20its=20url=20fo=E2=80=A6=20(#228?=
 =?UTF-8?q?)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Adds better documentation of where the mxid is required in its url format



---------

Co-authored-by: TVRiddle <44850999+TVRiddle@users.noreply.github.com>
---
 ReleaseNotes.md                         |  6 ++++++
 src/openapi/TiMessengerTestTreiber.yaml | 16 ++++++++++------
 2 files changed, 16 insertions(+), 6 deletions(-)

diff --git a/ReleaseNotes.md b/ReleaseNotes.md
index 2033c104..f673c00b 100644
--- a/ReleaseNotes.md
+++ b/ReleaseNotes.md
@@ -2,6 +2,12 @@
  
 # Release Notes api-ti-messenger
 
+## Hotfix 1.1.1-5
+
+### added
+
+- Additional examples and documentation for using the uri scheme of the matrix id (see https://spec.matrix.org/v1.3/appendices/#matrix-uri-scheme) in the FHIR directory. 
+
 ## Hotfix 1.1.1-4
 
 ### changed
diff --git a/src/openapi/TiMessengerTestTreiber.yaml b/src/openapi/TiMessengerTestTreiber.yaml
index b8e45864..08fa41ba 100644
--- a/src/openapi/TiMessengerTestTreiber.yaml
+++ b/src/openapi/TiMessengerTestTreiber.yaml
@@ -786,6 +786,7 @@ paths:
           description: "MxId of account"
           schema:
             type: string
+            example: @someone:gematik.de
 
       responses:
         "200":
@@ -844,9 +845,10 @@ paths:
             type: string
         - name: contactMxid
           in: query
-          description: "MXID of the Organization.contact."
+          description: "MXID of the Organization.contact in uri scheme."
           schema:
             type: string
+            example: matrix:u/someone:gematik.de
         - name: contactName
           in: query
           description: "Name of the Organization.contact."
@@ -892,9 +894,10 @@ paths:
             type: string
         - name: mxId
           in: query
-          description: "MxId standing in address field of the endpoint"
+          description: "MxId (in uri scheme) standing in address field of the endpoint"
           schema:
             type: string
+            example: matrix:u/someone:gematik.de
 
       responses:
         "200":
@@ -948,9 +951,10 @@ paths:
             type: string
         - name: mxid
           in: query
-          description: "MXID of the Practitioner."
+          description: "MXID of the Practitioner in uri scheme."
           schema:
             type: string
+            example: matrix:u/someone:gematik.de
 
       responses:
         "200":
@@ -2316,7 +2320,7 @@ components:
             $ref: "#/components/schemas/HomeserverSearchResult"
 
     HomeserverSearchResult:
-      description: "A flat description of an endpoint with belonging healthcare-serviceand organization"
+      description: "A flat description of an endpoint with belonging healthcare-service and organization"
       readOnly: true
       type: object
       properties:
@@ -2562,9 +2566,9 @@ components:
           example: "active"
           enum: [ active, suspended, inactive ]
         address:
-          description: "For endpoint in tim context the mxid"
+          description: "For endpoint in tim context the mxid in uri scheme"
           type: string
-          example: "@test:gematik.de"
+          example: "matrix:u/test:gematik.de"
         connectionType:
           $ref: "#/components/schemas/FhirConnectionType"
         payloadType: