review: contact information statt contact

CHANGELOG.md

@@ -22,11 +22,8 @@ Der Aufbau & Umfang von Destination-Objekten hat sich geändert:
 - Das Attribut `publicOrganization` entfällt, weil
     - nur Kontaktinformationen für den Fall von technischen Problemen erfasst und hierbei so wenig Informationen wie
       möglich gespeichert werden sollen.
-    - Der Name der Organisation ist als Attribut für eine bessere Zuordnung zu `contact` gewandert.
-- Das Attribut `technicalContact` wird umbenannt zu `contact`
-- Das Attribut `contact` wurde angepasst, weil
-    - nur Kontaktinformationen für den Fall von technischen Problemen erfasst
-    - und hierbei so wenig Informationen wie möglich gespeichert werden sollen.
+    - Der Name der Organisation ist als Attribut für eine bessere Zuordnung zu `contactInformation` unter `legalName` gewandert.
+- Das Attribut `technicalContact` wird umbenannt zu `contactInformation` und inhaltlich wie im Beispiel unten geändert
 - Die Attribute `callback` und `callbackURI` wurden zusammengeführt,
     - um die Struktur flacher zu gestalten,
     - und weil neben `callbackURI` keine anderen Attribute angeordnet sind.
@@ -41,11 +38,12 @@ Der Aufbau & Umfang von Destination-Objekten hat sich geändert:
 
 ```json
 {
-  "contact": {
-    "firstName": "Max",
-    "lastName": "Mustermann",
+  "contactInformation": {
+    "legalName": "Max",
+    "address": "Mustermann",
+    "phone": "+49170123456789",
     "email": "max@mustermann.not",
-    "organizationName": "Musterorganisation"
+    "unit": "Musterabteilung XYZ"
   },
   "schemas": [
     {

spec/examples/create-destination.yml

 value:
-  contact:
-    firstName: Max
-    lastName: Mustermann
+  contactInformation:
+    legalName: Max
+    address: Musterstr. 31, 10000 Berlin, Deutschland
+    phone: +49170123456789
     email: max@mustermann.not
-    organizationName: Musterorganisation
+    unit: Department XYZ
   schemas:
     - mimeType: application/json
       schemaSource: none

spec/examples/destination-list.yml

@@ -9,9 +9,12 @@ value:
         keys:
           - kty: RSA
             kid: my-key-id-0xfff
-      contact:
+      contactInformation:
+        legalName: Max
+        address: Musterstr. 31, 10000 Berlin, Deutschland
+        phone: +49170123456789
         email: max@mustermann.not
-        organizationName: Musterorganisation
+        unit: Department XYZ
       callback: 'http://127.0.0.1:4010/voluptas'
     - destinationId: 2f59b8c6-3206-4734-aa21-a7b2a4d92f7a
       schemas:
@@ -27,7 +30,10 @@ value:
         keys:
           - kty: RSA
             kid: my-key-id-0xeee
-      contact:
+      contactInformation:
+        legalName: Max
+        address: Musterstr. 31, 10000 Berlin, Deutschland
+        phone: +49170123456789
         email: max@mustermann.not
-        organizationName: Musterorganisation
+        unit: Department XYZ
       callback: 'http://127.0.0.1:4010/voluptas'

spec/examples/destination.yml

@@ -8,7 +8,10 @@ value:
     keys:
       - kty: RSA
         kid: my-key-id-0xfff
-  contact:
+  contactInformation:
+    legalName: Max
+    address: Musterstr. 31, 10000 Berlin, Deutschland
+    phone: +49170123456789
     email: max@mustermann.not
-    organizationName: Musterorganisation
+    unit: Department XYZ
   callback: 'http://127.0.0.1:4010/voluptas'

spec/examples/update-destination.yml

 value:
-  contact:
-    firstName: Max
-    lastName: Mustermann
+  contactInformation:
+    legalName: Max
+    address: Musterstr. 31, 10000 Berlin, Deutschland
+    phone: +49170123456789
     email: max@mustermann.not
-    organizationName: Musterorganisation
+    unit: Department XYZ
   schemas:
     - mimeType: application/json
       schemaSource: none

spec/schemas/contact-information.yml

+title: Kontakt
+description: Angaben zum Ansprechpartner des Zustellpunktes
+type: object
+additionalProperties: false
+required:
+  - legalName
+  - address
+  - phone
+  - email
+properties:
+  legalName:
+    type: string
+    description: Juristischer Name der verantwortlichen Organisation
+  address:
+    type: string
+    description: Adresse der verantwortlichen Organisation
+  phone:
+    type: string
+    description: Telefonnummer der verantwortlichen Stelle
+  email:
+    type: string
+    description: Funktionspostfachadresse der verantwortlichen Stelle. Falls nicht vorhanden, kann auch eine personalisierte Adresse des Supportverantwortlichen eingetragen werden.
+  unit:
+    type: string
+    description: Verantwortliche Untereinheit (Abteilung, Referat, etc.) der Organisation. Kann zur Vereinfachung von Klärungsfragen angegeben werden.

spec/schemas/contact.yml

-title: Kontakt
-description: Angaben zum Ansprechpartner des Zustellpunktes
-type: object
-additionalProperties: false
-required:
-  - firstName
-  - lastName
-  - email
-  - organizationName
-properties:
-  firstName:
-    type: string
-    description: Vorname des Ansprechpartners
-  lastName:
-    type: string
-    description: Nachname des Ansprechpartners
-  email:
-    type: string
-    description: Dauerhaft erreichbares Funktionspostfach zur elektronischen Kommunikation
-  organizationName:
-    type: string
-    description: Name der verantwortlichen Organisation

spec/schemas/create-destination.yml

@@ -3,14 +3,14 @@ description: 'Notwendige Struktur, um einen Zustellpunkt zu hinterlegen.'
 type: object
 additionalProperties: false
 required:
-  - contact
+  - contactInformation
   - schemas
   - callback
   - encryptionKid
   - keys
 properties:
-  contact:
-    $ref: './contact.yml'
+  contactInformation:
+    $ref: './contact-information.yml'
   schemas:
     uniqueItems: true
     minItems: 1

spec/schemas/destination.yml

@@ -6,7 +6,7 @@ required:
   - schemas
   - encryptionKid
   - publicKeys
-  - contact
+  - contactInformation
   - callback
 properties:
   destinationId:
@@ -29,8 +29,8 @@ properties:
   # signingKid ist nicht nötig, da diese in einer signierten Nachricht enthalten ist.
   publicKeys:
     $ref: './jwks.yml'
-  contact:
-    $ref: './contact.yml'
+  contactInformation:
+    $ref: './contact-information.yml'
   callback:
     type: string
     minLength: 1

spec/schemas/update-destination.yml

@@ -3,14 +3,14 @@ description: 'Struktur mit Attributen, die aktualisiert werden sollen.'
 type: object
 additionalProperties: false
 required:
-  - contact
+  - contactInformation
   - schemas
   - callback
   - encryptionKid
   - publicKeys
 properties:
-  contact:
-    $ref: './contact.yml'
+  contactInformation:
+    $ref: './contact-information.yml'
   schemas:
     uniqueItems: true
     minItems: 1

spec/zustelldienst.yml

@@ -64,8 +64,8 @@ components:
       $ref: './schemas/application-state.yml'
     Attachment:
       $ref: './schemas/attachment.yml'
-    Contact:
-      $ref: './schemas/contact.yml'
+    ContactInformation:
+      $ref: './schemas/contact-information.yml'
     CreateApplication:
       $ref: './schemas/create-application.yml'
     CreateAttachment: