Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Jan 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 36 additions & 3 deletions personio-personnel-data-api-oa3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,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]
Expand Down Expand Up @@ -338,6 +343,9 @@ paths:
last_name:
type: string
example: "Dou"
preferred_name:
type: string
example: "John Dou"
gender:
type: string
example: male
Expand Down Expand Up @@ -397,6 +405,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
Expand Down Expand Up @@ -500,6 +511,9 @@ paths:
last_name:
type: string
example: "Dou"
preferred_name:
type: string
example: "John Dou"
gender:
type: string
example: male
Expand Down Expand Up @@ -552,6 +566,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
Expand Down Expand Up @@ -642,6 +659,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]
Expand Down Expand Up @@ -1179,8 +1201,8 @@ paths:
success: true
data:
id: [
1,
2,
1,
2,
]
message: 'success'
"400":
Expand Down Expand Up @@ -2535,7 +2557,7 @@ paths:
type: integer
example: 10
required: false
description: This endpoint provides you with the data of an existing Custom Report.
description: This endpoint provides you with the data of an existing Custom Report.
operationId: listReportItems
responses:
200:
Expand Down Expand Up @@ -3334,6 +3356,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:
Expand Down
Loading