diff --git a/src/openapi/apim/TP-PAD.yaml b/src/openapi/apim/TP-PAD.yaml index 2e70980..fe2ae98 100644 --- a/src/openapi/apim/TP-PAD.yaml +++ b/src/openapi/apim/TP-PAD.yaml @@ -1,21 +1,21 @@ openapi: 3.0.1 info: - title: Personal Account Data (PAD) APIs for TouchPoint - description: >- + title: Personal Account Data (PAD) APIs for touchpoints + description: |- + APIs for touchpoints to manage Personal Account Data (PAD) on OVpay tokens (xTATs).\ These APIs connect directly to the PADP APIs in GBO APIM and are implemented in Logic Apps in the Integration Layer. version: '1.0' servers: - url: https://api.integratielaag.nl/abt/touchpoint/1.0 - description: API ABT GBO APIM tags: - - name: Personal Data APIs for TouchPoint - description: Personal Data APIs for TouchPoint, no Service Engine in between! + - name: Personal Data APIs for touchpoints + description: Personal Data APIs for touchpoints, no Service Engine in between! paths: /personal-data/{xtat}: post: tags: - - Personal Data APIs for TouchPoint + - Personal Data APIs for touchpoints summary: Add the supplied Personal Data to the given xTAT (that should not contain any Personal Data yet). description: |- - The given xTAT should not contain any Personal Data yet (the PATCH endpoint should be used in that case) - if the given xTAT already contains Personal Data, an error is thrown; @@ -90,7 +90,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' get: tags: - - Personal Data APIs for TouchPoint + - Personal Data APIs for touchpoints summary: Retrieve the decrypted Personal Data for the given xTAT, using the OTP for verification of ownership. description: OTP challenge is required to retrieve the Personal Data. operationId: GetDecryptedPersonalData @@ -137,7 +137,7 @@ paths: $ref: '#/components/schemas/ErrorResponse' patch: tags: - - Personal Data APIs for TouchPoint + - Personal Data APIs for touchpoints summary: Update the supplied personal data for the given xTAT, using the OTP for verification of ownership. description: This is a PATCH call, so only the personal data that the user desires to change need to be supplied. Integration layer supplements with any other existing personal data to be able to call GBO (PUT call). operationId: UpdatePersonalData @@ -184,7 +184,7 @@ paths: /personal-data/generate-otp: get: tags: - - Personal Data APIs for TouchPoint + - Personal Data APIs for touchpoints summary: Trigger OTP email for the given xTAT or e-mail address, to prove ownership operationId: GenerateOtp description: |-