From 25321aa18e44ce1f0b5c14410aa8864a3313f8b7 Mon Sep 17 00:00:00 2001 From: Daniel Kudwien Date: Mon, 10 Jan 2022 19:44:09 +0100 Subject: [PATCH] Fixed docs for offset and limit parameters of Absences. - The `offset` parameter is based on `1`. Passing `0` is automatically converted into `1` in the API. This results in duplicate response data when the client is counting up `$offset++`, as the client is first passing `0` then `1`. - The `offset` parameter indicates the "page" to retrieve, chunked by `limit`. --- personio-personnel-data-api-oa3.yaml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/personio-personnel-data-api-oa3.yaml b/personio-personnel-data-api-oa3.yaml index ef8e990..a111291 100644 --- a/personio-personnel-data-api-oa3.yaml +++ b/personio-personnel-data-api-oa3.yaml @@ -1388,19 +1388,20 @@ paths: - name: limit in: query required: false - description: Pagination attribute to limit how many attendances is returning per page + description: Pagination attribute to limit how many absences to return per page. Maximum is 200. schema: type: integer minimum: 1 + maximum: 200 default: 200 - name: offset in: query required: false - description: Pagination attribute to identify which page you are requesting, by the form of telling an offset from the first record that would be returned. + description: Pagination attribute to identify which page to request from the chunks indicated by `limit`. The value `0` is interpreted as page `1`. You cannot pass a value larger than the available amount of pages, as returned by the `total_pages` meta data in the response. schema: type: integer - minimum: 0 - default: 0 + minimum: 1 + default: 1 responses: "200": description: ""