From 9a724e347739b75a19af54038e01555b550f2cb5 Mon Sep 17 00:00:00 2001 From: Erwin Morrhey Date: Fri, 24 Jan 2025 09:32:47 +0100 Subject: [PATCH 1/2] =?UTF-8?q?UPS-4849=20use=20explicit=20model=20because?= =?UTF-8?q?=20new=20inline=20models=20mess=20up=20code=20ge=E2=80=A6=20(#4?= =?UTF-8?q?20)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * UPS-4849 use explicit model because new inline models mess up code generation * fix dead link --- projects/api-design-guidelines/docs/rest.md | 2 +- projects/uitpas/reference/uitpas.json | 33 +++++++++++++-------- 2 files changed, 21 insertions(+), 14 deletions(-) diff --git a/projects/api-design-guidelines/docs/rest.md b/projects/api-design-guidelines/docs/rest.md index 89245f38..3ab33123 100644 --- a/projects/api-design-guidelines/docs/rest.md +++ b/projects/api-design-guidelines/docs/rest.md @@ -117,7 +117,7 @@ The `PATCH` method is used to do partial updates of existing resources on an API This contrasts with `PUT` which does updates using a complete representation of the resource, and must always be idempotent. -The `PATCH` method should be avoided on APIs built by/for publiq, until we have agreed on a standardized approach like using [JSON PATCH](http://jsonpatch.com/) or [Merge PATCH](https://datatracker.ietf.org/doc/rfc7396/). +The `PATCH` method should be avoided on APIs built by/for publiq, until we have agreed on a standardized approach like [Merge PATCH](https://datatracker.ietf.org/doc/rfc7396/). **DELETE** diff --git a/projects/uitpas/reference/uitpas.json b/projects/uitpas/reference/uitpas.json index 9d5a0998..b15e4dd3 100644 --- a/projects/uitpas/reference/uitpas.json +++ b/projects/uitpas/reference/uitpas.json @@ -1602,19 +1602,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "downloadLink": { - "type": "string", - "x-stoplight": { - "id": "g8c5z7be3lp76" - }, - "description": "Download link for the QR checkin code" - } - }, - "required": [ - "downloadLink" - ] + "$ref": "#/components/schemas/DownloadLinkResponse" }, "examples": { "Example": { @@ -9345,6 +9333,25 @@ "required": [ "pictureUrl" ] + }, + "DownloadLinkResponse": { + "title": "DownloadLinkResponse", + "x-stoplight": { + "id": "a922luo99cksx" + }, + "type": "object", + "properties": { + "downloadLink": { + "type": "string", + "x-stoplight": { + "id": "3opxrhpcw3s6u" + }, + "description": "Download link for the requested file" + } + }, + "required": [ + "downloadLink" + ] } }, "securitySchemes": { From 3b52f87234283d5c54e6c00b393c90bff8e6d7cb Mon Sep 17 00:00:00 2001 From: Erwin Morrhey Date: Fri, 24 Jan 2025 13:09:07 +0100 Subject: [PATCH 2/2] UPS-4849 document extra permissions (#421) --- projects/uitpas/reference/uitpas.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/projects/uitpas/reference/uitpas.json b/projects/uitpas/reference/uitpas.json index b15e4dd3..2a64bc6b 100644 --- a/projects/uitpas/reference/uitpas.json +++ b/projects/uitpas/reference/uitpas.json @@ -1595,7 +1595,7 @@ ], "get": { "summary": "Get event QR checkin code as download link", - "operationId": "get-events-qr-checkincdes-downloadlink", + "operationId": "get-events-qr-checkincodes-downloadlink", "responses": { "200": { "description": "OK", @@ -7293,6 +7293,7 @@ "TICKETSALES_REGISTER", "EVENTS_UPDATE", "EVENTS_READ", + "EVENTS_QR_CHECKINCODE", "CHECKINS_WRITE", "ORGANIZERS_SEARCH", "ORGANIZERS_REPORTS", @@ -7341,6 +7342,7 @@ "TICKETSALES_REGISTER", "EVENTS_UPDATE", "EVENTS_READ", + "EVENTS_QR_CHECKINCODE", "CHECKINS_WRITE", "ORGANIZERS_SEARCH", "ORGANIZERS_REPORTS",