Merge branch 'destination-specifies-metadata-schema-version' into 'main'

Destinations need to specify a list of supported versions of the metadata schema

Closes #97

See merge request fit-connect/api!113

spec/examples/create-destination.yaml

@@ -33,3 +33,6 @@ value:
     e: AQAB
   replyChannel:
     deMail:
+  metadataVersions:
+    - 1.0.1
+    - 2.1.1

spec/examples/destination-any.yaml

@@ -17,3 +17,6 @@ value:
     unit: Department XYZ
   callback:
     url: 'https://fachverfahren.beispielstadt.example.org/callbacks/fit-connect'
+  metadataVersions:
+    - 1.0.1
+    - 2.1.2

spec/examples/destination-list.yaml

@@ -27,6 +27,9 @@ value:
         unit: Department XYZ
       callback:
         url: 'https://fachverfahren.beispielstadt.example.org/callbacks/fit-connect'
+      metadataVersions:
+        - 1.0.1
+        - 2.1.2
     - destinationId: 2f59b8c6-3206-4734-aa21-a7b2a4d92f7a
       services:
         - identifier: "urn:de:fim:leika:leistung:99010003001006"
@@ -44,3 +47,6 @@ value:
         unit: Department XYZ
       callback:
         url: 'https://fachverfahren.beispielstadt.example.org/callbacks/fit-connect'
+      metadataVersions:
+        - 1.0.1
+        - 2.1.2

spec/examples/destination-private.yaml

@@ -17,3 +17,6 @@ value:
     unit: Department XYZ
   callback:
     url: 'https://fachverfahren.beispielstadt.example.org/callbacks/fit-connect'
+  metadataVersions:
+    - 1.0.1
+    - 2.1.2

spec/examples/destination-public.yaml

@@ -11,3 +11,6 @@ value:
   encryptionKid: e4142167-7f03-4d4f-a8c9-c7ecc78f55f8
   replyChannels:
     elster: {}
+  metadataVersions:
+    - 1.0.0
+    - 2.1.2

spec/examples/update-destination.yaml

@@ -17,3 +17,6 @@ value:
     url: 'https://fachverfahren.beispielstadt.example.org/callbacks/fit-connect'
     secret: insecure_unsafe_qHScgrg_kP-R31jHUwp3GkVkGJolvBchz65b74Lzue0
   encryptionKid: c66e4423-e28d-4a1f-911d-818f9ab60221
+  metadataVersions:
+    - 1.0.1
+    - 2.1.2

spec/schemas/create-destination.yaml

@@ -7,6 +7,7 @@ required:
   - encryptionKid
   - encryptionPublicKey
   - signingPublicKey
+  - metadataVersions
 properties:
   contactInformation:
     $ref: './contact-information.yaml'
@@ -31,3 +32,5 @@ properties:
     $ref: './jwk.yaml'
   replyChannels:
     $ref: './reply-channels.yaml'
+  metadataVersions:
+    $ref: './supported-metadata-versions.yaml'

spec/schemas/destination-public.yaml

@@ -5,6 +5,7 @@ required:
   - destinationId
   - services
   - encryptionKid
+  - metadataVersions
 properties:
   destinationId:
     type: string
@@ -26,3 +27,5 @@ properties:
     description: 'Key-ID des Verschlüsselungsschlüssels der Destination. Zu finden in der Subressource `keys/<keyId>`.'
   replyChannels:
     $ref: './reply-channels.yaml'
+  metadataVersions:
+    $ref: './supported-metadata-versions.yaml'

spec/schemas/patch-destination.yaml

@@ -20,3 +20,5 @@ properties:
     description: 'Schlüssel-Id des Verschlüsselungsschlüssels des Zustellpunktes.'
   replyChannels:
     $ref: './reply-channels.yaml'
+  metadataVersions:
+    $ref: './supported-metadata-versions.yaml'

spec/schemas/supported-metadata-versions.yaml

+title: Liste unterstützter Metadatenschemataversionen
+description: Eine Liste von semver kompatiblen Versionen des Metadatenschemas.
+type: array
+uniqueItems: true
+minItems: 1
+items:
+  type: string
+  pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$

spec/schemas/update-destination.yaml

@@ -5,6 +5,7 @@ required:
   - contactInformation
   - services
   - encryptionKid
+  - metadataVersions
 properties:
   contactInformation:
     $ref: './contact-information.yaml'
@@ -24,3 +25,5 @@ properties:
     description: 'Schlüssel-Id des Verschlüsselungsschlüssels des Zustellpunktes.'
   replyChannels:
     $ref: './reply-channels.yaml'
+  metadataVersions:
+    $ref: './supported-metadata-versions.yaml'

spec/submission-api.yaml

@@ -149,6 +149,8 @@ components:
       $ref: './schemas/reply-channels.yaml'
     Callback:
       $ref: './schemas/callback-url.yaml'
+    SupportedMetadataVersions:
+      $ref: './schemas/supported-metadata-versions.yaml'
     CreateCallback:
       $ref: './schemas/create-callback.yaml'