From d568fc865a26b26ac01a8411df819a1113f8222f Mon Sep 17 00:00:00 2001
From: dkoeni <116151702+dkoeni@users.noreply.github.com>
Date: Tue, 26 Mar 2024 21:01:52 +0100
Subject: [PATCH 01/39] Update lint-openapi.yaml

---
 .github/workflows/lint-openapi.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/lint-openapi.yaml b/.github/workflows/lint-openapi.yaml
index a10e982..8d671e8 100644
--- a/.github/workflows/lint-openapi.yaml
+++ b/.github/workflows/lint-openapi.yaml
@@ -11,6 +11,6 @@ on:
 
 jobs:
   openapi-lint:
-    uses: swissfintechinnovations/.github/.github/workflows/reusable-lint-openapi-workflow.yaml@main
+    uses: swissfintechinnovations/.github/.github/workflows/reusable-lint-openapi-workflow.yaml@naming-conventions-part-1
     with:
-      filenames: ${{ github.event.inputs.filenames || '*.yaml' }}
\ No newline at end of file
+      filenames: ${{ github.event.inputs.filenames || '*.yaml' }}

From 9202e62a0b44a1ab0a1da09c976e8c2bbf96f4ea Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Sun, 26 May 2024 11:46:43 +0200
Subject: [PATCH 02/39] Update mortgageAPI.yaml

Update due to finding of naming conventions check
---
 mortgageAPI.yaml | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index dc0ba37..230e3ac 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1540,7 +1540,7 @@ components:
           description: amount given with fractional digits, the separator is a dot
           type: string
           pattern: '^-?\d{1,14}(?:\.\d{1,3})?$'
-          example: 235.45
+          example: `235.45`
 
     # ---- Address compliant to payment address (b.Link & ISO20022)----
     structuredAddress:
@@ -1559,11 +1559,11 @@ components:
         buildingNumber:
           type: string
           maxLength: 16
-          example: 24
+          example: 24A
         postCode:
           type: string
           maxLength: 16
-          example: 2501
+          example: CH-2501
         townName:
           type: string
           maxLength: 35
@@ -1734,9 +1734,9 @@ components:
             luxusFlag:
               type: string
               enum:
-                - 0
-                - 0.5
-                - 1.0
+                - `0
+                - `0.5
+                - `1.0
               description: 'Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: 0 = No, 0.5 = Partially, 1 = Yes. Proposed Mapping of WuP-Values: 1.0-4.0 => 0 (No) / 4.1-4.5 => 0.5 (Partially) / 4.6-5.0 = >1.0 (Yes).'
               example: 0
             constructionQualityType:
@@ -2138,6 +2138,7 @@ components:
           description: Date of public notarization
         remarks:
           type: string
+          example: We need an example for such a remark
         propertyLinks:
           description: A list of links to external resources related to the property
           type: array
@@ -2150,8 +2151,10 @@ components:
       properties:
         EGRID:
           type: string
+          example: CH480928387782
         EGID:
           type: string
+          example: `191092250`
 
     Mortgage:
       description: All relevant information regarding a specific mortgage
@@ -2852,6 +2855,7 @@ components:
                     $ref: '#/components/schemas/Amount'
                   remark:
                     type: string
+                    example: We need an example for such a remark
                   incomeProvider:
                     description: Income provider for each income or cost position can be transferred.
                     type: string
@@ -2877,6 +2881,7 @@ components:
                     $ref: '#/components/schemas/Amount'
                   remark:
                     type: string
+                    example: We need an example for such a remark
                   liabilityProvider:
                     description: Name of the liability provider or creditor.
                     type: string
@@ -2912,7 +2917,7 @@ components:
                     enum:
                       - single_family_house
                       - condominium
-                      - vacation_house,
+                      - vacation_house
                       - vacation_condominium
                       - agricultural_farm
                       - 2or3_family_house

From 9cc3e97e2681f95ca3078a776235d2ed4d521218 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Mon, 27 May 2024 17:20:26 +0200
Subject: [PATCH 03/39] Update mortgageAPI.yaml

Update due to naming conventions
---
 mortgageAPI.yaml | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 230e3ac..d9446a7 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1540,7 +1540,7 @@ components:
           description: amount given with fractional digits, the separator is a dot
           type: string
           pattern: '^-?\d{1,14}(?:\.\d{1,3})?$'
-          example: `235.45`
+          example: '235.45'
 
     # ---- Address compliant to payment address (b.Link & ISO20022)----
     structuredAddress:
@@ -1734,9 +1734,9 @@ components:
             luxusFlag:
               type: string
               enum:
-                - `0
-                - `0.5
-                - `1.0
+                - '0'
+                - '0.5'
+                - '1.0'
               description: 'Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: 0 = No, 0.5 = Partially, 1 = Yes. Proposed Mapping of WuP-Values: 1.0-4.0 => 0 (No) / 4.1-4.5 => 0.5 (Partially) / 4.6-5.0 = >1.0 (Yes).'
               example: 0
             constructionQualityType:
@@ -2154,7 +2154,7 @@ components:
           example: CH480928387782
         EGID:
           type: string
-          example: `191092250`
+          example: '191092250'
 
     Mortgage:
       description: All relevant information regarding a specific mortgage

From d5dbb3fdd1bea7b9ac28fa8fe3514f38f6a084ad Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Mon, 27 May 2024 18:05:11 +0200
Subject: [PATCH 04/39] Update mortgageAPI.yaml

Update due to naming conventions
---
 mortgageAPI.yaml | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index d9446a7..27cff26 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -2193,6 +2193,7 @@ components:
           $ref: '#/components/schemas/Date'
         interestRate:
           type: string
+          example: '1.4'
         interestRateType:
           type: string
           example: libor
@@ -2203,6 +2204,7 @@ components:
             - fixed
         interestBasis:
           type: string
+          example: We need an example
         durationType:
           type: integer
           description: The duration in years.
@@ -2211,6 +2213,7 @@ components:
           example: 5
         prolongable:
           type: boolean
+          example: 0
         propertyObjects:
           type: array
           items:
@@ -2384,6 +2387,7 @@ components:
           $ref: '#/components/schemas/AmountRange'
         amortization:
           type: integer
+          example: 1000
         amortizations:
           $ref: '#/components/schemas/Amortizations'
 
@@ -2636,6 +2640,7 @@ components:
           $ref: '#/components/schemas/Date'
         duration:
           type: integer
+          example: 2
           minimum: 1
           maximum: 20
         interest:
@@ -3001,6 +3006,7 @@ components:
           description: The amount of the sum insured in life insurance
         remark:
           type: string
+          example: We need an example for such a remark
         assetProvider:
           $ref: '#/components/schemas/AssetProvider'
 
@@ -3228,12 +3234,12 @@ components:
           description: min amount given with fractional digits, the separator is a dot
           type: string
           pattern: '^-?\d{1,14}(?:\.\d{1,3})?$'
-          example: 1000000
+          example: '1000000'
         maxContent:
           description: max amount given with fractional digits, the separator is a dot
           type: string
           pattern: '^-?\d{1,14}(?:\.\d{1,3})?$'
-          example: 5000000
+          example: '5000000'
 
     Interest:
       description: The current rate and optionally the referred base

From d5afaebd2dc20321817d339fa34899222a7a2dc9 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Mon, 27 May 2024 18:29:26 +0200
Subject: [PATCH 05/39] Update mortgageAPI.yaml

Update due to naming conventions
---
 mortgageAPI.yaml | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 27cff26..6be73af 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -476,6 +476,7 @@ paths:
                 properties:
                   status:
                     type: string
+                    exmaple: we need an example
         '400':
           $ref: '#/components/responses/standard400'
         '401':
@@ -517,6 +518,7 @@ paths:
                   reason:
                     description: The reason for rejecting an application.
                     type: string
+                    exmaple: We need an exmaple
         '400':
           $ref: '#/components/responses/standard400'
         '401':
@@ -638,6 +640,7 @@ paths:
                 properties:
                   status:
                     type: string
+                    example: we need an exmaple
         '400':
           $ref: '#/components/responses/standard400'
         '401':
@@ -774,6 +777,7 @@ paths:
                       properties:
                         status:
                           type: string
+                          example: pending
                           enum:
                             - accepted
                             - rejected
@@ -828,6 +832,7 @@ paths:
                 properties:
                   status:
                     type: string
+                    example: we need an example
         '400':
           $ref: '#/components/responses/standard400'
         '401':
@@ -959,6 +964,7 @@ paths:
                   financingRequestId:
                     type: string
                     format: uuid
+                    example: 550e8400-e29b-41d4-a716-446655440000
                   documents:
                     type: array
                     items:
@@ -1181,6 +1187,7 @@ paths:
                   offerId:
                     type: string
                     format: uuid
+                    example: 550e8400-e29b-41d4-a716-446655440000
                   documents:
                     type: array
                     items:
@@ -2253,6 +2260,7 @@ components:
             $ref: '#/components/schemas/OfferItem'
         offerType:
           type: string
+          exmaple: binding
           enum:
             - binding
             - indicative
@@ -2547,7 +2555,7 @@ components:
           type: string
           minLength: 4
           maxLength: 13
-          example: +41443343456
+          example: '+41443343456'
         email:
           description: The email address on which the advertiser can be contacted
           type: string
@@ -2719,6 +2727,7 @@ components:
           $ref: '#/components/schemas/Date'
         requestOfferType:
           type: string
+          example: binding  
           enum:
             - binding
             - indicative

From 3c5791d0f7d307bb96851268b9ac77a89130fa74 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Mon, 27 May 2024 18:33:35 +0200
Subject: [PATCH 06/39] Update mortgageAPI.yaml

Naming convention checks
---
 mortgageAPI.yaml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 6be73af..ebb7af6 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -476,7 +476,7 @@ paths:
                 properties:
                   status:
                     type: string
-                    exmaple: we need an example
+                    example: we need an example
         '400':
           $ref: '#/components/responses/standard400'
         '401':
@@ -518,7 +518,7 @@ paths:
                   reason:
                     description: The reason for rejecting an application.
                     type: string
-                    exmaple: We need an exmaple
+                    example: We need an example
         '400':
           $ref: '#/components/responses/standard400'
         '401':
@@ -2260,7 +2260,7 @@ components:
             $ref: '#/components/schemas/OfferItem'
         offerType:
           type: string
-          exmaple: binding
+          example: binding
           enum:
             - binding
             - indicative

From 4bd8c2598edd714eb246758442871469ef376a10 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Mon, 27 May 2024 18:40:35 +0200
Subject: [PATCH 07/39] Update lint-openapi.yaml

changed from part 1 to part 2 for naming convention check
---
 .github/workflows/lint-openapi.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/lint-openapi.yaml b/.github/workflows/lint-openapi.yaml
index 8d671e8..bb97d15 100644
--- a/.github/workflows/lint-openapi.yaml
+++ b/.github/workflows/lint-openapi.yaml
@@ -11,6 +11,6 @@ on:
 
 jobs:
   openapi-lint:
-    uses: swissfintechinnovations/.github/.github/workflows/reusable-lint-openapi-workflow.yaml@naming-conventions-part-1
+    uses: swissfintechinnovations/.github/.github/workflows/reusable-lint-openapi-workflow.yaml@naming-conventions-part-2
     with:
       filenames: ${{ github.event.inputs.filenames || '*.yaml' }}

