From e534d7161be3ff4075eb697d6fc039e5c02ccfaa Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 21 Oct 2024 09:57:47 +0200 Subject: [PATCH 1/4] OVPAY-1147 - Init. --- src/openapi/customer/customers-crud-v2.yaml | 161 ++++++++++++++++++++ 1 file changed, 161 insertions(+) create mode 100644 src/openapi/customer/customers-crud-v2.yaml diff --git a/src/openapi/customer/customers-crud-v2.yaml b/src/openapi/customer/customers-crud-v2.yaml new file mode 100644 index 0000000..1aac2d0 --- /dev/null +++ b/src/openapi/customer/customers-crud-v2.yaml @@ -0,0 +1,161 @@ +openapi: "3.0.3" +info: + title: ABT Customers CRUD APIs v2 + version: "1.0" + description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine. +servers: + - url: https://api.integratielaag.nl/v1 +paths: + /ovpaytokens: + get: + tags: + - Token + summary: Find OVpay tokens. + description: Find OVpay tokens. + parameters: + - in: query + name: ovPayTokenId + schema: + type: integer + example: 71 + required: false + description: The id of the token. + - in: query + name: customerProfileId + schema: + type: integer + example: 12 + required: false + description: The id of the customer profile. + - in: query + name: mediaTypeId + schema: + type: array + items: + type: integer + example: [1, 2] + explode: false + required: false + description: Filter on possible media types. 1 = EMV, 2 = OV-pas physical, 3 = OV-pas digital. + - in: query + name: xTat + schema: + type: string + format: uuid + example: 700b0516-bf8b-4e6e-bf16-13bfeb078e23 + explode: false + required: false + description: The XTAT of the token. + - in: query + name: xBot + schema: + type: string + format: uuid + example: de1a9a7a-a777-4473-889c-44a3bb07daae + explode: false + required: false + description: The XBOT of the token. + - in: query + name: alias + schema: + type: string + example: Mijn OV-pas + required: false + description: The alias of the token. + - in: query + name: lastDigits + schema: + type: integer + example: 3301 + required: false + description: The last digits of the token. + - in: query + name: ovpasNumber + schema: + type: string + example: 63AW974 + required: false + description: Number of the OVpas. + - in: query + name: tokenStatusId + schema: + type: array + items: + type: integer + example: [1, 2] + explode: false + required: false + description: Filter on possible token statuses. 1 = expired, 2 = active, 3 = replaced, 4 = inactive, 5 = suspended, 6 = removed by customer. + - in: query + name: expirationDate + schema: + type: string + format: date-time + example: 2029-03-22T09:00:00 + required: false + description: The expiration date of the token. + - in: query + name: replacedByTokenId + schema: + type: integer + example: 12 + required: false + description: The id of the token that replaced this token. + responses: + 200: + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + [ + { + "ovPayTokenId": 71, + "customerProfileId": 12, + "mediaTypeId": 1, + "xTat": "700b0516-bf8b-4e6e-bf16-13bfeb078e23", + "xBot": "de1a9a7a-a777-4473-889c-44a3bb07daae", + "alias": "Mijn OV-pas", + "lastDigits": 3301, + "ovpasNumber": "63AW974", + "tokenStatusId": 2, + "expirationDate": "2029-03-22T09:00:00", + "replacedByTokenId": 12, + }, + ] +components: + securitySchemes: + bearerToken: + type: http + scheme: bearer + bearerFormat: JWT + schemas: + unavailable: + type: object + rfc9457: + type: object + properties: + type: + type: string + format: url + example: https://example.com/probs/out-of-credit + title: + type: string + example: You do not have enough credit. + detail: + type: string + example: Your current balance is 30, but that costs 50. + instance: + type: string + example: /account/12345/msgs/abc + balance: + type: string + example: 30 + accounts: + type: array + items: + type: string + example: + - /account/12345 + - /account/67890 -- 2.45.2 From 3b1220456615ddfb44ad3b6cd64d3c09f940dbde Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Thu, 24 Oct 2024 15:23:09 +0200 Subject: [PATCH 2/4] OVPAY-1147 - MediaType should be TokenType. --- src/openapi/customer/customers-crud-v2.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/openapi/customer/customers-crud-v2.yaml b/src/openapi/customer/customers-crud-v2.yaml index 1aac2d0..464b49c 100644 --- a/src/openapi/customer/customers-crud-v2.yaml +++ b/src/openapi/customer/customers-crud-v2.yaml @@ -28,7 +28,7 @@ paths: required: false description: The id of the customer profile. - in: query - name: mediaTypeId + name: tokenTypeId schema: type: array items: @@ -113,13 +113,14 @@ paths: { "ovPayTokenId": 71, "customerProfileId": 12, - "mediaTypeId": 1, + "tokenType": + { "tokenTypeId": 2, "name": "OV-pas physical" }, "xTat": "700b0516-bf8b-4e6e-bf16-13bfeb078e23", "xBot": "de1a9a7a-a777-4473-889c-44a3bb07daae", "alias": "Mijn OV-pas", "lastDigits": 3301, "ovpasNumber": "63AW974", - "tokenStatusId": 2, + "tokenStatus": { "tokenStatusId": 2, "name": "Active" }, "expirationDate": "2029-03-22T09:00:00", "replacedByTokenId": 12, }, -- 2.45.2 From 330c7d1e2bda6c64b37a05b7adfa7b81322b18d6 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Thu, 24 Oct 2024 15:23:48 +0200 Subject: [PATCH 3/4] OVPAY-1147 - Typo. --- src/openapi/customer/customers-crud-v2.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/openapi/customer/customers-crud-v2.yaml b/src/openapi/customer/customers-crud-v2.yaml index 464b49c..e7ea50b 100644 --- a/src/openapi/customer/customers-crud-v2.yaml +++ b/src/openapi/customer/customers-crud-v2.yaml @@ -36,7 +36,7 @@ paths: example: [1, 2] explode: false required: false - description: Filter on possible media types. 1 = EMV, 2 = OV-pas physical, 3 = OV-pas digital. + description: Filter on possible token types. 1 = EMV, 2 = OV-pas physical, 3 = OV-pas digital. - in: query name: xTat schema: -- 2.45.2 From 8e2ad79b5309042aeb6cd26f28900bb820c9aed6 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Tue, 26 Nov 2024 15:34:55 +0100 Subject: [PATCH 4/4] OVPAY-1147 - Added pagination. --- src/openapi/customer/customers-crud-v2.yaml | 36 ++++++++++++--------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/src/openapi/customer/customers-crud-v2.yaml b/src/openapi/customer/customers-crud-v2.yaml index e7ea50b..c491563 100644 --- a/src/openapi/customer/customers-crud-v2.yaml +++ b/src/openapi/customer/customers-crud-v2.yaml @@ -109,22 +109,26 @@ paths: schema: $ref: "#/components/schemas/unavailable" example: - [ - { - "ovPayTokenId": 71, - "customerProfileId": 12, - "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, - "xTat": "700b0516-bf8b-4e6e-bf16-13bfeb078e23", - "xBot": "de1a9a7a-a777-4473-889c-44a3bb07daae", - "alias": "Mijn OV-pas", - "lastDigits": 3301, - "ovpasNumber": "63AW974", - "tokenStatus": { "tokenStatusId": 2, "name": "Active" }, - "expirationDate": "2029-03-22T09:00:00", - "replacedByTokenId": 12, - }, - ] + { + "ovPayTokens": + [ + { + "ovPayTokenId": 71, + "customerProfileId": 12, + "tokenType": + { "tokenTypeId": 2, "name": "OV-pas physical" }, + "xTat": "700b0516-bf8b-4e6e-bf16-13bfeb078e23", + "xBot": "de1a9a7a-a777-4473-889c-44a3bb07daae", + "alias": "Mijn OV-pas", + "lastDigits": 3301, + "ovpasNumber": "63AW974", + "tokenStatus": { "tokenStatusId": 2, "name": "Active" }, + "expirationDate": "2029-03-22T09:00:00", + "replacedByTokenId": 12, + }, + ], + "href": null, + } components: securitySchemes: bearerToken: -- 2.45.2