version: 1.3.6

gematik · Oct 17, 2024 · 02fe9af · 02fe9af
1 parent c193834
commit 02fe9af
Showing 1 changed file with 32 additions and 11 deletions.
diff --git a/src/openapi/I_VZD_TIM_Provider_Services.yaml b/src/openapi/I_VZD_TIM_Provider_Services.yaml
@@ -3,7 +3,13 @@ info:
   title: I_VZD_TIM_Provider_Services
   description: REST interface to retrieve the TI-Messenger federation list and to administrate the TI-Messenger domains.
 
-  version: 1.3.4
+  version: 1.3.6
+
+    # version 1.3.6
+    # - /components/schemas/Domain contains redirectDomains
+
+    # version 1.3.5
+    #  - getFederationList - Parameter sigAlg added for support of BP and NIST signatures
 
     # version 1.3.4
     #  - Schema InfoObject: - Attributs termsOfService, contact & license removed
@@ -61,9 +67,9 @@ info:
     # version 1.1.0
     # - removed operation getPASSporTCertificates.
     # - new REST crud operations for TI-Messenger domains
-    # version 1.0.2
-    # - Operation getPASSporTCertificates returns now an array of certificates in pem format
-    # version 1.0.1
+  # version 1.0.2
+  # - Operation getPASSporTCertificates returns now an array of certificates in pem format
+  # version 1.0.1
   # - added hashAlgorithm to schemaFederationList
   # initiale Version
 
@@ -131,13 +137,23 @@ paths:
           description: Version of the known federation list
           schema:
             type: integer
+        - name: sigAlg
+          in: query
+          description: Signature algorithm of the federation list
+            The federation list will be signed according to the selected value of this parameter.
+          schema:
+            type: string
+            enum:
+              - BP256R1 # Brainpool
+              - ES256   # Elliptic Curve Digital Signature Algorithm with the P-256 curve
+            default: BP256R1
 
       responses:
         200:
           description: OK
-            # The federation list.
-            # The JWS signature has to be checked by the client.
-            # The structure of the federation list is defined
+          # The federation list.
+          # The JWS signature has to be checked by the client.
+          # The structure of the federation list is defined
           # in GitHub /src/schema/FederationList.json
           content:
             application/octet-stream:
@@ -199,7 +215,7 @@ paths:
             application/json:
               schema:
                 type: string
-                enum: [org, pract, orgPract, none]
+                enum: [ org, pract, orgPract, none ]
                 example: org
                 description: |
                   Returns in which part of the directory the MXID is located:
@@ -257,7 +273,7 @@ paths:
 
         400:
           description: Bad Request
-            # Examples for errors:
+          # Examples for errors:
           # message "organization which belongs to the telematikID is not active"
           content:
             application/json:
@@ -516,12 +532,17 @@ components:
             type: integer
           minItems: 1
           uniqueItems: true
-          example: [108433248, 104127692]
+          example: [ 108433248, 104127692 ]
         timProvider:
           description: The Zuweisungsgruppe im TI-ITSM-System of the TI-Messenger Provider, who added the domain
           type: string
           readOnly: true
-
+        redirectDomains:
+          description: Zu berücksichtigende redirect-Domains, verarbeitet durch den proxy-Server
+          type: array
+          items:
+            type: string
+          example: [ domain1.fr, domain7.de ]
     Error:
       type: object
       properties: