From bdc43ca67c8c2fc3feb788953a580a4bb6302f13 Mon Sep 17 00:00:00 2001 From: "andre.wagner" Date: Thu, 28 Mar 2024 10:04:52 +0100 Subject: [PATCH] new tags in TiMessengerTestTreiber.yaml --- ReleaseNotes.md | 6 + src/openapi/TiMessengerTestTreiber.yaml | 511 ++++++++++++++---------- 2 files changed, 310 insertions(+), 207 deletions(-) diff --git a/ReleaseNotes.md b/ReleaseNotes.md index 75a35680..a72063ae 100644 --- a/ReleaseNotes.md +++ b/ReleaseNotes.md @@ -2,6 +2,12 @@ # Release Notes api-ti-messenger +## Hotfix 1.1.1-7 + +### changed + + - new tags in TiMessengerTestTreiber.yaml + ## Hotfix 1.1.1-6 ### fixed diff --git a/src/openapi/TiMessengerTestTreiber.yaml b/src/openapi/TiMessengerTestTreiber.yaml index 31142bf1..6285a5e9 100644 --- a/src/openapi/TiMessengerTestTreiber.yaml +++ b/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.4 + version: 0.9.5 contact: name: gematik GmbH email: software-development@gematik.de @@ -65,11 +65,19 @@ tags: description: contact management operations - name: media description: media file upload and download + - name: authorizationManagement + description: authorization management operations + - name: TI-M Pro + description: all operations used in TI-Messenger Pro and TI-Messenger Version 1.1.x + - name: TI-M_ePA + description: all operations used in TI-Messenger ePA paths: /: get: tags: + - TI-M Pro + - TI-M_ePA - info description: Returns the meta data of this interface. operationId: getInfo @@ -87,6 +95,8 @@ paths: post: tags: + - TI-M Pro + - TI-M_ePA - 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 @@ -103,6 +113,8 @@ paths: /devices: get: tags: + - TI-M Pro + - TI-M_ePA - devices description: "Returns the connected devices and the information of the deposited HBA/SMC-B if existing" operationId: getDevices @@ -123,6 +135,8 @@ paths: post: tags: + - TI-M Pro + - TI-M_ePA - devices description: "Claims a device for exclusive use." operationId: claimDevice @@ -153,6 +167,8 @@ paths: post: tags: + - TI-M Pro + - TI-M_ePA - devices description: "Unclaims a previously claimed device." operationId: unclaimDevice @@ -172,6 +188,36 @@ paths: default: $ref: "#/components/responses/DefaultResponse" + /devices/{deviceId}/account: + parameters: + - $ref: "#/components/parameters/deviceId" + - $ref: "#/components/parameters/transactionIdHeader" + + get: + tags: + - TI-M Pro + - TI-M_ePA + - account + description: "Returns the account data or if no account is registered returns the authentication flows supported by the homeserver." + operationId: readAccount + responses: + "200": + description: "account data of the logged in account" + content: + application/json: + schema: + $ref: "#/components/schemas/Account" + "400": + $ref: "#/components/responses/BadRequest" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "404": + $ref: "#/components/responses/NotFound" + default: + $ref: "#/components/responses/DefaultResponse" + /devices/{deviceId}/login: parameters: - $ref: "#/components/parameters/deviceId" @@ -180,6 +226,8 @@ paths: get: description: "Retrieve list of possible authentication flows" tags: + - TI-M Pro + - TI-M_ePA - login/logout operationId: getLoginOptions responses: @@ -203,6 +251,8 @@ paths: post: description: "login to an account. If no login data is provided, a preconfigured account should be used. In case the device has a HBA/SMC-B its data should be used" tags: + - TI-M Pro + - TI-M_ePA - login/logout operationId: login requestBody: @@ -236,6 +286,8 @@ paths: post: description: "logout" tags: + - TI-M Pro + - TI-M_ePA - login/logout operationId: logout responses: @@ -250,34 +302,6 @@ paths: default: $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/account: - parameters: - - $ref: "#/components/parameters/deviceId" - - $ref: "#/components/parameters/transactionIdHeader" - - get: - tags: - - account - description: "Returns the account data or if no account is registered returns the authentication flows supported by the homeserver." - operationId: readAccount - responses: - "200": - description: "account data of the logged in account" - content: - application/json: - schema: - $ref: "#/components/schemas/Account" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "403": - $ref: "#/components/responses/Forbidden" - "404": - $ref: "#/components/responses/NotFound" - default: - $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/account/key: parameters: - $ref: "#/components/parameters/deviceId" @@ -285,6 +309,8 @@ paths: get: tags: + - TI-M Pro + - TI-M_ePA - keyExchange description: "Exports secret key for device synchronization. The key could be in any format but has to be understood by every provided test-driver-api per distributor!" operationId: keyExport @@ -304,6 +330,8 @@ paths: post: tags: + - TI-M Pro + - TI-M_ePA - keyExchange description: "Imports secret key and execute synchronization" operationId: keyImport @@ -322,38 +350,14 @@ paths: default: $ref: "#/components/responses/DefaultResponse" - - /devices/{deviceId}/fhir/fhirAuthenticate: - parameters: - - $ref: "#/components/parameters/deviceId" - - $ref: "#/components/parameters/transactionIdHeader" - - post: - tags: - #- orgAdminFhirAdministration - - practitionerFhirAdministration - description: "This request starts the OIDC authentication for getting access to change the own FHIR entry." - operationId: authenticateOnFhirDirectory - responses: - "200": - description: "OIDC flow with IDP successfully completed" - "401": - $ref: "#/components/responses/Unauthorized" - "403": - $ref: "#/components/responses/Forbidden" - "404": - $ref: "#/components/responses/NotFound" - "501": - description: "Unimplemented - if the underlying client does not support FHIR-VZD authentication" - default: - $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/fhir/org: parameters: - $ref: "#/components/parameters/deviceId" - $ref: "#/components/parameters/transactionIdHeader" get: tags: + - TI-M Pro + - TI-M_ePA - orgAdminFhirOrganization description: "Get organization from the selected device" operationId: getOrganization @@ -374,6 +378,7 @@ paths: get: tags: + - TI-M Pro - orgAdminFhirHealthcareService description: "Get healthcareServices regarding the organization that belongs to the claimed device (the search result could also contain all other resources that are related with it. @@ -391,6 +396,7 @@ paths: post: tags: + - TI-M Pro - orgAdminFhirHealthcareService description: "Created new healthcare-service and returns the ressource of the created healthcareService" operationId: createHealthcareService @@ -419,6 +425,7 @@ paths: get: tags: + - TI-M Pro - orgAdminFhirHealthcareService description: "Get specific healthcareService regarding" operationId: getHealthcareService @@ -436,6 +443,7 @@ paths: put: tags: + - TI-M Pro - orgAdminFhirHealthcareService description: "Changes healthcareService accordingly" operationId: updateHealthcareService @@ -460,6 +468,7 @@ paths: delete: tags: + - TI-M Pro - orgAdminFhirHealthcareService description: "Delete specific healthcareService regarding" operationId: deleteHealthcareService @@ -471,7 +480,7 @@ paths: default: $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/fhir/org/healthcareService/{hsId}/location: + /devices/{deviceId}/fhir/org/healthcareService/{hsId}/endpoint: parameters: - $ref: "#/components/parameters/deviceId" - $ref: "#/components/parameters/transactionIdHeader" @@ -479,14 +488,15 @@ paths: get: tags: - - orgAdminFhirLocations - description: "Get all locations for healthcare service + - TI-M Pro + - orgAdminFhirEndpoints + description: "Get all endpoints for healthcare-service. (the search result could also contain all other resources that are related with it. Please ensure that the searched resources are included at any time!)" - operationId: getLocations + operationId: getEndpoints responses: "200": - description: "Successfully get all locations for healthcare service" + description: "Successfully get all endpoints for healthcare service" content: application/json: schema: @@ -498,21 +508,22 @@ paths: post: tags: - - orgAdminFhirLocations - description: "Create location and return the created resource" - operationId: createLocation + - TI-M Pro + - orgAdminFhirEndpoints + description: "Create endpoint" + operationId: createEndpoint requestBody: content: application/json: schema: - $ref: "#/components/schemas/FhirLocation" + $ref: "#/components/schemas/FhirEndpoint" responses: "201": description: "Successful created" content: application/json: schema: - $ref: "#/components/schemas/FhirLocation" + $ref: "#/components/schemas/FhirEndpoint" "400": $ref: "#/components/responses/BadRequest" "404": @@ -520,25 +531,26 @@ paths: default: $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/fhir/org/healthcareService/{hsId}/location/{locId}: + /devices/{deviceId}/fhir/org/healthcareService/{hsId}/endpoint/{endId}: parameters: - $ref: "#/components/parameters/deviceId" - $ref: "#/components/parameters/transactionIdHeader" - $ref: "#/components/parameters/healthcareServiceId" - - $ref: "#/components/parameters/locationId" + - $ref: "#/components/parameters/endpointId" get: - description: "Returns information about the requested location" + description: "Returns information about the requested endpoint" tags: - - orgAdminFhirLocations - operationId: getLocation + - TI-M Pro + - orgAdminFhirEndpoints + operationId: getEndpoint responses: "200": - description: "Successfully get Location" + description: "Successfully get endpoint" content: application/json: schema: - $ref: "#/components/schemas/FhirLocation" + $ref: "#/components/schemas/FhirEndpoint" "404": $ref: "#/components/responses/NotFound" default: @@ -546,21 +558,22 @@ paths: put: tags: - - orgAdminFhirLocations - description: "Updates a Location" - operationId: updateLocation + - TI-M Pro + - orgAdminFhirEndpoints + description: "Updates an endpoint" + operationId: updateEndpoint requestBody: content: application/json: schema: - $ref: "#/components/schemas/FhirLocation" + $ref: "#/components/schemas/FhirEndpoint" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/FhirLocation" - description: "Successfully updated location" + $ref: "#/components/schemas/FhirEndpoint" + description: "Successfully updated endpoint" "400": $ref: "#/components/responses/BadRequest" "404": @@ -570,20 +583,19 @@ paths: delete: tags: - - orgAdminFhirLocations - description: "Deletes a location" - operationId: deleteLocation + - TI-M Pro + - orgAdminFhirEndpoints + description: "Deletes a endpoint" + operationId: deleteEndpoint responses: "204": - description: "Successfully delete location" - "400": - $ref: "#/components/responses/BadRequest" + description: "Successfully delete endpoint" "404": $ref: "#/components/responses/NotFound" default: $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/fhir/org/healthcareService/{hsId}/endpoint: + /devices/{deviceId}/fhir/org/healthcareService/{hsId}/location: parameters: - $ref: "#/components/parameters/deviceId" - $ref: "#/components/parameters/transactionIdHeader" @@ -591,14 +603,15 @@ paths: get: tags: - - orgAdminFhirEndpoints - description: "Get all endpoints for healthcare-service. + - TI-M Pro + - orgAdminFhirLocations + description: "Get all locations for healthcare service (the search result could also contain all other resources that are related with it. Please ensure that the searched resources are included at any time!)" - operationId: getEndpoints + operationId: getLocations responses: "200": - description: "Successfully get all endpoints for healthcare service" + description: "Successfully get all locations for healthcare service" content: application/json: schema: @@ -610,21 +623,22 @@ paths: post: tags: - - orgAdminFhirEndpoints - description: "Create endpoint" - operationId: createEndpoint + - TI-M Pro + - orgAdminFhirLocations + description: "Create location and return the created resource" + operationId: createLocation requestBody: content: application/json: schema: - $ref: "#/components/schemas/FhirEndpoint" + $ref: "#/components/schemas/FhirLocation" responses: "201": description: "Successful created" content: application/json: schema: - $ref: "#/components/schemas/FhirEndpoint" + $ref: "#/components/schemas/FhirLocation" "400": $ref: "#/components/responses/BadRequest" "404": @@ -632,25 +646,26 @@ paths: default: $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/fhir/org/healthcareService/{hsId}/endpoint/{endId}: + /devices/{deviceId}/fhir/org/healthcareService/{hsId}/location/{locId}: parameters: - $ref: "#/components/parameters/deviceId" - $ref: "#/components/parameters/transactionIdHeader" - $ref: "#/components/parameters/healthcareServiceId" - - $ref: "#/components/parameters/endpointId" + - $ref: "#/components/parameters/locationId" get: - description: "Returns information about the requested endpoint" + description: "Returns information about the requested location" tags: - - orgAdminFhirEndpoints - operationId: getEndpoint + - TI-M Pro + - orgAdminFhirLocations + operationId: getLocation responses: "200": - description: "Successfully get endpoint" + description: "Successfully get Location" content: application/json: schema: - $ref: "#/components/schemas/FhirEndpoint" + $ref: "#/components/schemas/FhirLocation" "404": $ref: "#/components/responses/NotFound" default: @@ -658,21 +673,22 @@ paths: put: tags: - - orgAdminFhirEndpoints - description: "Updates an endpoint" - operationId: updateEndpoint + - TI-M Pro + - orgAdminFhirLocations + description: "Updates a Location" + operationId: updateLocation requestBody: content: application/json: schema: - $ref: "#/components/schemas/FhirEndpoint" + $ref: "#/components/schemas/FhirLocation" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/FhirEndpoint" - description: "Successfully updated endpoint" + $ref: "#/components/schemas/FhirLocation" + description: "Successfully updated location" "400": $ref: "#/components/responses/BadRequest" "404": @@ -682,17 +698,45 @@ paths: delete: tags: - - orgAdminFhirEndpoints - description: "Deletes a endpoint" - operationId: deleteEndpoint + - TI-M Pro + - orgAdminFhirLocations + description: "Deletes a location" + operationId: deleteLocation responses: "204": - description: "Successfully delete endpoint" + description: "Successfully delete location" + "400": + $ref: "#/components/responses/BadRequest" "404": $ref: "#/components/responses/NotFound" default: $ref: "#/components/responses/DefaultResponse" + /devices/{deviceId}/fhir/fhirAuthenticate: + parameters: + - $ref: "#/components/parameters/deviceId" + - $ref: "#/components/parameters/transactionIdHeader" + + post: + tags: + - TI-M Pro + - practitionerFhirAdministration + description: "This request starts the OIDC authentication for getting access to change the own FHIR entry." + operationId: authenticateOnFhirDirectory + responses: + "200": + description: "OIDC flow with IDP successfully completed" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "404": + $ref: "#/components/responses/NotFound" + "501": + description: "Unimplemented - if the underlying client does not support FHIR-VZD authentication" + default: + $ref: "#/components/responses/DefaultResponse" + /devices/{deviceId}/fhir/mxidInFhirDirectory: parameters: - $ref: "#/components/parameters/deviceId" @@ -700,6 +744,7 @@ paths: post: tags: + - TI-M Pro - practitionerFhirAdministration description: "Set the MXID in the own practitioner FHIR resource and the created endpoint" operationId: setMxidInFhirDirectory @@ -725,6 +770,7 @@ paths: get: tags: + - TI-M Pro - practitionerFhirAdministration description: "Returns the own practitioner entry with belonging resources from the FHIR Directory." operationId: readMxidInFhirDirectory @@ -748,6 +794,7 @@ paths: delete: tags: + - TI-M Pro - practitionerFhirAdministration description: "Remove the MXID in the own Practitioner FHIR resource." operationId: removeMxidInFhirDirectory @@ -772,6 +819,7 @@ paths: get: tags: + - TI-M Pro - searchOnHomeserver description: "Returns a list of users on same homeserver that matches search parameters" operationId: searchOnHomeserver @@ -809,6 +857,8 @@ paths: get: tags: + - TI-M Pro + - TI-M_ePA - searchInFhirDirectory description: "Returns all belonging resources of an organization" operationId: searchOrganizationInFhirDirectory @@ -881,6 +931,8 @@ paths: get: tags: + - TI-M Pro + - TI-M_ePA - searchInFhirDirectory description: "Returns the found endpoints of healthcare-services matching query. (the search result could also contain all other resources that are related with it. @@ -920,6 +972,8 @@ paths: get: tags: + - TI-M Pro + - TI-M_ePA - searchInFhirDirectory description: "Returns the found Practitioner entries and its belonging location, endpoints and practitioner roles" operationId: searchPractitionerInFhirDirectory @@ -977,6 +1031,8 @@ paths: post: tags: + - TI-M Pro + - TI-M_ePA - message description: "Send a direct message to another user. Should work without creating a dedicated room first. The recipients MxId is received through a searchInFhirDirectory-Request." operationId: sendDirectMessage @@ -1003,23 +1059,26 @@ paths: default: $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/rooms: + /devices/{deviceId}/rooms/{roomId}/messages: parameters: - $ref: "#/components/parameters/deviceId" - $ref: "#/components/parameters/transactionIdHeader" + - $ref: "#/components/parameters/roomId" get: tags: - - room - operationId: getRooms - description: "get list of all rooms your account is associated with" + - TI-M Pro + - TI-M_ePA + - message + description: "list messages in room" + operationId: getMessages responses: "200": - description: "all associated rooms of the logged in account" + description: "this rooms messages" content: application/json: schema: - $ref: "#/components/schemas/Rooms" + $ref: "#/components/schemas/Messages" "401": $ref: "#/components/responses/Unauthorized" "403": @@ -1031,21 +1090,23 @@ paths: post: tags: - - room - description: "Create a room." - operationId: createRoom + - TI-M Pro + - TI-M_ePA + - message + description: "send a new message" + operationId: sendMessage requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateRoomRequest" + $ref: "#/components/schemas/MessageContent" responses: - "201": - description: "Room created" + "200": + description: "Message sent" content: application/json: schema: - $ref: "#/components/schemas/Room" + $ref: "#/components/schemas/Message" "400": $ref: "#/components/responses/BadRequest" "401": @@ -1057,56 +1118,27 @@ paths: default: $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/rooms/public: - parameters: - - $ref: "#/components/parameters/deviceId" - - $ref: "#/components/parameters/transactionIdHeader" - - get: - tags: - - room - description: "Get public rooms matching params" - operationId: getPublicRooms - parameters: - - name: name - in: query - description: "Full- or partial name of the Room" - schema: - type: string - - responses: - "200": - description: "all associated rooms of the logged in account" - content: - application/json: - schema: - $ref: "#/components/schemas/Rooms" - "401": - $ref: "#/components/responses/Unauthorized" - "403": - $ref: "#/components/responses/Forbidden" - "404": - $ref: "#/components/responses/NotFound" - default: - $ref: "#/components/responses/DefaultResponse" - - /devices/{deviceId}/rooms/{roomId}: + /devices/{deviceId}/rooms/{roomId}/messages/{messageId}: parameters: - $ref: "#/components/parameters/deviceId" - $ref: "#/components/parameters/transactionIdHeader" - $ref: "#/components/parameters/roomId" + - $ref: "#/components/parameters/messageId" + get: + description: "get single message" tags: - - room - description: "Get the room settings." - operationId: getRoomSettings + - TI-M Pro + - TI-M_ePA + - message + operationId: getMessage responses: "200": - description: OK + description: "message information" content: application/json: schema: - $ref: "#/components/schemas/Room" + $ref: "#/components/schemas/Message" "401": $ref: "#/components/responses/Unauthorized" "403": @@ -1117,22 +1149,24 @@ paths: $ref: "#/components/responses/DefaultResponse" put: + description: "edit an existing message" tags: - - room - description: "Change the room settings." - operationId: changeRoomSettings + - TI-M Pro + - TI-M_ePA + - message + operationId: editMessage requestBody: content: application/json: schema: - $ref: "#/components/schemas/RoomProperties" + $ref: "#/components/schemas/MessageContent" responses: "200": - description: "Successfully changed room settings" + description: "successfully edited message" content: application/json: schema: - $ref: "#/components/schemas/Room" + $ref: "#/components/schemas/Message" "400": $ref: "#/components/responses/BadRequest" "401": @@ -1145,13 +1179,17 @@ paths: $ref: "#/components/responses/DefaultResponse" delete: + description: "delete a message" tags: - - room - description: "Forget about this room." - operationId: forgetRoom + - TI-M Pro + - TI-M_ePA + - message + operationId: deleteMessage responses: "204": - description: "room forgotten" + description: "message deleted" + "400": + $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "403": @@ -1161,24 +1199,25 @@ paths: default: $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/rooms/{roomId}/messages: + /devices/{deviceId}/rooms: parameters: - $ref: "#/components/parameters/deviceId" - $ref: "#/components/parameters/transactionIdHeader" - - $ref: "#/components/parameters/roomId" get: tags: - - message - description: "list messages in room" - operationId: getMessages + - TI-M Pro + - TI-M_ePA + - room + operationId: getRooms + description: "get list of all rooms your account is associated with" responses: "200": - description: "this rooms messages" + description: "all associated rooms of the logged in account" content: application/json: schema: - $ref: "#/components/schemas/Messages" + $ref: "#/components/schemas/Rooms" "401": $ref: "#/components/responses/Unauthorized" "403": @@ -1190,21 +1229,23 @@ paths: post: tags: - - message - description: "send a new message" - operationId: sendMessage + - TI-M Pro + - TI-M_ePA + - room + description: "Create a room." + operationId: createRoom requestBody: content: application/json: schema: - $ref: "#/components/schemas/MessageContent" + $ref: "#/components/schemas/CreateRoomRequest" responses: - "200": - description: "Message sent" + "201": + description: "Room created" content: application/json: schema: - $ref: "#/components/schemas/Message" + $ref: "#/components/schemas/Room" "400": $ref: "#/components/responses/BadRequest" "401": @@ -1216,25 +1257,60 @@ paths: default: $ref: "#/components/responses/DefaultResponse" - /devices/{deviceId}/rooms/{roomId}/messages/{messageId}: + /devices/{deviceId}/rooms/public: parameters: - $ref: "#/components/parameters/deviceId" - $ref: "#/components/parameters/transactionIdHeader" - - $ref: "#/components/parameters/roomId" - - $ref: "#/components/parameters/messageId" get: - description: "get single message" tags: - - message - operationId: getMessage + - TI-M Pro + - TI-M_ePA + - room + description: "Get public rooms matching params" + operationId: getPublicRooms + parameters: + - name: name + in: query + description: "Full- or partial name of the Room" + schema: + type: string + responses: "200": - description: "message information" + description: "all associated rooms of the logged in account" content: application/json: schema: - $ref: "#/components/schemas/Message" + $ref: "#/components/schemas/Rooms" + "401": + $ref: "#/components/responses/Unauthorized" + "403": + $ref: "#/components/responses/Forbidden" + "404": + $ref: "#/components/responses/NotFound" + default: + $ref: "#/components/responses/DefaultResponse" + + /devices/{deviceId}/rooms/{roomId}: + parameters: + - $ref: "#/components/parameters/deviceId" + - $ref: "#/components/parameters/transactionIdHeader" + - $ref: "#/components/parameters/roomId" + get: + tags: + - TI-M Pro + - TI-M_ePA + - room + description: "Get the room settings." + operationId: getRoomSettings + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/Room" "401": $ref: "#/components/responses/Unauthorized" "403": @@ -1245,22 +1321,24 @@ paths: $ref: "#/components/responses/DefaultResponse" put: - description: "edit an existing message" tags: - - message - operationId: editMessage + - TI-M Pro + - TI-M_ePA + - room + description: "Change the room settings." + operationId: changeRoomSettings requestBody: content: application/json: schema: - $ref: "#/components/schemas/MessageContent" + $ref: "#/components/schemas/RoomProperties" responses: "200": - description: "successfully edited message" + description: "Successfully changed room settings" content: application/json: schema: - $ref: "#/components/schemas/Message" + $ref: "#/components/schemas/Room" "400": $ref: "#/components/responses/BadRequest" "401": @@ -1273,15 +1351,15 @@ paths: $ref: "#/components/responses/DefaultResponse" delete: - description: "delete a message" tags: - - message - operationId: deleteMessage + - TI-M Pro + - TI-M_ePA + - room + description: "Forget about this room." + operationId: forgetRoom responses: "204": - description: "message deleted" - "400": - $ref: "#/components/responses/BadRequest" + description: "room forgotten" "401": $ref: "#/components/responses/Unauthorized" "403": @@ -1299,6 +1377,8 @@ paths: post: tags: + - TI-M Pro + - TI-M_ePA - room description: "Invite a user into the room." operationId: inviteIntoRoom @@ -1333,6 +1413,8 @@ paths: post: tags: + - TI-M Pro + - TI-M_ePA - room description: "join the room." operationId: joinRoom @@ -1360,6 +1442,8 @@ paths: post: tags: + - TI-M Pro + - TI-M_ePA - room description: "Leave the room." operationId: leaveRoom @@ -1387,6 +1471,8 @@ paths: get: tags: + - TI-M Pro + - TI-M_ePA - room description: "Returns all state events of the room" operationId: "Get state events" @@ -1413,6 +1499,7 @@ paths: get: tags: + - TI-M Pro - contactManagement description: "Returns the contacts with invite settings." operationId: getContacts @@ -1428,6 +1515,7 @@ paths: post: tags: + - TI-M Pro - contactManagement description: "Creates the setting for the contact." operationId: createContactSetting @@ -1453,6 +1541,7 @@ paths: put: tags: + - TI-M Pro - contactManagement description: "Updates the setting for the contact." operationId: updateContactSetting @@ -1484,6 +1573,7 @@ paths: get: tags: + - TI-M Pro - contactManagement description: "Returns the contacts with invite settings." operationId: getContact @@ -1499,6 +1589,7 @@ paths: delete: tags: + - TI-M Pro - contactManagement description: "Deletes the setting for the contact {mxid}." operationId: deleteContactSetting @@ -1520,6 +1611,8 @@ paths: - $ref: "#/components/parameters/transactionIdHeader" post: tags: + - TI-M Pro + - TI-M_ePA - media description: "Uploads a file and returns its file-id" operationId: postMediaFile @@ -1552,6 +1645,8 @@ paths: - $ref: "#/components/parameters/fileId" get: tags: + - TI-M Pro + - TI-M_ePA - media description: "Returns a previously uploaded file with given id" operationId: getMediaFile @@ -1570,6 +1665,8 @@ paths: delete: tags: + - TI-M Pro + - TI-M_ePA - media description: "Deletes a previously uploaded file with given id" operationId: deleteMediaFile