Merge pull request #116 from europace/publish/09-08-24_10-45-43

Release 3.0.2 - Add description to deprecated field

angebote-openapi.json

@@ -9,7 +9,7 @@
       "url" : "https://developer.europace.de",
       "email" : "[email protected]"
     },
-    "version" : "3.0.1"
+    "version": "3.0.2"
   },
   "externalDocs" : {
     "url" : "https://docs.api.europace.de/baufinanzierung/angebote/angebote-api/"
@@ -1876,6 +1876,9 @@
               }
             }
           },
+          "204": {
+            "description": "Basierend auf dem Parameter gibt es keinen zurückzugebenden Inhalt."
+          },
           "200" : {
             "description" : "Die Ermittlung wurde erzeugt und ist maximal eine Stunde unter der Url im 'location' Header abrufbar.",
             "content" : {
@@ -1886,9 +1889,6 @@
               }
             }
           },
-          "204" : {
-            "description" : "Basierend auf dem Parameter gibt es keinen zurückzugebenden Inhalt."
-          },
           "401" : {
             "description" : "Unauthorized",
             "content" : {
@@ -2013,22 +2013,22 @@
           }
         } ],
         "responses" : {
-          "404" : {
-            "description" : "Not Found",
+          "200" : {
+            "description" : "Die Ergebnisliste wurde gefunden.",
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/Error"
+                  "$ref" : "#/components/schemas/Ergebnisliste"
                 }
               }
             }
           },
-          "200" : {
-            "description" : "Die Ergebnisliste wurde gefunden.",
-            "content" : {
-              "application/json" : {
-                "schema" : {
-                  "$ref" : "#/components/schemas/Ergebnisliste"
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
                 }
               }
             }
@@ -5733,6 +5733,7 @@
         "properties" : {
           "energieEffizienzAusweisTyp" : {
             "type" : "string",
+            "description": "Das Feld ist Deprecated und wird bis zur Löschung als Fallback für 'ausweisTyp' benutzt. Zur Angabe des Energieausweistyps dient das Feld 'ausweisTyp'. ",
             "deprecated" : true,
             "enum" : [ "ENDENERGIEBEDARF", "ENDENERGIEVERBRAUCH" ]
           },

angebote-openapi.yaml

@@ -7,7 +7,7 @@ info:
     name: Europace AG
     url: https://developer.europace.de
     email: [email protected]
-  version: 3.0.1
+  version: 3.0.2
 externalDocs:
   url: https://docs.api.europace.de/baufinanzierung/angebote/angebote-api/
 servers:
@@ -1246,16 +1246,16 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        "204":
+          description: Basierend auf dem Parameter gibt es keinen zurückzugebenden
+            Inhalt.
         "200":
           description: Die Ermittlung wurde erzeugt und ist maximal eine Stunde unter
             der Url im 'location' Header abrufbar.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Ergebnisliste'
-        "204":
-          description: Basierend auf dem Parameter gibt es keinen zurückzugebenden
-            Inhalt.
         "401":
           description: Unauthorized
           content:
@@ -1339,18 +1339,18 @@ paths:
           pattern: "^[A-Z0-9]{6}"
           type: string
       responses:
-        "404":
-          description: Not Found
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
         "200":
           description: Die Ergebnisliste wurde gefunden.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Ergebnisliste'
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
         "401":
           description: Unauthorized
           content:
@@ -4603,6 +4603,9 @@ components:
       properties:
         energieEffizienzAusweisTyp:
           type: string
+          description: 'Das Feld ist Deprecated und wird bis zur Löschung als Fallback
+            für ''ausweisTyp'' benutzt. Zur Angabe des Energieausweistyps dient das
+            Feld ''ausweisTyp''. '
           deprecated: true
           enum:
           - ENDENERGIEBEDARF