From 762352be6384b799614bb5cf2d2ded59dc0f66ca Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Tue, 28 May 2024 16:08:14 +0200
Subject: [PATCH 08/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index ebb7af6..f19a90f 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1591,7 +1591,7 @@ components:
     commonResourceCreatedResponse:
       title: Recource created response
       description: Uuid v4 of the created resource
-      example: 20460121-6aff-485b-a61d-6056ecd72bd8
+      example: id: 20460121-6aff-485b-a61d-6056ecd72bd8
       type: object
       required:
         - id
@@ -3420,6 +3420,7 @@ components:
         example: 25
         minimum: 1
 
+#
     cursor:
       name: cursor
       in: query
@@ -3428,6 +3429,7 @@ components:
       schema:
         type: string
         example: cursorIDxyz
+#        
 
     duration:
       name: duration

From 9d795a648084dbdca023ce846e63c7c95e2f3eef Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Tue, 28 May 2024 16:08:50 +0200
Subject: [PATCH 09/39] Update lint-openapi.yaml

---
 .github/workflows/lint-openapi.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/lint-openapi.yaml b/.github/workflows/lint-openapi.yaml
index bb97d15..8d671e8 100644
--- a/.github/workflows/lint-openapi.yaml
+++ b/.github/workflows/lint-openapi.yaml
@@ -11,6 +11,6 @@ on:
 
 jobs:
   openapi-lint:
-    uses: swissfintechinnovations/.github/.github/workflows/reusable-lint-openapi-workflow.yaml@naming-conventions-part-2
+    uses: swissfintechinnovations/.github/.github/workflows/reusable-lint-openapi-workflow.yaml@naming-conventions-part-1
     with:
       filenames: ${{ github.event.inputs.filenames || '*.yaml' }}

From e6f90c76142ac74707bcb678a9cac04d1e8a87ba Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Tue, 28 May 2024 16:12:38 +0200
Subject: [PATCH 10/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index f19a90f..69f8c7a 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -3420,7 +3420,6 @@ components:
         example: 25
         minimum: 1
 
-#
     cursor:
       name: cursor
       in: query
@@ -3428,8 +3427,7 @@ components:
       required: false
       schema:
         type: string
-        example: cursorIDxyz
-#        
+        example: cursorIDxyz      
 
     duration:
       name: duration

From 1d901fb3f223195ee280011c3e20edac55925cee Mon Sep 17 00:00:00 2001
From: dkoeni <116151702+dkoeni@users.noreply.github.com>
Date: Fri, 31 May 2024 11:27:18 +0200
Subject: [PATCH 11/39] update openAPI action reference

---
 .github/workflows/lint-openapi.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/lint-openapi.yaml b/.github/workflows/lint-openapi.yaml
index 8d671e8..ddccd01 100644
--- a/.github/workflows/lint-openapi.yaml
+++ b/.github/workflows/lint-openapi.yaml
@@ -11,6 +11,6 @@ on:
 
 jobs:
   openapi-lint:
-    uses: swissfintechinnovations/.github/.github/workflows/reusable-lint-openapi-workflow.yaml@naming-conventions-part-1
+    uses: swissfintechinnovations/.github/.github/workflows/reusable-lint-openapi-workflow.yaml@main
     with:
       filenames: ${{ github.event.inputs.filenames || '*.yaml' }}

From ddb940ee8de10b2f83881a81cd060eef95b9f861 Mon Sep 17 00:00:00 2001
From: dkoeni <116151702+dkoeni@users.noreply.github.com>
Date: Wed, 5 Jun 2024 17:02:29 +0200
Subject: [PATCH 12/39] fix indentiation error

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 69f8c7a..2d8b092 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1591,7 +1591,7 @@ components:
     commonResourceCreatedResponse:
       title: Recource created response
       description: Uuid v4 of the created resource
-      example: id: 20460121-6aff-485b-a61d-6056ecd72bd8
+      example: 20460121-6aff-485b-a61d-6056ecd72bd8
       type: object
       required:
         - id

From 18766b820ced40c0efc68461d046d5ec4c038d71 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 08:13:22 +0200
Subject: [PATCH 13/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 94 ++++++++++++++++++++++++------------------------
 1 file changed, 47 insertions(+), 47 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 2d8b092..09dc5cf 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -19,21 +19,21 @@ externalDocs:
   url: https://www.common-api.ch
 tags:
   - name: Full Mortgage Cases
-    description: Operatios related to full mortgage cases including the application details
+    description: Operatios related to full mortgage cases including the application details.
   - name: Existing Mortgages
-    description: Operations related with existing mortgages
+    description: Operations related with existing mortgages.
   - name: Mortgage Products and Conditions
-    description: Operations for synchronizing general mortgage product information from an FI
+    description: Operations for synchronizing general mortgage product information from an FI.
   - name: Mortgage Application
-    description: Operations needed to place an application (dossier) for a new mortgage
+    description: Operations needed to place an application (dossier) for a new mortgage.
   - name: Mortgage Financing Request
-    description: Operations for handling financing requests for a specific accepted application (dossier)
+    description: Operations for handling financing requests for a specific accepted application (dossier).
   - name: Mortgage Offers
-    description: Operations for handling the binding offers an FI provides
+    description: Operations for handling the binding offers an FI provides.
   - name: Mortgage Order
-    description: Operations for placing a binding order for a chosen offer
+    description: Operations for placing a binding order for a chosen offer.
   - name: Mortgage Prolongation
-    description: Operations for handling the common special case of prolonging an existing mortgage
+    description: Operations for handling the common special case of prolonging an existing mortgage.
 
 security:
   - ApiKeyAuth: []
@@ -3295,39 +3295,39 @@ components:
   # ---- Global Common Header Parameters ----
   parameters:
     path_caseId:
-      name: caseId
       in: path
-      description: Uuid v4 of a specific existing mortgage case
+      name: caseId
       required: true
       schema:
         type: string
         format: uuid
-        example: bcb5d762-8d28-43a2-9398-393b2e8d56ba
+        example: bcb5d762-8d28-43a2-9398-393b2e8d56ba$
+      description: Uuid v4 of a specific existing mortgage case.
 
     path_mortgageId:
-      name: mortgageId
       in: path
-      description: Uuid v4 of a specific existing mortgage
+      name: mortgageId
       required: true
       schema:
         type: string
         format: uuid
         example: bcb5d762-8d28-43a2-9398-393b2e8d56ba
+      description: Uuid v4 of a specific existing mortgage.
 
     path_productId:
-      name: productId
       in: path
-      description: A product's uuid v4
+      name: productId
       required: true
       schema:
         type: string
         format: uuid
         example: a86dd383-055e-471a-a098-682ae5ef8348
+      description: A product's uuid v4.
 
     path_applicationId:
       name: applicationId
       in: path
-      description: Uuid v4 of the application request
+      description: Uuid v4 of the application request.
       required: true
       schema:
         type: string
@@ -3335,114 +3335,113 @@ components:
         example: 4bf92636-14a0-4511-98e2-acfde576e644
 
     path_documentId:
-      name: documentId
       in: path
-      description: Unique ID (uuid v4) of the document
+      name: documentId
       required: true
       schema:
         type: string
         format: uuid
         example: 7f648f12-c15f-4930-8380-238da5671c37
+      description: Unique ID (uuid v4) of the document.
 
     path_financingRequestId:
-      name: financingRequestId
       in: path
-      description: Uuid v4 of the financing request
+      name: financingRequestId
       required: true
       schema:
         type: string
         format: uuid
         example: 1a75e7fc-f3c3-45a9-9268-ec21c405bbc8
+      description: Uuid v4 of the financing request.
 
     path_offerId:
-      name: offerId
       in: path
-      description: Uuid v4 of the offer
+      name: offerId
       required: true
       schema:
         type: string
         format: uuid
         example: c2fee261-053c-4088-8986-11216f0c9be6
+      description: Uuid v4 of the offer.
 
     path_orderId:
-      name: orderId
       in: path
-      description: Uuid v4 of an order
+      name: orderId
       required: true
       schema:
         type: string
         format: uuid
         example: 91d029b3-ee7a-44c3-ac18-cf621cb128a8
+      description: Uuid v4 of an order.
 
     clientid_in_header:
-      name: X-CorAPI-Client-ID
       in: header
+      name: X-CorAPI-Client-ID
+      required: true
       schema:
         type: string
-      description: 'ID of the client forwarded to the provider. (SCOPE: FI)'
-      required: true
-
+      description: 'ID of the client forwarded to the provider. (SCOPE: FI)'.
+      
     correlation_in_header:
-      name: X-Correlation-ID
       in: header
+      name: X-Correlation-ID
+      required: true
       schema:
         type: string
       description: Unique ID (defined by the caller) which will be reflected back in the response.
-      required: true
-
+      
     agent_in_header:
-      name: User-Agent
       in: header
+      name: User-Agent
+      required: true
       schema:
         type: string
-      description: Name and version of the of the Client software
-      required: true
-
+      description: Name and version of the of the Client software.
+      
     offset:
-      name: offset
       in: query
-      description: Optional parameter for pagination. The number of items to skip before starting to collect the result set.
+      name: offset
       required: false
       schema:
         type: integer
         format: int32
         example: 25
         minimum: 0
+      description: Optional parameter for pagination. The number of items to skip before starting to collect the result set.
 
     limit:
-      name: limit
       in: query
-      description: Optional parameter for pagination. Maximum number of entries to be returned.
+      name: limit
       required: false
       schema:
         type: integer
         format: int32
         example: 25
         minimum: 1
-
+      description: Optional parameter for pagination. Maximum number of entries to be returned.
+      
     cursor:
-      name: cursor
       in: query
-      description: Optional parameter for pagination. An opaque string value used for pagination.
+      name: cursor
       required: false
       schema:
         type: string
-        example: cursorIDxyz      
+        example: cursorIDxyz     
+      description: Optional parameter for pagination. An opaque string value used for pagination.
 
     duration:
-      name: duration
       in: query
-      description: The type of duration (for filtering)
+      name: duration
       schema:
         type: integer
         minimum: 1
         maximum: 20
         example: 10
+      description: The type of duration (for filtering).
 
     language:
-      name: language
       in: query
-      description: Language of Document content
+      name: language
       required: true
       schema:
         type: string
@@ -3452,6 +3451,7 @@ components:
           - it
           - en
         example: fr
+      description: Language of Document content.
 
   # --- Response Headers - used by Standard Responses ---
   headers:

From ca8da80267c1f0d34b994f0e0ff2fb42adeeed35 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 10:19:55 +0200
Subject: [PATCH 14/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 91 +++++++++++++++++++++++++++++-------------------
 1 file changed, 56 insertions(+), 35 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 09dc5cf..df911fc 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1494,48 +1494,50 @@ components:
       type: string
       format: date
       example: 2018-04-13
+      descriptio: Date format.
 
     DateTime:
       type: string
       format: date-time
       example: 2018-04-13T11:11:11Z
+      description: DateTime format.
 
     # ---- Links for Pagination----
-    linksPagination:
+    LinksPagination:
       description: Links (or cursors) returned in the answer of an API call.
       type: object
       properties:
         self:
           type: string
-          description: Link / cursor to the current result set (based on the submitted pagination approach)
+          description: Link / cursor to the current result set (based on the submitted pagination approach).
           example: /mortgage-app/api/v1/products?offset=75&limit=25
         first:
           type: string
-          description: Link / cursor to the first result set (based on the submitted pagination approach)
+          description: Link / cursor to the first result set (based on the submitted pagination approach).
           example: /mortgage-app/api/v1/products?offset=0&limit=25
         previous:
           type: string
-          description: Link / cursor to the previous result set (based on the submitted pagination approach)
+          description: Link / cursor to the previous result set (based on the submitted pagination approach).
           example: /mortgage-app/api/v1/products?offset=50&limit=25
         next:
           type: string
-          description: Link / cursor to the next result set (based on the submitted pagination approach)
+          description: Link / cursor to the next result set (based on the submitted pagination approach).
           example: /mortgage-app/api/v1/products?offset=100&limit=25
         last:
           type: string
-          description: Link / cursor to the last result set (based on the submitted pagination approach)
+          description: Link / cursor to the last result set (based on the submitted pagination approach).
           example: /mortgage-app/api/v1/products?offset=150&limit=25
 
     # ---- Currency ----
     Currency:
-      description: ISO 4217 code
+      description: ISO 4217 code.
       type: string
       pattern: '^[A-Z]{3}$'
       example: CHF
 
     # ---- Amount ----
     Amount:
-      description: amount with currency
+      description: amount with currency.
       type: object
       required:
         - currency
@@ -1544,13 +1546,13 @@ components:
         currency:
           $ref: '#/components/schemas/Currency'
         content:
-          description: amount given with fractional digits, the separator is a dot
+          description: amount given with fractional digits, the separator is a dot.
           type: string
           pattern: '^-?\d{1,14}(?:\.\d{1,3})?$'
           example: '235.45'
 
     # ---- Address compliant to payment address (b.Link & ISO20022)----
-    structuredAddress:
+    StructuredAddress:
       title: Structured Address
       type: object
       required:
@@ -1563,32 +1565,38 @@ components:
           type: string
           maxLength: 70
           example: Rue de la gare
+          description: Name of street.
         buildingNumber:
           type: string
           maxLength: 16
           example: 24A
+          description: number of building.
         postCode:
           type: string
           maxLength: 16
           example: CH-2501
+          descritption: zip code.
         townName:
           type: string
           maxLength: 35
           example: Biel
+          description: you guesssed it, the name of the town.
         country:
           type: string
           maxLength: 2
           example: CH
+          descrption: a political area, sorrunded by borders, very often a natural border such as a river or a mountain.
+      descriton: structured address.
 
     # ---- Country Code ----
     Country:
       type: string
       pattern: '^[A-Z]{2}$'
       example: CH
-      description: 2-Letter ISO 3166-2 Country Code
+      description: 2-Letter ISO 3166-2 Country Code.
 
     # ---- Response
-    commonResourceCreatedResponse:
+    CommonResourceCreatedResponse:
       title: Recource created response
       description: Uuid v4 of the created resource
       example: 20460121-6aff-485b-a61d-6056ecd72bd8
@@ -1610,16 +1618,19 @@ components:
         title:
           type: string
           example: This is the general problem description
+          description: ..
         detail:
           type: array
           items:
             type: string
             example: List of detailed problem description with respect to the current request
+            description: ..
         instance:
           type: string
           example: path/to/corresponding/resource
+          description: ..
 
-    commonErrorType:
+    CommonErrorType:
       title: Common Error Type
       description: Error Types for commonErrorResponse.
       type: string
@@ -1643,7 +1654,7 @@ components:
     # ---- End Common Data Model
 
     PropertyObject:
-      description: The representation of a real estate object, real estate register id (propertyIdentifier) is optional until otherwise required by law
+      description: The representation of a real estate object, real estate register id (propertyIdentifier) is optional until otherwise required by law.
       type: object
       required:
         - propertyObjectId
@@ -1655,7 +1666,7 @@ components:
           example: 9343dd26-4b54-4808-8978-538f8e869d0e
         name:
           type: string
-          description: User-defined property name
+          description: User-defined property name.
           example: My Nice Property
         address:
           $ref: '#/components/schemas/structuredAddress'
@@ -1667,7 +1678,7 @@ components:
           properties:
             constructionYear:
               type: integer
-              description: construction year
+              description: construction year.
               example: 1990
             renovation:
               type: boolean
@@ -1675,7 +1686,7 @@ components:
               example: false
             renovationYear:
               type: integer
-              description: renovation year
+              description: renovation year.
               example: 1990
               default: 0
             propertyRenovations:
@@ -1703,7 +1714,7 @@ components:
                       - interior_fittings
                       - building_envelope
                       - building_services
-                    description: Type of Property Component which has been renovated. Please use consistently either the detailed Component Types (e.g. interior_fittings_floor_cover) or the simple Component Types (e.g. interior_fittings)
+                    description: Type of Property Component which has been renovated. Please use consistently either the detailed Component Types (e.g. interior_fittings_floor_cover) or the simple Component Types (e.g. interior_fittings).
                     example: interior_fittings_floor_cover
                   yearOfRenovation:
                     type: integer
@@ -1744,7 +1755,7 @@ components:
                 - '0'
                 - '0.5'
                 - '1.0'
-              description: 'Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: 0 = No, 0.5 = Partially, 1 = Yes. Proposed Mapping of WuP-Values: 1.0-4.0 => 0 (No) / 4.1-4.5 => 0.5 (Partially) / 4.6-5.0 = >1.0 (Yes).'
+              description: 'Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: 0 = No, 0.5 = Partially, 1 = Yes. Proposed Mapping of WuP-Values: 1.0-4.0 => 0 (No) / 4.1-4.5 => 0.5 (Partially) / 4.6-5.0 = >1.0 (Yes).'.
               example: 0
             constructionQualityType:
               $ref: '#/components/schemas/PropertyObjectRatingType'
@@ -1775,7 +1786,7 @@ components:
           enum:
             - self
             - let
-          description: 'The type of usage of the financing property: self, let'
+          description: 'The type of usage of the financing property: self, let'.
           example: self
         propertyType:
           type: string
@@ -1794,7 +1805,7 @@ components:
             - office_building
             - industrial_building
             - special_object
-          description: The type of property
+          description: The type of property.
           example: single_family_house
         ceilingHight:
           type: string
@@ -1840,8 +1851,8 @@ components:
               - radiator
               - stove
               - other
-            description: Type of the heat emission
-            example: floor
+          description: Type of the heat emission.
+          example: floor
         heatProduction:
           type: array
           items:
@@ -1861,8 +1872,8 @@ components:
               - solar_thermal_collector
               - block_type_thermal_power_station
               - block_type_thermal_power_station_bio
-            description: Type of the heat production
-            example: gas
+          description: Type of the heat production.
+          example: gas
         outsideConstructionZone:
           type: boolean
           description: If the property is outside of the construction zone.
@@ -2081,6 +2092,7 @@ components:
           example: false
         buildingRight:
           type: object
+          descrption: if a property is in building right, the buyer owner buy the property, not the ground the property is built on.
           properties:
             hasBuildingRight:
               type: boolean
@@ -2112,6 +2124,7 @@ components:
           description: The limit for land encumbrance according to Bundesgericht über das bäuerliche Bodenrecht, SR 211.412.11 (Belastungsgrenze BGBB)
         estimation:
           type: object
+          description: the estimation of the value of a property.
           properties:
             estimationId:
               type: string
@@ -2125,13 +2138,13 @@ components:
                 - wup
             marketValue:
               $ref: '#/components/schemas/Amount'
-              description: Estimated Market value of the property
+              description: Estimated Market value of the property.
             statisticalPriceRangeMax:
               $ref: '#/components/schemas/Amount'
-              description: Estimated statistical price range maximum
+              description: Estimated statistical price range maximum.
             statisticalPriceRangeMin:
               $ref: '#/components/schemas/Amount'
-              description: Estimated statistical price range minimum
+              description: Estimated statistical price range minimum.
             yearlyRentalIncome:
               $ref: '#/components/schemas/Amount'
               description: Estimated rental income per year
@@ -2139,7 +2152,7 @@ components:
               $ref: '#/components/schemas/Date'
         transferOfOwnershipDate:
           $ref: '#/components/schemas/Date'
-          description: When the property will be fully transfered to the new owner
+          description: When the property will be fully transfered to the new owner.
         publicNotarization:
           $ref: '#/components/schemas/Date'
           description: Date of public notarization
@@ -2147,24 +2160,26 @@ components:
           type: string
           example: We need an example for such a remark
         propertyLinks:
-          description: A list of links to external resources related to the property
+          description: A list of links to external resources related to the property.
           type: array
           items:
             $ref: '#/components/schemas/Link'
 
     PropertyIdentifier:
-      description: Property identification (register of real estate)
+      description: Property identification (register of real estate).
       type: object
       properties:
         EGRID:
           type: string
           example: CH480928387782
+          description: identifier of land a property is build on 
         EGID:
           type: string
           example: '191092250'
+          description: identifiert of the property.
 
     Mortgage:
-      description: All relevant information regarding a specific mortgage
+      description: All relevant information regarding a specific mortgage.
       type: object
       required:
         - mortgageId
@@ -2183,7 +2198,7 @@ components:
           type: string
           format: uuid
           example: 206065b9-977b-4d2c-9092-00acf2392346
-          description: Uuid v4 of the specific mortgage
+          description: Uuid v4 of the specific mortgage.
         product:
           $ref: '#/components/schemas/Product'
         amountAtExpiry:
@@ -2200,9 +2215,11 @@ components:
           $ref: '#/components/schemas/Date'
         interestRate:
           type: string
+          description: interest rate to be paid by debtor.
           example: '1.4'
         interestRateType:
           type: string
+          description: type of interest rate.
           example: libor
           enum:
             - variable
@@ -2211,6 +2228,7 @@ components:
             - fixed
         interestBasis:
           type: string
+          description: we need a description.
           example: We need an example
         durationType:
           type: integer
@@ -2219,14 +2237,17 @@ components:
           maximum: 25
           example: 5
         prolongable:
+          description: tells if a mortgage is prolongable or not. 
           type: boolean
           example: 0
         propertyObjects:
           type: array
+          description: ..
           items:
             $ref: '#/components/schemas/PropertyObject'
         relatedMortgages:
           type: array
+          description:..
           items:
             $ref: '#/components/schemas/Mortgage'
 
@@ -3325,14 +3346,14 @@ components:
       description: A product's uuid v4.
 
     path_applicationId:
-      name: applicationId
       in: path
-      description: Uuid v4 of the application request.
+      name: applicationId
       required: true
       schema:
         type: string
         format: uuid
         example: 4bf92636-14a0-4511-98e2-acfde576e644
+      description: Uuid v4 of the application request.
 
     path_documentId:
       in: path

From 4e5bde5facab1f0f66ebe3544f3521e9053c626c Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 10:53:22 +0200
Subject: [PATCH 15/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index df911fc..ef3f78e 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -3401,7 +3401,7 @@ components:
       required: true
       schema:
         type: string
-      description: 'ID of the client forwarded to the provider. (SCOPE: FI)'.
+      description: 'ID of the client forwarded to the provider. (SCOPE: FI)'
       
     correlation_in_header:
       in: header

From b42fc252c717808cbc9c9f6f6f8270621ec5343f Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 10:56:30 +0200
Subject: [PATCH 16/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index ef3f78e..0e31ac5 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1755,7 +1755,7 @@ components:
                 - '0'
                 - '0.5'
                 - '1.0'
-              description: 'Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: 0 = No, 0.5 = Partially, 1 = Yes. Proposed Mapping of WuP-Values: 1.0-4.0 => 0 (No) / 4.1-4.5 => 0.5 (Partially) / 4.6-5.0 = >1.0 (Yes).'.
+              description: 'Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: 0 = No, 0.5 = Partially, 1 = Yes. Proposed Mapping of WuP-Values: 1.0-4.0 => 0 (No) / 4.1-4.5 => 0.5 (Partially) / 4.6-5.0 = >1.0 (Yes).'
               example: 0
             constructionQualityType:
               $ref: '#/components/schemas/PropertyObjectRatingType'

From 2fbea3a37c03703951ffbde7e394e2c1b84f212f Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 11:33:24 +0200
Subject: [PATCH 17/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 0e31ac5..fe099f5 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1786,7 +1786,7 @@ components:
           enum:
             - self
             - let
-          description: 'The type of usage of the financing property: self, let'.
+          description: 'The type of usage of the financing property: self, let'
           example: self
         propertyType:
           type: string

From 8ca285cc3d558759fdc4dc0f1112fc7d190e3440 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 11:37:30 +0200
Subject: [PATCH 18/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index fe099f5..810472e 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1755,7 +1755,7 @@ components:
                 - '0'
                 - '0.5'
                 - '1.0'
-              description: 'Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: 0 = No, 0.5 = Partially, 1 = Yes. Proposed Mapping of WuP-Values: 1.0-4.0 => 0 (No) / 4.1-4.5 => 0.5 (Partially) / 4.6-5.0 = >1.0 (Yes).'
+              description: Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: 0 = No, 0.5 = Partially, 1 = Yes. Proposed Mapping of WuP-Values: 1.0-4.0 => 0 (No) / 4.1-4.5 => 0.5 (Partially) / 4.6-5.0 = >1.0 (Yes).
               example: 0
             constructionQualityType:
               $ref: '#/components/schemas/PropertyObjectRatingType'
@@ -1786,7 +1786,7 @@ components:
           enum:
             - self
             - let
-          description: 'The type of usage of the financing property: self, let'
+          description: The type of usage of the financing property.
           example: self
         propertyType:
           type: string
@@ -1902,7 +1902,7 @@ components:
               example: kitchen_full_room
             numberOfFamilyBathrooms:
               type: integer
-              description: 'Separate shower and bathtub in the bathroom (optional: toilet)'
+              description: Separate shower and bathtub in the bathroom (optional: toilet).
               example: 2
             numberOfBathWC:
               type: integer

From 85c02fb5f16e93936690b9e7212b3e68feafc3df Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 11:40:36 +0200
Subject: [PATCH 19/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 810472e..d51f48c 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1755,7 +1755,7 @@ components:
                 - '0'
                 - '0.5'
                 - '1.0'
-              description: Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: 0 = No, 0.5 = Partially, 1 = Yes. Proposed Mapping of WuP-Values: 1.0-4.0 => 0 (No) / 4.1-4.5 => 0.5 (Partially) / 4.6-5.0 = >1.0 (Yes).
+              description: 'Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not: 0 = No, 0.5 = Partially, 1 = Yes. Proposed Mapping of WuP-Values: 1.0-4.0 => 0 (No) / 4.1-4.5 => 0.5 (Partially) / 4.6-5.0 = >1.0 (Yes).'
               example: 0
             constructionQualityType:
               $ref: '#/components/schemas/PropertyObjectRatingType'

From e2941731007342d7eb6c0de50ca40b372e9d511b Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 11:43:32 +0200
Subject: [PATCH 20/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index d51f48c..02f3b58 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1902,7 +1902,7 @@ components:
               example: kitchen_full_room
             numberOfFamilyBathrooms:
               type: integer
-              description: Separate shower and bathtub in the bathroom (optional: toilet).
+              description: Separate shower and bathtub in the bathroom (optional: toilet)
               example: 2
             numberOfBathWC:
               type: integer

From fc09b2f3f24587cbab0672f47675c3efa7fec205 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 11:55:54 +0200
Subject: [PATCH 21/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 02f3b58..4b558bc 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1902,7 +1902,7 @@ components:
               example: kitchen_full_room
             numberOfFamilyBathrooms:
               type: integer
-              description: Separate shower and bathtub in the bathroom (optional: toilet)
+              description: 'Separate shower and bathtub in the bathroom (optional: toilet)'
               example: 2
             numberOfBathWC:
               type: integer

From e9782eeaff31e896752bc4793f19b97303bf3b67 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 11:59:24 +0200
Subject: [PATCH 22/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 4b558bc..b04521e 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -2249,7 +2249,7 @@ components:
           type: array
           description:..
           items:
-            $ref: '#/components/schemas/Mortgage'
+          $ref: '#/components/schemas/Mortgage'
 
     Offer:
       description: All relevant details describing the FI's offer for a mortgage product

From 2e6dfc5ad23a0d50be01fd5ed640fd083974d7a2 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 12:33:29 +0200
Subject: [PATCH 23/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index b04521e..0330230 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -2247,9 +2247,9 @@ components:
             $ref: '#/components/schemas/PropertyObject'
         relatedMortgages:
           type: array
-          description:..
+          description: ..
           items:
-          $ref: '#/components/schemas/Mortgage'
+           $ref: '#/components/schemas/Mortgage'
 
     Offer:
       description: All relevant details describing the FI's offer for a mortgage product

From 50b27ce89d161741ee976ffbc8f50facd2b622a6 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 12:45:57 +0200
Subject: [PATCH 24/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 0330230..3520b33 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -140,8 +140,8 @@ paths:
           name: expiring
           schema:
             type: boolean
-          example: true
           description: Whether or not the mortgage is qualified for being prolonged, i.e., expiring soon or already expired (for filtering).
+          example: true
         - $ref: '#/components/parameters/limit'
         - $ref: '#/components/parameters/offset'
         - $ref: '#/components/parameters/clientid_in_header'
@@ -163,7 +163,7 @@ paths:
                     items:
                       $ref: '#/components/schemas/Mortgage'
                   _links:
-                    $ref: '#/components/schemas/linksPagination'
+                    $ref: '#/components/schemas/LinksPagination'
         '400':
           $ref: '#/components/responses/standard400'
         '401':
@@ -230,7 +230,7 @@ paths:
         - Mortgage Products and Conditions
       parameters:
         - in: query
-          name: interestRateType
+          name: InterestRateType
           schema:
             type: string
             example: saron
@@ -262,7 +262,7 @@ paths:
                     items:
                       $ref: '#/components/schemas/Product'
                   _links:
-                    $ref: '#/components/schemas/linksPagination'
+                    $ref: '#/components/schemas/LinksPagination'
         '400':
           $ref: '#/components/responses/standard400'
         '401':
@@ -1494,7 +1494,7 @@ components:
       type: string
       format: date
       example: 2018-04-13
-      descriptio: Date format.
+      description: Date format.
 
     DateTime:
       type: string
@@ -1609,12 +1609,12 @@ components:
           description: Uuid v4 of the created resource
           example: bcb5d762-8d28-43a2-9398-393b2e8d56ba
 
-    commonErrorResponse:
+    CommonErrorResponse:
       title: Common Error Response
       type: object
       properties:
         type:
-          $ref: '#/components/schemas/commonErrorType'
+          $ref: '#/components/schemas/CommonErrorType'
         title:
           type: string
           example: This is the general problem description
@@ -1669,7 +1669,7 @@ components:
           description: User-defined property name.
           example: My Nice Property
         address:
-          $ref: '#/components/schemas/structuredAddress'
+          $ref: '#/components/schemas/StructuredAddress'
         propertyIdentifier:
           $ref: '#/components/schemas/PropertyIdentifier'
         propertyConstructionInformation:
@@ -1872,8 +1872,8 @@ components:
               - solar_thermal_collector
               - block_type_thermal_power_station
               - block_type_thermal_power_station_bio
-          description: Type of the heat production.
-          example: gas
+            description: Type of the heat production.
+            example: gas
         outsideConstructionZone:
           type: boolean
           description: If the property is outside of the construction zone.
@@ -2092,7 +2092,7 @@ components:
           example: false
         buildingRight:
           type: object
-          descrption: if a property is in building right, the buyer owner buy the property, not the ground the property is built on.
+          description: if a property is in building right, the buyer owner buy the property, not the ground the property is built on.
           properties:
             hasBuildingRight:
               type: boolean
@@ -2536,7 +2536,7 @@ components:
               description: phone of the TPP advisor
               example: '+41443343456'
             address:
-              $ref: '#/components/schemas/structuredAddress'
+              $ref: '#/components/schemas/StructuredAddress'
 
     Advertiser:
       description: Information about the person or agency selling the property, in case it is applicable and known
@@ -2790,7 +2790,7 @@ components:
               description: Surname of the applicant
               example: Muster
             address:
-              $ref: '#/components/schemas/structuredAddress'
+              $ref: '#/components/schemas/StructuredAddress'
             birthDate:
               $ref: '#/components/schemas/Date'
             maritalStatus:
@@ -3401,7 +3401,7 @@ components:
       required: true
       schema:
         type: string
-      description: 'ID of the client forwarded to the provider. (SCOPE: FI)'
+      description: ID of the client forwarded to the provider. (SCOPE: FI).
       
     correlation_in_header:
       in: header
@@ -3504,7 +3504,7 @@ components:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/commonResourceCreatedResponse'
+            $ref: '#/components/schemas/CommonResourceCreatedResponse'
       headers:
         location:
           schema:

From 1ced38326fe1e612682616084579ebe5e7981687 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 12:50:04 +0200
Subject: [PATCH 25/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 3520b33..e492517 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -3401,7 +3401,7 @@ components:
       required: true
       schema:
         type: string
-      description: ID of the client forwarded to the provider. (SCOPE: FI).
+      description: ID of the client forwarded to the provider.
       
     correlation_in_header:
       in: header

From 915c6426fd8803b04a442d69bb83d8e5bb205475 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 12:58:23 +0200
Subject: [PATCH 26/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index e492517..f218b01 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -70,7 +70,7 @@ paths:
                     items:
                       $ref: '#/components/schemas/MortgageCase'
                   _links:
-                    $ref: '#/components/schemas/linksPagination'
+                    $ref: '#/components/schemas/LinksPagination'
         '400':
           $ref: '#/components/responses/standard400'
         '401':
@@ -230,7 +230,7 @@ paths:
         - Mortgage Products and Conditions
       parameters:
         - in: query
-          name: InterestRateType
+          name: interestRateType
           schema:
             type: string
             example: saron
@@ -1555,6 +1555,7 @@ components:
     StructuredAddress:
       title: Structured Address
       type: object
+      descripton: structured address.
       required:
         - streetName
         - postCode
@@ -1574,8 +1575,8 @@ components:
         postCode:
           type: string
           maxLength: 16
+          description: zip code.
           example: CH-2501
-          descritption: zip code.
         townName:
           type: string
           maxLength: 35
@@ -1585,8 +1586,7 @@ components:
           type: string
           maxLength: 2
           example: CH
-          descrption: a political area, sorrunded by borders, very often a natural border such as a river or a mountain.
-      descriton: structured address.
+          description: a political area, sorrunded by borders, very often a natural border such as a river or a mountain.
 
     # ---- Country Code ----
     Country:
@@ -3528,7 +3528,7 @@ components:
       content:
         application/problem+json:
           schema:
-            $ref: '#/components/schemas/commonErrorResponse'
+            $ref: '#/components/schemas/CommonErrorResponse'
 
     standard401:
       headers:
@@ -3542,7 +3542,7 @@ components:
       content:
         application/problem+json:
           schema:
-            $ref: '#/components/schemas/commonErrorResponse'
+            $ref: '#/components/schemas/CommonErrorResponse'
 
     standard403:
       headers:
@@ -3556,7 +3556,7 @@ components:
       content:
         application/problem+json:
           schema:
-            $ref: '#/components/schemas/commonErrorResponse'
+            $ref: '#/components/schemas/CommonErrorResponse'
 
     standard404:
       headers:
@@ -3570,7 +3570,7 @@ components:
       content:
         application/problem+json:
           schema:
-            $ref: '#/components/schemas/commonErrorResponse'
+            $ref: '#/components/schemas/CommonErrorResponse'
 
     standard405:
       headers:
@@ -3584,7 +3584,7 @@ components:
       content:
         application/problem+json:
           schema:
-            $ref: '#/components/schemas/commonErrorResponse'
+            $ref: '#/components/schemas/CommonErrorResponse'
 
     standard500:
       headers:
@@ -3598,7 +3598,7 @@ components:
       content:
         application/problem+json:
           schema:
-            $ref: '#/components/schemas/commonErrorResponse'
+            $ref: '#/components/schemas/CommonErrorResponse'
 
     standard501:
       headers:
@@ -3612,7 +3612,7 @@ components:
       content:
         application/problem+json:
           schema:
-            $ref: '#/components/schemas/commonErrorResponse'
+            $ref: '#/components/schemas/CommonErrorResponse'
 
     standard503:
       headers:
@@ -3626,5 +3626,5 @@ components:
       content:
         application/problem+json:
           schema:
-            $ref: '#/components/schemas/commonErrorResponse'
+            $ref: '#/components/schemas/CommonErrorResponse'
   # ---- End Responses - Standard

From 4f703e1be69a6aa4e6d169a024882599e88117b9 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 13:05:29 +0200
Subject: [PATCH 27/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 107 +++++++++++++++++++++++------------------------
 1 file changed, 53 insertions(+), 54 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index f218b01..c216ac0 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -2358,7 +2358,7 @@ components:
             properties:
               description:
                 type: string
-                description: Product name description
+                description: Product name description.
                 example: Fixed rate mortgage
               language:
                 type: string
@@ -2383,7 +2383,7 @@ components:
             - fixed
 
     Condition:
-      description: All details regarding the conditions for a specific mortgage product the FI offers
+      description: All details regarding the conditions for a specific mortgage product the FI offers.
       type: object
       required:
         - conditionId
@@ -2421,7 +2421,7 @@ components:
           $ref: '#/components/schemas/Amortizations'
 
     Party:
-      description: Links together the persons building the applicant party
+      description: Links together the persons building the applicant party.
       type: object
       required:
         - personList
@@ -2441,7 +2441,7 @@ components:
             $ref: '#/components/schemas/Applicant'
 
     Application:
-      description: All static application information needed by the FI to create binding offers
+      description: All static application information needed by the FI to create binding offers.
       type: object
       required:
         - mortgageType
@@ -2455,7 +2455,7 @@ components:
           example: f157c4be-106d-4304-972e-091e77b87e1c
         tppApplicationId:
           type: string
-          description: The application alphanumeric identifier defined by TPP
+          description: The application alphanumeric identifier defined by TPP.
           pattern: '^[a-zA-Z0-9]{6,10}$'
           example: asd23f
         requestingParty:
@@ -2475,7 +2475,7 @@ components:
           enum:
             - advisor
             - direct
-          description: The type of the channel the application was generated
+          description: The type of the channel the application was generated.
           example: advisor
         replacementType:
           type: string
@@ -2491,14 +2491,14 @@ components:
             properties:
               replacedTrancheAmount:
                 $ref: '#/components/schemas/Amount'
-                description: The amount of the replaced tranche
+                description: The amount of the replaced tranche.
               replacedTrancheExpiry:
                 $ref: '#/components/schemas/Date'
-                description: The expiry date of the replaced tranche
+                description: The expiry date of the replaced tranche.
                 example: 2022-05-03
               replacedTrancheIssuer:
                 type: string
-                description: The institute who has issued the replaced tranche
+                description: The institute who has issued the replaced tranche.
                 example: Credit Suisse
         tppAdvisorDetail:
           type: object
@@ -2506,26 +2506,26 @@ components:
             name:
               type: string
               maxLength: 70
-              description: Name of the TPP advisor
+              description: Name of the TPP advisor.
               example: Max
             surName:
               type: string
               maxLength: 70
-              description: Surname of the TPP advisor
+              description: Surname of the TPP advisor.
               example: Muster
             nameTpp:
               type: string
               maxLength: 70
-              description: Firm of the TPP advisor
+              description: Firm of the TPP advisor.
               example: Muster Finanz AG
             email:
               type: string
-              description: Email of the TPP advisor
+              description: Email of the TPP advisor.
               example: max.muster@domain.ch
             language:
               type: string
               example: fr
-              description: Preferred contact language of the TPP advisor
+              description: Preferred contact language of the TPP advisor.
               enum:
                 - de
                 - fr
@@ -2533,19 +2533,19 @@ components:
                 - en
             phone:
               type: string
-              description: phone of the TPP advisor
+              description: phone of the TPP advisor.
               example: '+41443343456'
             address:
               $ref: '#/components/schemas/StructuredAddress'
 
     Advertiser:
-      description: Information about the person or agency selling the property, in case it is applicable and known
+      description: Information about the person or agency selling the property, in case it is applicable and known.
       type: object
       required:
         - name
       properties:
         advertiserType:
-          description: Specifies if the advertiser is a private person, a company or an agency
+          description: Specifies if the advertiser is a private person, a company or an agency.
           type: string
           enum:
             - private
@@ -2553,12 +2553,11 @@ components:
             - agency
           example: agency
         name:
-          description: The name of the advertiser
-          type: string
+          description: The name of the advertiser.
           maxLength: 140
           example: Real Estate Agency AG
         contactPerson:
-          description: The person to contact in case the advertiser is an agency or a company
+          description: The person to contact in case the advertiser is an agency or a company.
           type: string
           maxLength: 140
           example: Max Muster
@@ -2572,13 +2571,13 @@ components:
             - it
             - en
         phone:
-          description: The number on which the advertiser can be reached
+          description: The number on which the advertiser can be reached.
           type: string
           minLength: 4
           maxLength: 13
           example: '+41443343456'
         email:
-          description: The email address on which the advertiser can be contacted
+          description: The email address on which the advertiser can be contacted.
           type: string
           format: email
           minLength: 5
@@ -2587,7 +2586,7 @@ components:
           $ref: '#/components/schemas/structuredAddress'
 
     MortgageCase:
-      description: A complete mortgage case including the application details
+      description: A complete mortgage case including the application details.
       type: object
       required:
         - caseId
@@ -2598,7 +2597,7 @@ components:
           type: string
           format: uuid
           example: 2e1d21c3-0cd5-4354-a9e9-d2eb2c28b780
-          description: Uuid v4 of the mortgage case
+          description: Uuid v4 of the mortgage case.
         application:
           $ref: '#/components/schemas/Application'
         financing:
@@ -2606,10 +2605,10 @@ components:
         remark:
           type: string
           example: All documents verified at TPP
-          description: Remark/comment which can be added by TPP
+          description: Remark/comment which can be added by TPP.
 
     Financing:
-      description: Complete financing details of an application
+      description: Complete financing details of an application.
       type: object
       required:
         - amount
@@ -2617,12 +2616,12 @@ components:
         financingId:
           type: string
           format: uuid
-          description: Uuid of the financing
+          description: Uuid of the financing.
           example: 6e61ff5d-3ffd-4254-a77d-73cc25d35e92
         applicationIdRef:
           type: string
           format: uuid
-          description: Uuid of the financing's corresponding application
+          description: Uuid of the financing's corresponding application.
           example: 6e61ff5d-3ffd-4254-a77d-73cc25d35e92
         amount:
           $ref: '#/components/schemas/Amount'
@@ -2648,7 +2647,7 @@ components:
           $ref: '#/components/schemas/Date'
 
     FinancingTranche:
-      description: Tranche of a financing
+      description: Tranche of a financing.
       type: object
       required:
         - amount
@@ -2659,7 +2658,7 @@ components:
         productIdRef:
           type: string
           format: uuid
-          description: Uuid of the product
+          description: Uuid of the product.
           example: 6e61ff5d-3ffd-4254-a77d-73cc25d35e92
         amount:
           $ref: '#/components/schemas/Amount'
@@ -2695,7 +2694,7 @@ components:
           $ref: '#/components/schemas/Amortizations'
 
     FinancingRequest:
-      description: Based on the application, several financing requests can be sent to the FI
+      description: Based on the application, several financing requests can be sent to the FI.
       type: object
       required:
         - applicationId
@@ -2705,12 +2704,12 @@ components:
           type: string
           format: uuid
           example: 2e1d21c3-0cd5-4354-a9e9-d2eb2c28b780
-          description: Uuid v4 of the financing request defined by FI
+          description: Uuid v4 of the financing request defined by FI.
         applicationId:
           type: string
           format: uuid
           example: 3c921870-f29c-46ad-9ba5-c8b05e0d88d2
-          description: Uuid v4 of the corresponding application
+          description: Uuid v4 of the corresponding application.
         amount:
           $ref: '#/components/schemas/Amount'
         increaseAmount:
@@ -2732,7 +2731,7 @@ components:
               productId:
                 type: string
                 format: uuid
-                description: Uuid of the product
+                description: Uuid of the product.
                 example: 6e61ff5d-3ffd-4254-a77d-73cc25d35e92
               productVariation:
                 $ref: '#/components/schemas/ProductVariation'
@@ -2782,7 +2781,7 @@ components:
             name:
               type: string
               maxLength: 70
-              description: Name of the applicant
+              description: Name of the applicant.
               example: Max
             surName:
               type: string
@@ -2796,7 +2795,7 @@ components:
             maritalStatus:
               type: string
               example: married
-              description: Martial status of the applicant
+              description: Martial status of the applicant.
               enum:
                 - unmarried
                 - married
@@ -2816,7 +2815,7 @@ components:
             jobSituation:
               type: string
               example: employed
-              description: Job situation of the applicant
+              description: Job situation of the applicant.
               enum:
                 - employed
                 - selfEmployed
@@ -2826,15 +2825,15 @@ components:
               $ref: '#/components/schemas/Country'
             USPerson:
               type: boolean
-              description: Is the applicant a US person?
+              description: Is the applicant a US person.
               example: false
             email:
               type: string
-              description: Email of the applicant
+              description: Email of the applicant.
               example: max.muster@domain.ch
             phone:
               type: string
-              description: Phone number of the applicant
+              description: Phone number of the applicant.
               example: '+41443343456'
             solvencyRating:
               description: Solvency rating of the applicant e.g. CRIF
@@ -2849,17 +2848,17 @@ components:
                   example: 420
                 ratingSourceType:
                   type: string
-                  description: Provider of the solvency rating
+                  description: Provider of the solvency rating.
                   example: crif
                   enum:
                     - crif
                 ratingDate:
                   $ref: '#/components/schemas/Date'
-                  description: Date of the solvency rating
+                  description: Date of the solvency rating.
             applicantLanguage:
               type: string
               example: fr
-              description: Preferred contact language of the applicant
+              description: Preferred contact language of the applicant.
               enum:
                 - de
                 - fr
@@ -2942,11 +2941,11 @@ components:
                   nameAdditionalProperty:
                     type: string
                     maxLength: 70
-                    description: Name of the additional property
+                    description: Name of the additional property.
                     example: Orchard Villa, Holderstrasse 10
                   valueAdditionalProperty:
                     $ref: '#/components/schemas/Amount'
-                    description: Value of the additional property
+                    description: Value of the additional property.
                   propertyTypeAdditionalProperty:
                     type: string
                     enum:
@@ -2964,7 +2963,7 @@ components:
                       - office_building
                       - industrial_building
                       - special_object
-                    description: The type of the additional property
+                    description: The type of the additional property.
                     example: vacation_house
 
     # ---- Mortgage data types ----
@@ -3020,7 +3019,7 @@ components:
         - withdraw
 
     Asset:
-      description: 'Asset information: Array of all assets the applicant possesses, incl. the assets which will be used for the financial request.'
+      description: Asset information: Array of all assets the applicant possesses, incl. the assets which will be used for the financial request.
       type: object
       required:
         - assetType
@@ -3030,7 +3029,7 @@ components:
           $ref: '#/components/schemas/AssetType'
         amount:
           $ref: '#/components/schemas/Amount'
-          description: The amount of the asset e.g. market value of fungible investment, existing retirement asset in pension fund, surrender value in life insurance
+          description: The amount of the asset e.g. market value of fungible investment, existing retirement asset in pension fund, surrender value in life insurance.
         insuranceSum:
           $ref: '#/components/schemas/Amount'
           description: The amount of the sum insured in life insurance
@@ -3041,7 +3040,7 @@ components:
           $ref: '#/components/schemas/AssetProvider'
 
     UsedAsset:
-      description: 'Asset used by an applicant: Array of all assets which will be used for the financial request. At least, all of these used assets must also be recorded in the array of assets in the financial situation of one applicant.'
+      description: Asset used by an applicant: Array of all assets which will be used for the financial request. At least, all of these used assets must also be recorded in the array of assets in the financial situation of one applicant.
       type: object
       required:
         - assetType
@@ -3054,13 +3053,13 @@ components:
           $ref: '#/components/schemas/Amount'
         insuranceSum:
           $ref: '#/components/schemas/Amount'
-          description: The amount of the sum insured in life insurance
+          description: The amount of the sum insured in life insurance.
         usageType:
           $ref: '#/components/schemas/AssetUsageType'
         applicantId:
           type: string
           format: uuid
-          description: UUID v4 of the applicant (existing applicant within the current application)
+          description: UUID v4 of the applicant (existing applicant within the current application).
           example: 576f8de3-6b30-4882-a7af-da2132a456cf
         assetProvider:
           $ref: '#/components/schemas/AssetProvider'
@@ -3240,7 +3239,7 @@ components:
           example: IE12BOFI90000112345678
 
     AssetProvider:
-      description: Asset provider for each asset, additional information must be transfered. E.g. in case the applicant owns an addtional security of type insurance, insurance company name is provided
+      description: Asset provider for each asset, additional information must be transfered. E.g. in case the applicant owns an addtional security of type insurance, insurance company name is provided.
       type: object
       required:
         - name
@@ -3280,7 +3279,7 @@ components:
         currentRate:
           type: number
           format: double
-          description: Interest reate in decimals. 2.45% would be sent as 0.0245. For flexible interest mortgage this would show the margin above interest.Base
+          description: Interest reate in decimals. 2.45% would be sent as 0.0245. For flexible interest mortgage this would show the margin above interest.Base.
           minimum: 0
           maximum: 1
           example: 0.5
@@ -3293,7 +3292,7 @@ components:
           example: 0.5
 
     Link:
-      description: Object containing a link to an external resource and its description
+      description: Object containing a link to an external resource and its description.
       type: object
       required:
         - url

From 9eec717c8a22a8c68da97c5eaa1e131ad781e982 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 13:09:09 +0200
Subject: [PATCH 28/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index c216ac0..29f2efd 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -3019,7 +3019,7 @@ components:
         - withdraw
 
     Asset:
-      description: Asset information: Array of all assets the applicant possesses, incl. the assets which will be used for the financial request.
+      description: 'Asset information: Array of all assets the applicant possesses, incl. the assets which will be used for the financial request.'
       type: object
       required:
         - assetType

From fb7c7731661aafef1f7a38d54a9aa447d2684b83 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 13:16:04 +0200
Subject: [PATCH 29/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 29f2efd..ac19aa2 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -3040,7 +3040,7 @@ components:
           $ref: '#/components/schemas/AssetProvider'
 
     UsedAsset:
-      description: Asset used by an applicant: Array of all assets which will be used for the financial request. At least, all of these used assets must also be recorded in the array of assets in the financial situation of one applicant.
+      description: 'Asset used by an applicant: Array of all assets which will be used for the financial request. At least, all of these used assets must also be recorded in the array of assets in the financial situation of one applicant.'
       type: object
       required:
         - assetType

From c637861f0a32f45b8705bdb063b17c9a2835c179 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 13:26:03 +0200
Subject: [PATCH 30/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 41 +++++++++++++++++++++++------------------
 1 file changed, 23 insertions(+), 18 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index ac19aa2..4ec13c8 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -2583,7 +2583,7 @@ components:
           minLength: 5
           example: max.muster@domain.ch
         address:
-          $ref: '#/components/schemas/structuredAddress'
+          $ref: '#/components/schemas/StructuredAddress'
 
     MortgageCase:
       description: A complete mortgage case including the application details.
@@ -2874,6 +2874,7 @@ components:
               description: Gender of the applicant.
         financialSituation:
           type: object
+          description: the overall financial situation of a debtor. 
           properties:
             income:
               type: array
@@ -3032,9 +3033,10 @@ components:
           description: The amount of the asset e.g. market value of fungible investment, existing retirement asset in pension fund, surrender value in life insurance.
         insuranceSum:
           $ref: '#/components/schemas/Amount'
-          description: The amount of the sum insured in life insurance
+          description: The amount of the sum insured in life insurance.
         remark:
           type: string
+          description: remark remerk. 
           example: We need an example for such a remark
         assetProvider:
           $ref: '#/components/schemas/AssetProvider'
@@ -3160,23 +3162,26 @@ components:
           type: string
           format: uuid
           example: 6faea0b8-26a2-4b17-b10f-8f56fe355f50
-          description: Uuid v4 of the order defined by FI
+          description: Uuid v4 of the order defined by FI.
         offerId:
           type: string
           format: uuid
+          description: uuid of offer.
           example: 2752ce81-5bf0-4991-89ac-87d6e7fd0c47
         mortgageId:
           type: string
           format: uuid
+          description: uuid of mortgage.
           example: ef25ce8b-2fb1-45d9-bae0-6f263241a280
         applicationId:
           type: string
           format: uuid
+          description: ID of application.
           example: 59e8c8a6-4d32-4e7b-bcf0-05813029498e
         remark:
           type: string
           example: All documents verified at TPP
-          description: Remark/comment which can be added by TPP
+          description: Remark/comment which can be added by TPP.
 
     Document:
       description: Document containing information for givent document type for given order.
@@ -3187,15 +3192,15 @@ components:
         name:
           type: string
           example: MortgageOffer_WaimerANON_587b23d1-12a8-475a-968b-abee245e3393
-          description: Name of the document
+          description: Name of the document.
         parentId:
           type: string
           format: uuid
           example: 2752ce81-5bf0-4991-89ac-87d6e7fd0c47
-          description: Id for parent object of given document
+          description: Id for parent object of given document.
         content:
           type: string
-          description: base64 Encoded Content
+          description: base64 Encoded Content.
           example: JVBERi0xLjQKJeLjz9MKMzEgMCBvYmoKPDwvQnl0ZVJhbmdl
         contentType:
           type: string
@@ -3215,11 +3220,11 @@ components:
           enum:
             - direct
             - indirect
-          description: The type of amortization
+          description: The type of amortization.
           example: direct
         amortizationAmount:
           $ref: '#/components/schemas/Amount'
-          description: The amount of the periodic amortization
+          description: The amount of the periodic amortization.
           example: 27400
         amortizationStart:
           $ref: '#/components/schemas/Date'
@@ -3231,11 +3236,11 @@ components:
             - yearly
             - quarterly
             - monthly
-          description: The periodicity the amortization is paid
+          description: The periodicity the amortization is paid.
           example: quarterly
         amortizationAccountNr:
           type: string
-          description: The account number from which the amortization is paid
+          description: The account number from which the amortization is paid.
           example: IE12BOFI90000112345678
 
     AssetProvider:
@@ -3247,10 +3252,10 @@ components:
         name:
           type: string
           example: Credit Suisse
-          description: Name of the asset provider
+          description: Name of the asset provider.
 
     AmountRange:
-      description: Min and max amount with currency
+      description: Min and max amount with currency.
       type: object
       required:
         - currency
@@ -3260,7 +3265,7 @@ components:
         currency:
           $ref: '#/components/schemas/Currency'
         minContent:
-          description: min amount given with fractional digits, the separator is a dot
+          description: min amount given with fractional digits, the separator is a dot.
           type: string
           pattern: '^-?\d{1,14}(?:\.\d{1,3})?$'
           example: '1000000'
@@ -3271,7 +3276,7 @@ components:
           example: '5000000'
 
     Interest:
-      description: The current rate and optionally the referred base
+      description: The current rate and optionally the referred base.
       type: object
       required:
         - currentRate
@@ -3298,17 +3303,17 @@ components:
         - url
       properties:
         url:
-          description: The URL pointing to the resource
+          description: The URL pointing to the resource.
           type: string
           format: uri
           minLength: 2
           example: http://www.example.com/property.png
         name:
-          description: The name of the resource
+          description: The name of the resource.
           type: string
           example: Property image
         description:
-          description: A description of the resource
+          description: A description of the resource.
           type: string
           example: The image shows the aerial view of the property
 

From 55c628f19a0d77286430383027bbb4748c26bfac Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 13:37:11 +0200
Subject: [PATCH 31/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 4ec13c8..efd40df 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -2501,6 +2501,7 @@ components:
                 description: The institute who has issued the replaced tranche.
                 example: Credit Suisse
         tppAdvisorDetail:
+          description: personal information if the advisor of the tpp. 
           type: object
           properties:
             name:
@@ -2562,7 +2563,7 @@ components:
           maxLength: 140
           example: Max Muster
         language:
-          description: Preferred contact language of the advertiser
+          description: Preferred contact language of the advertiser.
           type: string
           example: fr
           enum:
@@ -2634,11 +2635,13 @@ components:
         amortizations:
           $ref: '#/components/schemas/Amortizations'
         tranches:
+          description: mortgage tranches.
           type: array
           items:
             $ref: '#/components/schemas/FinancingTranche'
         usedAssets:
           type: array
+          description: used assets.
           items:
             $ref: '#/components/schemas/UsedAsset'
         offerDate:
@@ -2668,6 +2671,7 @@ components:
           $ref: '#/components/schemas/Date'
         duration:
           type: integer
+          description: duratin of the mortgage in years.
           example: 2
           minimum: 1
           maximum: 20
@@ -2675,6 +2679,7 @@ components:
           $ref: '#/components/schemas/Interest'
         interestRateType:
           type: string
+          description: type of intererest rate.
           example: libor
           enum:
             - variable
@@ -2719,6 +2724,7 @@ components:
           description: The purpose of the increase.
           example: renovation of the kitchen
         tranches:
+          description: a mortgage amount is distributed in one or more tranches.
           type: array
           items:
             type: object
@@ -2740,12 +2746,14 @@ components:
               amount:
                 $ref: '#/components/schemas/Amount'
         usedAssets:
+          description: Assets being used for the financing request.
           type: array
           items:
             $ref: '#/components/schemas/UsedAsset'
         publicCertDate:
           $ref: '#/components/schemas/Date'
         requestOfferType:
+          description: Ding dong die Hex ist tot.
           type: string
           example: binding  
           enum:
@@ -2763,19 +2771,21 @@ components:
         applicantId:
           type: string
           format: uuid
-          description: UUID v4 of the applicant (to be defined by TPP)
+          description: UUID v4 of the applicant (to be defined by TPP).
           example: 576f8de3-6b30-4882-a7af-da2132a456cf
         fiApplicantId:
           type: string
           description: ApplicantId of the applicant party defined by the financial institute, only applicable if known at the moment of the application.
           example: asd23f
         applicantType:
+          description: type of applicant.
           type: string
           example: individual
           enum:
             - individual
             - legal_entity
         applicantDetail:
+          description: personal information regarding the applicant.
           type: object
           properties:
             name:
@@ -3204,7 +3214,7 @@ components:
           example: JVBERi0xLjQKJeLjz9MKMzEgMCBvYmoKPDwvQnl0ZVJhbmdl
         contentType:
           type: string
-          description: Content type
+          description: Content type.
           example: application/octet-stream
         createDate:
           $ref: '#/components/schemas/Date'
@@ -3270,7 +3280,7 @@ components:
           pattern: '^-?\d{1,14}(?:\.\d{1,3})?$'
           example: '1000000'
         maxContent:
-          description: max amount given with fractional digits, the separator is a dot
+          description: max amount given with fractional digits, the separator is a dot.
           type: string
           pattern: '^-?\d{1,14}(?:\.\d{1,3})?$'
           example: '5000000'

From f230b3d5ddd367f5aa027e49862c2071f3d8432f Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 13:46:37 +0200
Subject: [PATCH 32/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index efd40df..f043061 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1553,9 +1553,9 @@ components:
 
     # ---- Address compliant to payment address (b.Link & ISO20022)----
     StructuredAddress:
+      description: structured address.
       title: Structured Address
       type: object
-      descripton: structured address.
       required:
         - streetName
         - postCode
@@ -1598,7 +1598,7 @@ components:
     # ---- Response
     CommonResourceCreatedResponse:
       title: Recource created response
-      description: Uuid v4 of the created resource
+      description: Uuid v4 of the created resource.
       example: 20460121-6aff-485b-a61d-6056ecd72bd8
       type: object
       required:
@@ -1606,11 +1606,12 @@ components:
       properties:
         id:
           $ref: '#/components/schemas/CommonID'
-          description: Uuid v4 of the created resource
+          description: Uuid v4 of the created resource.
           example: bcb5d762-8d28-43a2-9398-393b2e8d56ba
 
     CommonErrorResponse:
       title: Common Error Response
+      description: ...
       type: object
       properties:
         type:
@@ -1620,6 +1621,7 @@ components:
           example: This is the general problem description
           description: ..
         detail:
+          description: ..
           type: array
           items:
             type: string
@@ -1779,7 +1781,7 @@ components:
             - efficient
             - average
             - inefficient
-          description: The efficiency of the floor plan
+          description: The efficiency of the floor plan.
           example: average
         usageType:
           type: string
@@ -1854,6 +1856,7 @@ components:
           description: Type of the heat emission.
           example: floor
         heatProduction:
+          description: the way heat is generated within the building. 
           type: array
           items:
             type: string
@@ -2158,6 +2161,7 @@ components:
           description: Date of public notarization
         remarks:
           type: string
+          descriptin: remark regarding the erstimation. 
           example: We need an example for such a remark
         propertyLinks:
           description: A list of links to external resources related to the property.
@@ -2172,7 +2176,7 @@ components:
         EGRID:
           type: string
           example: CH480928387782
-          description: identifier of land a property is build on 
+          description: identifier of land a property is built on. 
         EGID:
           type: string
           example: '191092250'
@@ -2252,7 +2256,7 @@ components:
            $ref: '#/components/schemas/Mortgage'
 
     Offer:
-      description: All relevant details describing the FI's offer for a mortgage product
+      description: All relevant details describing the FI's offer for a mortgage product.
       type: object
       required:
         - offerId
@@ -2265,12 +2269,12 @@ components:
           type: string
           format: uuid
           example: 46eb482d-1e18-4b93-ae88-da14ad4ac051
-          description: Uuid v4 of the specific order
+          description: Uuid v4 of the specific order.
         financingRequestId:
           type: string
           format: uuid
           example: fd3f2940-c9c9-46e7-8ed6-ab9e90363b2e
-          description: Uuid v4 of a specific financing request
+          description: Uuid v4 of a specific financing request.
         totalAmount:
           $ref: '#/components/schemas/Amount'
         validTo:
@@ -2287,7 +2291,7 @@ components:
             - indicative
 
     OfferItem:
-      description: All relevant details of a specific item being part of an FI's offer for a mortgage product
+      description: All relevant details of a specific item being part of an FI's offer for a mortgage product.
       type: object
       required:
         - offerItemId

From 7d686368ae003abe8db227d1278ff7a892526fd8 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 13:57:20 +0200
Subject: [PATCH 33/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index f043061..3fd358c 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -2161,7 +2161,7 @@ components:
           description: Date of public notarization
         remarks:
           type: string
-          descriptin: remark regarding the erstimation. 
+          description: remark regarding the erstimation. 
           example: We need an example for such a remark
         propertyLinks:
           description: A list of links to external resources related to the property.
@@ -2280,11 +2280,13 @@ components:
         validTo:
           $ref: '#/components/schemas/Date'
         offerItems:
+          description: ..
           type: array
           items:
             $ref: '#/components/schemas/OfferItem'
         offerType:
           type: string
+          description: type of offer (binding or indicative).
           example: binding
           enum:
             - binding
@@ -2301,22 +2303,23 @@ components:
         trancheId:
           type: string
           format: uuid
-          description: Uuid of the tranche
+          description: Uuid of the tranche.
           example: 51b017e1-5e59-4b58-a0a0-c638c87db463
         offerItemId:
           type: string
           format: uuid
           example: d452083f-8316-410d-a609-d49463687329
-          description: Uuid v4 of the specific offer item
+          description: Uuid v4 of the specific offer item.
         product:
           $ref: '#/components/schemas/Product'
         conditions:
+          description: ..
           type: array
           items:
             $ref: '#/components/schemas/Condition'
 
     ProductVariation:
-      description: Product variation details
+      description: Product variation details.
       type: object
       properties:
         duration:
@@ -2343,7 +2346,7 @@ components:
             - 12m
 
     Product:
-      description: All details regarding an FI's mortgage product
+      description: All details regarding an FI's mortgage product.
       type: object
       required:
         - productId
@@ -2357,6 +2360,7 @@ components:
           example: 20460121-6aff-485b-a61d-6056ecd72bd8
         names:
           type: array
+          description: name of mortgage product.
           items:
             type: object
             properties:
@@ -2375,10 +2379,12 @@ components:
                   - en
         productVariations:
           type: array
+          description: ..
           items:
             $ref: '#/components/schemas/ProductVariation'
         interestRateType:
           type: string
+          description: type of interest rate. 
           example: libor
           enum:
             - variable
@@ -2399,11 +2405,13 @@ components:
         - amortization
       properties:
         conditionId:
+          description: ID of condition. 
           type: string
           format: uuid
           example: ef737eb0-c0a7-4f44-bdeb-32ba9bd99327
         productIdRef:
           type: string
+          decsription: Reference to prodcut ID.
           format: uuid
           example: 0b34cd1b-32a5-4bb7-bcc5-bf81f8f8aaf1
         duration:
@@ -2419,6 +2427,7 @@ components:
         amountRange:
           $ref: '#/components/schemas/AmountRange'
         amortization:
+          description: the amount of repayment.
           type: integer
           example: 1000
         amortizations:
@@ -2440,6 +2449,7 @@ components:
           description: ApplicantId for primary applicant of the applicant party defined by the financial institute, only applicable in case of multiple applicants and if known at the moment of the application.
           example: asd23f
         personList:
+          description: ..
           type: array
           items:
             $ref: '#/components/schemas/Applicant'
@@ -2489,6 +2499,7 @@ components:
             - entire
             - partial
         replacedTranches:
+          descriptop: Tranche to be replaced.
           type: array
           items:
             type: object

From ab9628c3ed982588e15e41774977b62607a52481 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 13:59:55 +0200
Subject: [PATCH 34/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 3fd358c..2b25287 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -2411,7 +2411,7 @@ components:
           example: ef737eb0-c0a7-4f44-bdeb-32ba9bd99327
         productIdRef:
           type: string
-          decsription: Reference to prodcut ID.
+          description: Reference to prodcut ID.
           format: uuid
           example: 0b34cd1b-32a5-4bb7-bcc5-bf81f8f8aaf1
         duration:
@@ -2499,7 +2499,7 @@ components:
             - entire
             - partial
         replacedTranches:
-          descriptop: Tranche to be replaced.
+          descripton: Tranche to be replaced.
           type: array
           items:
             type: object

From a10825098fcd0fa65b6221235a1544f0ec0d8b0f Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 15:37:52 +0200
Subject: [PATCH 35/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 126 +++++++++++++++++++++++------------------------
 1 file changed, 62 insertions(+), 64 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 2b25287..7c151db 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -11,7 +11,7 @@ info:
     email: info@common-api.ch
   license:
     name: Apache 2.0
-    url: http://www.apache.org/licenses/LICENSE-2.0.html
+    url: https://www.apache.org/licenses/LICENSE-2.0.html
 servers:
   - url: https://mortgage.common-api.ch
 externalDocs:
@@ -230,7 +230,7 @@ paths:
         - Mortgage Products and Conditions
       parameters:
         - in: query
-          name: interestRateType
+          name: interest_rate_type
           schema:
             type: string
             example: saron
@@ -1471,22 +1471,6 @@ paths:
 # -------- Models ---------
 # -------------------------
 components:
-  securitySchemes:
-    ApiKeyAuth:
-      type: apiKey
-      in: header
-      name: X-API-Key
-
-    OAuth2:
-      type: oauth2
-      flows:
-        authorizationCode:
-          authorizationUrl: https://example.com/oauth/authorize
-          tokenUrl: https://example.com/oauth/token
-          scopes:
-            read: Grants read access
-            write: Grants write access
-
   schemas:
     # ---- Common Data Model v1.2.0
     # ---- Date Formats
@@ -1599,7 +1583,6 @@ components:
     CommonResourceCreatedResponse:
       title: Recource created response
       description: Uuid v4 of the created resource.
-      example: 20460121-6aff-485b-a61d-6056ecd72bd8
       type: object
       required:
         - id
@@ -1607,8 +1590,7 @@ components:
         id:
           $ref: '#/components/schemas/CommonID'
           description: Uuid v4 of the created resource.
-          example: bcb5d762-8d28-43a2-9398-393b2e8d56ba
-
+    
     CommonErrorResponse:
       title: Common Error Response
       description: ...
@@ -1853,8 +1835,8 @@ components:
               - radiator
               - stove
               - other
-          description: Type of the heat emission.
-          example: floor
+            description: Type of the heat emission.
+            example: floor
         heatProduction:
           description: the way heat is generated within the building. 
           type: array
@@ -2499,7 +2481,7 @@ components:
             - entire
             - partial
         replacedTranches:
-          descripton: Tranche to be replaced.
+          description: Tranche to be replaced.
           type: array
           items:
             type: object
@@ -3423,31 +3405,7 @@ components:
         format: uuid
         example: 91d029b3-ee7a-44c3-ac18-cf621cb128a8
       description: Uuid v4 of an order.
-
-    clientid_in_header:
-      in: header
-      name: X-CorAPI-Client-ID
-      required: true
-      schema:
-        type: string
-      description: ID of the client forwarded to the provider.
-      
-    correlation_in_header:
-      in: header
-      name: X-Correlation-ID
-      required: true
-      schema:
-        type: string
-      description: Unique ID (defined by the caller) which will be reflected back in the response.
-      
-    agent_in_header:
-      in: header
-      name: User-Agent
-      required: true
-      schema:
-        type: string
-      description: Name and version of the of the Client software.
-      
+   
     offset:
       in: query
       name: offset
@@ -3503,28 +3461,45 @@ components:
         example: fr
       description: Language of Document content.
 
-  # --- Response Headers - used by Standard Responses ---
-  headers:
-    Content-Language:
-      description: Response language - always en
+    clientid_in_header:
+      in: header
+      name: X-CorAPI-Client-ID
+      required: true
       schema:
         type: string
-
-    Content-Type:
-      description: application/problem+json; charset=utf-8 according to RFC7807
+      description: ID of the client forwarded to the provider.
+      
+    correlation_in_header:
+      in: header
+      name: X-Correlation-ID
+      required: true
       schema:
         type: string
-
-    Location:
-      description: Location (submissionId) of the submitted message. Add /status for the status report.
+      description: Unique ID (defined by the caller) which will be reflected back in the response.
+      
+    agent_in_header:
+      in: header
+      name: User-Agent
+      required: true
       schema:
         type: string
+      description: Name and version of the of the Client software.
+        
+ securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: X-API-Key
 
-    X-Correlation-ID:
-      description: Client defined ID from request to correlates HTTP requests between a client and server
-      schema:
-        type: string
-        example: f058ebd6-02f7-4d3f-942e-904344e8cde5
+    OAuth2:
+      type: oauth2
+      flows:
+        authorizationCode:
+          authorizationUrl: https://example.com/oauth/authorize
+          tokenUrl: https://example.com/oauth/token
+          scopes:
+            read: Grants read access
+            write: Grants write access
 
   # ---- Responses - Standard----
   responses:
@@ -3657,3 +3632,26 @@ components:
           schema:
             $ref: '#/components/schemas/CommonErrorResponse'
   # ---- End Responses - Standard
+
+  # --- Response Headers - used by Standard Responses ---
+  headers:
+    Content-Language:
+      description: Response language - always en
+      schema:
+        type: string
+
+    Content-Type:
+      description: application/problem+json; charset=utf-8 according to RFC7807
+      schema:
+        type: string
+
+    Location:
+      description: Location (submissionId) of the submitted message. Add /status for the status report.
+      schema:
+        type: string
+
+    X-Correlation-ID:
+      description: Client defined ID from request to correlates HTTP requests between a client and server
+      schema:
+        type: string
+        example: f058ebd6-02f7-4d3f-942e-904344e8cde5

From 2e656a3e362514f976de595702e0eaa964e50c2e Mon Sep 17 00:00:00 2001
From: dkoeni <116151702+dkoeni@users.noreply.github.com>
Date: Wed, 18 Sep 2024 15:40:40 +0200
Subject: [PATCH 36/39] fix indentation

---
 mortgageAPI.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 7c151db..5affff7 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -3484,8 +3484,8 @@ components:
       schema:
         type: string
       description: Name and version of the of the Client software.
-        
- securitySchemes:
+
+  securitySchemes:
     ApiKeyAuth:
       type: apiKey
       in: header

From 6663835de0f1c683e40bf45c0657b3013767feb7 Mon Sep 17 00:00:00 2001
From: NikolajMarwitz <145751595+NikolajMarwitz@users.noreply.github.com>
Date: Wed, 18 Sep 2024 15:43:15 +0200
Subject: [PATCH 37/39] Update mortgageAPI.yaml

---
 mortgageAPI.yaml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 5affff7..2bc7cfa 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1827,6 +1827,7 @@ components:
           description: Building standard of the sanitary installations.
           example: basic
         heatEmission:
+          description: Type of the heat emission.
           type: array
           items:
             type: string
@@ -1835,7 +1836,6 @@ components:
               - radiator
               - stove
               - other
-            description: Type of the heat emission.
             example: floor
         heatProduction:
           description: the way heat is generated within the building. 

From 87033a259f8fe45ce155304b5f37345da5505f0d Mon Sep 17 00:00:00 2001
From: dkoeni <116151702+dkoeni@users.noreply.github.com>
Date: Wed, 18 Sep 2024 18:24:02 +0200
Subject: [PATCH 38/39] fixes

---
 mortgageAPI.yaml | 61 ++++++++++++++++++++++++------------------------
 1 file changed, 31 insertions(+), 30 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index 3ea172e..c6d2da9 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -17,9 +17,10 @@ servers:
 externalDocs:
   description: Find out more about SFTI API specifications
   url: https://www.common-api.ch
+
 tags:
   - name: Full Mortgage Cases
-    description: Operatios related to full mortgage cases including the application details.
+    description: Operations related to full mortgage cases including the application details.
   - name: Existing Mortgages
     description: Operations related with existing mortgages.
   - name: Mortgage Products and Conditions
@@ -645,7 +646,7 @@ paths:
                 properties:
                   status:
                     type: string
-                    example: we need an exmaple
+                    example: we need an example
         '400':
           $ref: '#/components/responses/standard400'
         '401':
@@ -1570,12 +1571,12 @@ components:
           type: string
           maxLength: 35
           example: Biel
-          description: you guesssed it, the name of the town.
+          description: you guessed it, the name of the town.
         country:
           type: string
           maxLength: 2
           example: CH
-          description: a political area, sorrunded by borders, very often a natural border such as a river or a mountain.
+          description: a political area, surrounded by borders, very often a natural border such as a river or a mountain.
 
     # ---- Country Code ----
     Country:
@@ -1586,7 +1587,7 @@ components:
 
     # ---- Response
     CommonResourceCreatedResponse:
-      title: Recource created response
+      title: Resource created response
       description: Uuid v4 of the created resource.
       type: object
       required:
@@ -1595,7 +1596,7 @@ components:
         id:
           $ref: '#/components/schemas/CommonID'
           description: Uuid v4 of the created resource.
-    
+
     CommonErrorResponse:
       title: Common Error Response
       description: ...
@@ -1857,7 +1858,7 @@ components:
               - other
             example: floor
         heatProduction:
-          description: the way heat is generated within the building. 
+          description: the way heat is generated within the building.
           type: array
           items:
             type: string
@@ -2159,13 +2160,13 @@ components:
               $ref: '#/components/schemas/Date'
         transferOfOwnershipDate:
           $ref: '#/components/schemas/Date'
-          description: When the property will be fully transfered to the new owner.
+          description: When the property will be fully transferred to the new owner.
         publicNotarization:
           $ref: '#/components/schemas/Date'
           description: Date of public notarization
         remarks:
           type: string
-          description: remark regarding the erstimation. 
+          description: Remark regarding the estimation.
           example: We need an example for such a remark
         propertyLinks:
           description: A list of links to external resources related to the property.
@@ -2180,11 +2181,11 @@ components:
         EGRID:
           type: string
           example: CH480928387782
-          description: identifier of land a property is built on. 
+          description: Identifier of land a property is built on.
         EGID:
           type: string
           example: '191092250'
-          description: identifiert of the property.
+          description: Identifier of the property.
 
     Mortgage:
       description: All relevant information regarding a specific mortgage.
@@ -2218,7 +2219,7 @@ components:
         offerDate:
           $ref: '#/components/schemas/Date'
           description: >
-            The date when the offer is made by the FI. Optional field for use cases where no MortageOffer object is used and
+            The date when the offer is made by the FI. Optional field for use cases where no MortgageOffer object is used and
             therefore the offer date needs to be directly in Mortgage object.
           example: 2018-04-05
         validTo:
@@ -2247,7 +2248,7 @@ components:
           maximum: 25
           example: 5
         prolongable:
-          description: tells if a mortgage is prolongable or not. 
+          description: tells if a mortgage is prolongable or not.
           type: boolean
           example: 0
         propertyObjects:
@@ -2259,7 +2260,7 @@ components:
           type: array
           description: ..
           items:
-           $ref: '#/components/schemas/Mortgage'
+            $ref: '#/components/schemas/Mortgage'
 
     Offer:
       description: All relevant details describing the FI's offer for a mortgage product.
@@ -2390,7 +2391,7 @@ components:
             $ref: '#/components/schemas/ProductVariation'
         interestRateType:
           type: string
-          description: type of interest rate. 
+          description: type of interest rate.
           example: libor
           enum:
             - variable
@@ -2411,13 +2412,13 @@ components:
         - amortization
       properties:
         conditionId:
-          description: ID of condition. 
+          description: ID of condition.
           type: string
           format: uuid
           example: ef737eb0-c0a7-4f44-bdeb-32ba9bd99327
         productIdRef:
           type: string
-          description: Reference to prodcut ID.
+          description: Reference to product ID.
           format: uuid
           example: 0b34cd1b-32a5-4bb7-bcc5-bf81f8f8aaf1
         duration:
@@ -2525,7 +2526,7 @@ components:
                 description: The institute who has issued the replaced tranche.
                 example: Credit Suisse
         tppAdvisorDetail:
-          description: personal information if the advisor of the tpp. 
+          description: Personal information if the advisor of the TPP.
           type: object
           properties:
             name:
@@ -2703,7 +2704,7 @@ components:
           $ref: '#/components/schemas/Interest'
         interestRateType:
           type: string
-          description: type of intererest rate.
+          description: type of interest rate.
           example: libor
           enum:
             - variable
@@ -2779,7 +2780,7 @@ components:
         requestOfferType:
           description: Ding dong die Hex ist tot.
           type: string
-          example: binding  
+          example: binding
           enum:
             - binding
             - indicative
@@ -2910,7 +2911,7 @@ components:
               description: Gender of the applicant.
         financialSituation:
           type: object
-          description: the overall financial situation of a debtor. 
+          description: the overall financial situation of a debtor.
           properties:
             income:
               type: array
@@ -3075,7 +3076,7 @@ components:
           description: The amount of the sum insured in life insurance.
         remark:
           type: string
-          description: remark remerk. 
+          description: remark remark.
           example: We need an example for such a remark
         assetProvider:
           $ref: '#/components/schemas/AssetProvider'
@@ -3225,7 +3226,7 @@ components:
           description: Remark/comment which can be added by TPP.
 
     Document:
-      description: Document containing information for givent document type for given order.
+      description: Document containing information for given document type for given order.
       type: object
       required:
         - name
@@ -3286,7 +3287,7 @@ components:
 
     AssetProvider:
       description: >
-        Asset provider for each asset, additional information must be transfered. E.g. in case the applicant owns an addtional security of type
+        Asset provider for each asset, additional information must be transferred. E.g. in case the applicant owns an additional security of type
         insurance, insurance company name is provided
       type: object
       required:
@@ -3328,7 +3329,7 @@ components:
           type: number
           format: double
           description: >
-            Interest reate in decimals. 2.45% would be sent as 0.0245. For flexible interest mortgage this would show
+            Interest rate in decimals. 2.45% would be sent as 0.0245. For flexible interest mortgage this would show
             the margin above interest.
           minimum: 0
           maximum: 1
@@ -3336,7 +3337,7 @@ components:
         base:
           type: number
           format: double
-          description: Base rate uupon margin is applied (e.g. for SARON).
+          description: Base rate upon margin is applied (e.g. for SARON).
           minimum: 0
           maximum: 1
           example: 0.5
@@ -3465,14 +3466,14 @@ components:
         example: 25
         minimum: 1
       description: Optional parameter for pagination. Maximum number of entries to be returned.
-      
+
     cursor:
       in: query
       name: cursor
       required: false
       schema:
         type: string
-        example: cursorIDxyz     
+        example: cursorIDxyz
       description: Optional parameter for pagination. An opaque string value used for pagination.
 
     duration:
@@ -3506,7 +3507,7 @@ components:
       schema:
         type: string
       description: ID of the client forwarded to the provider.
-      
+
     correlation_in_header:
       in: header
       name: X-Correlation-ID
@@ -3514,7 +3515,7 @@ components:
       schema:
         type: string
       description: Unique ID (defined by the caller) which will be reflected back in the response.
-      
+
     agent_in_header:
       in: header
       name: User-Agent

From 2ae08a07a3880cafd9c82eaa4f87dd86eb03016e Mon Sep 17 00:00:00 2001
From: dkoeni <116151702+dkoeni@users.noreply.github.com>
Date: Wed, 18 Sep 2024 18:28:10 +0200
Subject: [PATCH 39/39] string fix

---
 mortgageAPI.yaml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/mortgageAPI.yaml b/mortgageAPI.yaml
index c6d2da9..7a05714 100644
--- a/mortgageAPI.yaml
+++ b/mortgageAPI.yaml
@@ -1746,9 +1746,9 @@ components:
             luxusFlag:
               type: string
               enum:
-                - 0
-                - 0.5
-                - 1.0
+                - '0'
+                - '0.5'
+                - '1.0'
               description: |
                 Used for object value calculation (e.g. IAZI) and indicates whether an object is luxury or not:
                 - 0 = No