Merge pull request #178 from oleglfed/task/papi-1453

[NO-PAPI] Add preferred name to the openAPI specs

personio-personnel-data-api-oa3.yaml

@@ -232,6 +232,11 @@ paths:
                             value: Bergmann
                             type: standard
                             universal_id: last_name
+                          preferred_name:
+                            label: Name (preferred)
+                            value: Alexander Bergmann
+                            type: standard
+                            universal_id: preferred_name
                           email:
                             label: Email
                             value: [email protected]
@@ -473,6 +478,9 @@ paths:
                     last_name:
                       type: string
                       example: "Dou"
+                    preferred_name:
+                      type: string
+                      example: "John Dou"
                     gender:
                       type: string
                       example: male
@@ -532,6 +540,9 @@ paths:
                 "employee[last_name]":
                   description: Employee last name
                   type: string
+                "employee[preferred_name]":
+                  description: Employee preferred name
+                  type: string
                 "employee[gender]":
                   description: Employee gender
                   type: string
@@ -635,6 +646,9 @@ paths:
                     last_name:
                       type: string
                       example: "Dou"
+                    preferred_name:
+                      type: string
+                      example: "John Dou"
                     gender:
                       type: string
                       example: male
@@ -687,6 +701,9 @@ paths:
                 "employee[last_name]":
                   description: Employee last name
                   type: string
+                "employee[preferred_name]":
+                  description: Employee preferred name
+                  type: string
                 "employee[gender]":
                   description: Employee gender
                   type: string
@@ -777,6 +794,11 @@ paths:
                           value: Bergmann
                           type: standard
                           universal_id: last_name
+                        preferred_name:
+                          label: Name (preferred)
+                          value: Alexander Bergmann
+                          type: standard
+                          universal_id: preferred_name
                         email:
                           label: Email
                           value: [email protected]
@@ -1318,8 +1340,8 @@ paths:
                     success: true
                     data:
                       id: [
-                         1,
-                         2,
+                        1,
+                        2,
                       ]
                       message: 'success'
         "401":
@@ -3527,6 +3549,17 @@ components:
               $ref: '#/components/schemas/TypeEnum'
             universal_id:
               example: last_name
+        preferred_name:
+          type: object
+          properties:
+            label:
+              example: Name (preferred)
+            value:
+              example: Michael Dou
+            type:
+              $ref: '#/components/schemas/TypeEnum'
+            universal_id:
+              example: preferred_name
         email:
           type: object
           properties: