OVPAY-2018 - Added schemas.

src/openapi/customers/customers-crud-v2.yaml

@@ -1281,6 +1281,13 @@ paths:
             example: 5bedce29-af0c-4f3c-b182-2caa8a1f9377
           required: false
           description: The id of the device.
+        - in: query
+          name: customerProfileId
+          schema:
+            type: integer
+            example: 1
+          required: false
+          description: The id of the customer profile.
         - in: query
           name: externalDeviceId
           schema:
@@ -1296,13 +1303,6 @@ paths:
             example: iPhone prive
           required: false
           description: The alias of the device.
-        - in: query
-          name: customerProfileId
-          schema:
-            type: integer
-            example: 1
-          required: false
-          description: The id of the customer profile.
         - name: sort
           in: query
           schema:
@@ -1322,22 +1322,22 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/unavailable"
+                $ref: "#/components/schemas/getDevicesResponse"
               example:
                 {
                   "devices":
                     [
                       {
+                        "customerProfileId": 1,
                         "deviceId": "5bedce29-af0c-4f3c-b182-2caa8a1f9377",
                         "externalDeviceId": "c5545584-04af-4c60-a955-d6a70baab848",
                         "alias": "iPhone prive",
-                        "customerProfileId": 1
                       },
                       {
+                        "customerProfileId": 1,
                         "deviceId": "d7683e89-b2ad-4e79-85b3-dbb42aad0325",
                         "externalDeviceId": "7122a988-a00a-417d-a5b4-da2d91354976",
                         "alias": "iPhone zakelijk",
-                        "customerProfileId": 1
                       }
                     ],
                   "_links":
@@ -1377,7 +1377,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/unavailable"
+              $ref: "#/components/schemas/postCustomerDevice"
             examples:
               customerDevice:
                 value:
@@ -1391,7 +1391,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/unavailable"
+                $ref: "#/components/schemas/getDevices"
       security:
         - default: []
       x-auth-type: Application & Application User
@@ -1415,7 +1415,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/unavailable"
+              $ref: "#/components/schemas/patchCustomerDevice"
             examples:
               updateDevice:
                 value:
@@ -2402,6 +2402,10 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/getPhones"
+        devices:
+          type: array
+          items:
+            $ref: "#/components/schemas/getDevices"
     getAddresses:
       type: object
       properties:
@@ -2448,6 +2452,21 @@ components:
           type: integer
         name:
           type: string
+    getDevices:
+      type: object
+      properties:
+        deviceId:
+          type: string
+          format: uuid
+        externalDeviceId:
+          type: string
+          format: uuid
+        alias:
+          type: string
+      required:
+        - deviceId
+        - externalDeviceId
+        - alias
     getCustomerPreference:
       type: object
       properties:
@@ -2552,6 +2571,17 @@ components:
           type: integer
         isPreferred:
           type: boolean
+    devicePostEntity:
+      required:
+        - externalDeviceId
+        - alias
+      type: object
+      properties:
+        externalDeviceId:
+          type: string
+          format: uuid
+        alias:
+          type: string
     defaultCustomerProfileResponse:
       type: object
       properties:
@@ -2575,6 +2605,10 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/postPhoneEntity"
+        devices:
+          type: array
+          items:
+            $ref: "#/components/schemas/devicePostEntity"
     postCustomerAddress:
       type: object
       properties:
@@ -2801,6 +2835,38 @@ components:
         ovPayTokenId:
           type: integer
           example: 1
+    getDevicesResponse:
+      type: object
+      properties:
+        devices:
+          type: array
+          items:
+            $ref: "#/components/schemas/getDeviceEntity"
+    getDeviceEntity:
+      type: object
+      properties:
+        deviceId:
+          type: string
+          format: uuid
+        customerProfileId:
+          type: integer
+        externalDeviceId:
+          type: string
+          format: uuid
+        alias:
+          type: string
+      required:
+        - deviceId
+        - customerProfileId
+        - externalDeviceId
+        - alias
+    postCustomerDevice:
+      $ref: "#/components/schemas/devicePostEntity"
+    patchCustomerDevice:
+      type: object
+      properties:
+        alias:
+          type: string
     ErrorResponse:
       type: object
       properties: