Merge pull request #2 from hypoport/v_0.3.0

0.3.0

swagger.yaml

@@ -1,7 +1,7 @@
 swagger: '2.0'
 info:
   description: API für Ereignisse in BaufiSmart-Vorgängen.
-  version: '0.2.0'
+  version: '0.3.0'
   title: Ereignisse API
   contact:
     name: Europace AG
@@ -101,30 +101,18 @@ definitions:
         type: "string"
       externePartnerId:
         type: "string"
-      _links:
-        type: object
-        properties:
-          partner:
-            $ref: "#/definitions/Relation"
-            description: URL zum Partner
-          kontaktdaten:
-            $ref: "#/definitions/Relation"
-            description: URL zu den Kontaktdaten
-          avatar:
-            $ref: "#/definitions/Relation"
-            description: URL zum Avatar Icon
     title: "Partner"
 
   Ereignis:
     type: object
     properties:
-      vorgangsnummer:
+      vorgangsNummer:
         type: string
         description: Die Vorgangsnummer
       meldung:
         type: string
         description: Beschreibung des Ereignisses
-      ereignistyp:
+      typ:
         type: string
         enum:
         - DOKUMENTE
@@ -150,15 +138,27 @@ definitions:
     properties:
       name:
         type: string
+      geloescht:
+        type: boolean
+        description: |
+          Wenn ein Dokument nach DSGVO-Richtlinien gelöscht wurde, dann wird der Wert auf true gesetzt.
+          In diesem Fall werden keine Links ausgegeben. Für nicht gelöschte Dokumente ist dieser Wert nicht gesetzt.
+
       _links:
         $ref: "#/definitions/DokumentenLink"
 
   DokumentenLink:
     type: object
     properties:
+      self:
+        $ref: "#/definitions/Relation"
+        description: Self relation
       download:
         $ref: "#/definitions/Relation"
-
+        description: URL zum Runterladen des Dokuments (intern)
+      publicDownload:
+        $ref: "#/definitions/Relation"
+        description: URL zum Runterladen des Dokuments (öffentlich)
   Relation:
     type: object
     properties: