src/openapi/contracts/contracts-se.yaml

@@ -27,7 +27,13 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/unavailable"
-              example:
+              examples:
+                List all contracts for a single customer profile:
+                  summary: List all contracts for a single customer profile
+                  description: |
+                    List all contracts for single customer profile with customer
+                    number 'D123456'.
+                  value:
                     [
                       {
                         "contractId": "5a3876a1-e9a1-4278-8983-4679a8d583c2",
@@ -49,7 +55,7 @@ paths:
                           {
                             "get_token":
                               {
-                            "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/tokens?ovPayTokenId=1337",
+                                "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens?ovPayTokenId=1337",
                                 "method": "GET",
                               },
                           },
@@ -61,7 +67,8 @@ paths:
                         "orderId": "945d43e6-516e-425b-8847-9aba41289acd",
                         "orderLineId": "42f68042-908f-41f4-9d9b-4cab843ff0e8",
                         "touchpointId": 2,
-                    "contractStatus": { "contractStatusId": 1, "name": "new" },
+                        "contractStatus":
+                          { "contractStatusId": 1, "name": "new" },
                         "productId": 1,
                         "productName": "HTM Maand 20% korting",
                         "termDuration": "P0Y1M0D",
@@ -73,7 +80,7 @@ paths:
                           {
                             "get_token":
                               {
-                            "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/tokens?ovPayTokenId=1338",
+                                "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens?ovPayTokenId=1338",
                                 "method": "GET",
                               },
                           },
@@ -130,7 +137,13 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/unavailable"
-              example:
+              examples:
+                Full contract details of a single contract:
+                  summary: Full contract details of a single contract
+                  description: |
+                    Full contract details of a single contract with contract
+                    number 'D123456'.
+                  value:
                     {
                       "contractId": "5a3876a1-e9a1-4278-8983-4679a8d583c2",
                       "contractNumber": "D123456",
@@ -138,7 +151,8 @@ paths:
                       "orderId": "eb3d08f7-7feb-4f31-9f5b-daa634e51f48",
                       "orderLineId": "52efbbfc-8c28-4016-9ece-dc3ef9a70bd8",
                       "touchpointId": 2,
-                  "contractStatus": { "contractStatusId": 2, "name": "active" },
+                      "contractStatus":
+                        { "contractStatusId": 2, "name": "active" },
                       "productId": 1,
                       "productName": "HTM Maand 20% korting",
                       "termDuration": "P0Y1M0D",
@@ -171,7 +185,8 @@ paths:
                         [
                           {
                             "contractActionId": "67687851-59dd-4bbc-aa74-0f7abd26c883",
-                        "actionType": { "actionTypeId": 1, "name": "create" },
+                            "actionType":
+                              { "actionTypeId": 1, "name": "create" },
                             "user": "subid123456",
                             "timestamp": "2024-07-02 15:01:00.000",
                             "details": "Contract created",
@@ -179,7 +194,8 @@ paths:
                           },
                           {
                             "contractActionId": "ea9ad287-9cd3-4e76-bcb9-d71db551cf55",
-                        "actionType": { "actionTypeId": 2, "name": "change" },
+                            "actionType":
+                              { "actionTypeId": 2, "name": "change" },
                             "user": "subid123456",
                             "timestamp": "2024-07-03 15:01:00.000",
                             "details": "Contract changed",
@@ -203,7 +219,7 @@ paths:
                         {
                           "get_token":
                             {
-                          "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/tokens?ovPayTokenId=1337",
+                              "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/tokens?ovPayTokenId=1337",
                               "method": "GET",
                             },
                         },
@@ -237,7 +253,13 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/unavailable"
-              example:
+              examples:
+                Get all invoices of a single contract:
+                  summary: Get all invoices of a single contract
+                  description: |
+                    Get all invoices of a single contract with contract number
+                    'D123456'.
+                  value:
                     [
                       {
                         "contractInvoiceId": "8699d72a-cf4d-4e6b-9e9c-549d837ca51f",
@@ -291,7 +313,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/unavailable"
-              example:
+              examples:
+                All cancellation moments of a term bound contract:
+                  summary: All cancellation moments of a term bound contract
+                  description: |
+                    All cancellation moments of a term bound contract.
+                  value:
                     {
                       "cancellationMoment": "termBound",
                       "termDuration": "P1M",
@@ -327,7 +354,12 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/unavailable"
-            example: { "end": "2024-08-10T00:00:00" }
+            examples:
+              Validate a cancellation of a given end date: 
+                summary: Validate a cancellation of a given end date
+                description: |
+                  Validate a cancellation of a given end date.
+                value: { "end": "2024-08-10T00:00:00" }
       responses:
         "200":
           description: OK
@@ -335,14 +367,32 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/unavailable"
-              example:
+              examples:
+                Successfully validated cancellation:
+                  summary: Successfully validated cancellation
+                  description: |
+                    Successfully validated a cancellation. The response contains
+                    the refund amount and refund methods.
+                  value:
                     {
-                  "validationResult": "true",
+                      "validationResult": true,
                       "validationMessage": "",
                       "end": "2024-08-10T03:59:59",
-                  "refundAmount": "2489",
+                      "refundAmount": 2489,
                       "refundMethods": ["creditInvoice", "iDeal"],
                     }
+                Unsuccesful validation:
+                  summary: Unsuccesful validation
+                  description: |
+                    Unsuccesful validation. The response contains the error message.
+                  value:
+                    {
+                      "validationResult": false,
+                      "validationMessage": "Cancellation end date not allowed",
+                      "end": null,
+                      "refundAmount": null,
+                      "refundMethods": [],
+                    }
   /contracts/{contractId}/cancellation:
     parameters:
       - in: header
@@ -371,7 +421,12 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/unavailable"
-            example:
+            examples:
+              Cancellation request for credit invoice:
+                summary: Cancellation request for credit invoice
+                description: |
+                  Cancellation request for credit invoice.
+                value:
                   { "end": "2024-08-10T00:00:00", "refundMethod": "creditInvoice" }
       responses:
         "200":
@@ -380,10 +435,16 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/unavailable"
-              example:
+              examples:
+                Successfully cancelled contract:
+                  summary: Successfully cancelled contract
+                  description: |
+                    Successfully cancelled a contract. The response contains
+                    the refund amount and refund method.
+                  value:
                     {
                       "end": "2024-08-10T03:59:59",
-                  "refundAmount": "2489",
+                      "refundAmount": 2489,
                       "refundMethod": "creditInvoice",
                     }
 components: