Small formatting changes. Better name for simulation result.

swissfintechinnovations · Dec 31, 2024 · e72c7f7 · e72c7f7
1 parent afd1bc6
commit e72c7f7
Showing 1 changed file with 8 additions and 8 deletions.
diff --git a/pensionAPI.yaml b/pensionAPI.yaml
@@ -160,6 +160,7 @@ tags:
     description: Retirement capital transactions.
 
 security:
+  TBD
 
 paths:
   /insured-persons/{personId}:
@@ -376,7 +377,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/SimulationResult'
+                $ref: '#/components/schemas/SimulationResultPensionDetails'
         '401':
           $ref: '#/components/responses/standard401'
         '404':
@@ -427,7 +428,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/SimulationResult'
+                $ref: '#/components/schemas/SimulationResultPensionDetails'
         '401':
           $ref: '#/components/responses/standard401'
         '404':
@@ -1685,16 +1686,16 @@ components:
             Date when the salary change takes effect.
             If omitted: tomorrow.
 
-    SimulationResult:
+    SimulationResultPensionDetails:
       type: object
-      description: Financial effect of voluntary purchase.
+      description: Financial effect of simulation.
       required:
         - personalPensionDetailsBeforeChange
         - personalPensionDetailsAfterChange
       properties:
         personalPensionDetailsBeforeChange:
-           $ref: '#/components/schemas/PersonalPensionDetails'
-           description: Provides the personal pension details before the change (referenceDate=today)
+          $ref: '#/components/schemas/PersonalPensionDetails'
+          description: Provides the personal pension details before the change (referenceDate=today)
         personalPensionDetailsAfterChange:
           $ref: '#/components/schemas/PersonalPensionDetails'
           description: |
@@ -1909,8 +1910,7 @@ components:
           authorizationUrl: https://example.com/oauth/authorize
           tokenUrl: https://example.com/oauth/token
           scopes:
-              read:basic_pension_data: Access to basic pension data (user profile, pension statements, and transactions).
-
+            read:basic_pension_data: Access to basic pension data (user profile, pension statements, and transactions).
 
   # ---- Responses - Standard Errors Common Data Model ----
   responses: