Skip to content

Commit df1e8a2

Browse files
authored
new apis delcared (#211)
1 parent a8d0c26 commit df1e8a2

File tree

2 files changed

+62
-4
lines changed

2 files changed

+62
-4
lines changed

README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ image::meta/gematik_logo.svg[gematik,width="70%"]
1616

1717
image:https://img.shields.io/badge/Release%20Notes-v1.1.1-red?style=plastic&logo=github&logoColor=red[link="ReleaseNotes.md"] +
1818
image:https://img.shields.io/badge/I_TiMessengerContactManagement-v1.0.1-blue?style=plastic&logo=github&logoColor=blue[link=/src/openapi/TiMessengerContactManagement.yaml"] +
19-
image:https://img.shields.io/badge/TiMessengerTestDriver-v0.9.0-purple?style=plastic&logo=github&logoColor=purple[link="/src/openapi/TiMessengerTestTreiber.yaml"]
20-
image:https://img.shields.io/badge/TiMessengerTestSuite-v0.9.0-purple?style=plastic&logo=github&logoColor=purple[link="https://github.com/gematik/TI-Messenger-Testsuite"] +
19+
image:https://img.shields.io/badge/TiMessengerTestDriver-v0.9.1-purple?style=plastic&logo=github&logoColor=purple[link="/src/openapi/TiMessengerTestTreiber.yaml"]
20+
image:https://img.shields.io/badge/TiMessengerTestSuite-v0.9.1-purple?style=plastic&logo=github&logoColor=purple[link="https://github.com/gematik/TI-Messenger-Testsuite"] +
2121
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"]
2222
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"]
2323
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"] +

src/openapi/TiMessengerTestTreiber.yaml

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ openapi: 3.0.3
22
info:
33
title: TiMessengerTestDriver
44
description: REST interface to automate the test of a TI-Messenger client implementation.
5-
version: 0.9.0
5+
version: 0.9.1
66
contact:
77
name: gematik GmbH
88
@@ -39,6 +39,8 @@ tags:
3939
description: Account operations
4040
- name: login/logout
4141
description: login / logout an account
42+
- name: keyExchange
43+
description: export / import recoveryKey
4244
- name: orgAdminFhirOrganization
4345
description: OrgAdmin operations that could be operated on organizations in FHIR-VZD
4446
- name: orgAdminFhirHealthcareService
@@ -259,6 +261,51 @@ paths:
259261
default:
260262
$ref: "#/components/responses/DefaultResponse"
261263

264+
/devices/{deviceId}/account/key:
265+
parameters:
266+
- $ref: "#/components/parameters/deviceId"
267+
- $ref: "#/components/parameters/transactionIdHeader"
268+
269+
get:
270+
tags:
271+
- keyExchange
272+
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!"
273+
operationId: keyExport
274+
responses:
275+
"200":
276+
description: "information about the exported key"
277+
content:
278+
application/json:
279+
schema:
280+
$ref: "#/components/schemas/matrixKeyInfo"
281+
"400":
282+
$ref: "#/components/responses/BadRequest"
283+
"401":
284+
$ref: "#/components/responses/Unauthorized"
285+
default:
286+
$ref: "#/components/responses/DefaultResponse"
287+
288+
post:
289+
tags:
290+
- keyExchange
291+
description: "Imports secret key and execute synchronization"
292+
operationId: keyImport
293+
requestBody:
294+
content:
295+
application/json:
296+
schema:
297+
$ref: "#/components/schemas/matrixKeyInfo"
298+
responses:
299+
"204":
300+
description: "sync successful"
301+
"400":
302+
$ref: "#/components/responses/BadRequest"
303+
"401":
304+
$ref: "#/components/responses/Unauthorized"
305+
default:
306+
$ref: "#/components/responses/DefaultResponse"
307+
308+
262309
/devices/{deviceId}/fhir/fhirAuthenticate:
263310
parameters:
264311
- $ref: "#/components/parameters/deviceId"
@@ -1970,6 +2017,17 @@ components:
19702017
type: string
19712018
example: "@someone:gematik.de"
19722019

2020+
matrixKeyInfo:
2021+
description: "Information about recoveryKey"
2022+
type: object
2023+
properties:
2024+
mxId:
2025+
$ref: "#/components/schemas/MxId"
2026+
key:
2027+
type: string
2028+
description: "The actual key"
2029+
example: "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz"
2030+
19732031
Messages:
19742032
description: "A list of messages and its properties"
19752033
type: array
@@ -2505,7 +2563,7 @@ components:
25052563
daysOfWeek:
25062564
type: array
25072565
description: "Short term of day"
2508-
example: ["mon", "tue", "wed"]
2566+
example: [ "mon", "tue", "wed" ]
25092567
items:
25102568
type: string
25112569
availableStartTime:

0 commit comments

Comments
 (0)