HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases 1 Wiki Activity

OVPAY-1499 - Updated HTTP error message examples.

Browse Source
This commit is contained in:
Bas Boterman 2025-12-04 11:38:46 +01:00
parent b4f2d378a2
commit 5672c93715
1 changed files with 76 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

146
src/openapi/orders/service_engine_orders.yaml
View File

@ -721,23 +721,17 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"type": "https://htm.nl/api/v1/probs/validationerror", "type": "https://htm.nl/api/v1/probs/400/badrequest",
"title": "Your request is not valid.", "title": "Your request is not valid.",
"detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", "detail": "One or more required attributes are missing or invalid.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors": "errors":
[ [
{ {
"detail": "Startdate of this product should be at most 60 days in the future.", "code": "REQUIRED_ATTRIBUTE_MISSING",
"pointer": "#/0/startDate", "detail": "One ore more required attributes are missing.",
"ovPayTokenId": 123, "pointer": "$.orderLines[0].productId",
"productId": 2, "parameter": null,
},
{
"detail": "Combination of product and token type is not valid.",
"pointer": "#/1/ovPayTokenId",
"ovPayTokenId": 123,
"productId": 3,
}, },
], ],
} }
@ -1569,23 +1563,17 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"type": "https://htm.nl/api/v1/probs/validationerror", "type": "https://htm.nl/api/v1/probs/400/badrequest",
"title": "Your request is not valid.", "title": "Your request is not valid.",
"detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", "detail": "One or more required attributes are missing or invalid.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors": "errors":
[ [
{ {
"detail": "Startdate of this product should be at most 60 days in the future.", "code": "REQUIRED_ATTRIBUTE_MISSING",
"pointer": "#/0/startDate", "detail": "One ore more required attributes are missing.",
"ovPayTokenId": 123, "pointer": "$.orderLines[0].productId",
"productId": 2, "parameter": null,
},
{
"detail": "Combination of product and token type is not valid.",
"pointer": "#/1/ovPayTokenId",
"ovPayTokenId": 123,
"productId": 3,
}, },
], ],
} }
@ -1605,7 +1593,7 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"type": "https://htm.nl/api/v1/probs/validationerror", "type": "https://htm.nl/api/v1/probs/400/badrequest",
"title": "Your request is not valid.", "title": "Your request is not valid.",
"detail": "The order can not be deleted.", "detail": "The order can not be deleted.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
@ -2061,23 +2049,17 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"type": "https://htm.nl/api/v1/probs/validationerror", "type": "https://htm.nl/api/v1/probs/400/badrequest",
"title": "Your request is not valid.", "title": "Your request is not valid.",
"detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", "detail": "One or more required attributes are missing or invalid.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors": "errors":
[ [
{ {
"detail": "Startdate of this product should be at most 60 days in the future.", "code": "REQUIRED_ATTRIBUTE_MISSING",
"pointer": "#/0/startDate", "detail": "One ore more required attributes are missing.",
"ovPayTokenId": 123, "pointer": "$.orderLines[0].productId",
"productId": 2, "parameter": null,
},
{
"detail": "Combination of product and token type is not valid.",
"pointer": "#/1/ovPayTokenId",
"ovPayTokenId": 123,
"productId": 3,
}, },
], ],
} }
@ -2230,17 +2212,17 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"type": "https://htm.nl/api/v1/probs/validationerror", "type": "https://htm.nl/api/v1/probs/400/badrequest",
"title": "Your request is not valid.", "title": "Your request is not valid.",
"detail": "The start date of the product is not allowed. See errors for more details.", "detail": "One or more required attributes are missing or invalid.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors": "errors":
[ [
{ {
"detail": "Startdate of this product should be at most 60 days in the future.", "code": "REQUIRED_ATTRIBUTE_MISSING",
"pointer": "#/0/startDate", "detail": "One ore more required attributes are missing.",
"ovPayTokenId": 123, "pointer": "$.orderLines[0].productId",
"productId": 2, "parameter": null,
}, },
], ],
} }
@ -2304,17 +2286,17 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"type": "https://htm.nl/api/v1/probs/validationerror", "type": "https://htm.nl/api/v1/probs/400/badrequest",
"title": "Your request is not valid.", "title": "Your request is not valid.",
"detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", "detail": "One or more required attributes are missing or invalid.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors": "errors":
[ [
{ {
"detail": "Product requires product with productId=2", "code": "REQUIRED_ATTRIBUTE_MISSING",
"pointer": "#/1/orderLine", "detail": "One ore more required attributes are missing.",
"orderLineId": "0574440e-7fa0-401f-b907-539c91633a5d", "pointer": "$.orderLines[0].productId",
"productId": 3, "parameter": null,
}, },
], ],
} }
@ -5320,17 +5302,17 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
example: example:
{ {
"type": "https://htm.nl/api/v1/probs/validationerror", "type": "https://htm.nl/api/v1/probs/400/badrequest",
"title": "Your request is not valid.", "title": "Your request is not valid.",
"detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.", "detail": "One or more required attributes are missing or invalid.",
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"errors": "errors":
[ [
{ {
"detail": "Product requires product with productId=2", "code": "REQUIRED_ATTRIBUTE_MISSING",
"pointer": "#/1/orderLine", "detail": "One ore more required attributes are missing.",
"orderLineId": "0574440e-7fa0-401f-b907-539c91633a5d", "pointer": "$.orderLines[0].productId",
"productId": 3, "parameter": null,
}, },
], ],
} }
@ -5444,21 +5426,37 @@ paths:
summary: Missing parameter(s) summary: Missing parameter(s)
value: value:
{ {
"type": "https://www.htm.nl/api/v1/400Error", "type": "https://htm.nl/api/v1/probs/400/badrequest",
"title": "Missing parameter(s)", "title": "Your request is not valid.",
"detail": "At least one of the following parameters must be present: birthDate, ovPayTokenId, customerTokenId, (serviceReferenceId and amount), (ovpasNumber and verificationCode)", "detail": "One or more required parameters are missing or invalid.",
"instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"apiErrorCode": "htm.api.err.400.2", "errors":
[
{
"code": "REQUIRED_PARAMETER_MISSING",
"detail": "One ore more required parameters are missing.",
"pointer": null,
"parameter": "birthdate, ovPayTokenId, customerTokenId",
},
],
} }
Invalid date format: Invalid date format:
summary: Invalid date format summary: Invalid date format
value: value:
{ {
"type": "https://www.htm.nl/api/v1/400Error", "type": "https://htm.nl/api/v1/probs/400/badrequest",
"title": "Invalid input", "title": "Your request is not valid.",
"detail": "The given birthDate is not a valid Date format", "detail": "One or more parameters have an invalid format.",
"instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"apiErrorCode": "htm.api.err.400.3", "errors":
[
{
"code": "INVALID_PARAMETER_FORMAT",
"detail": "The given birthdate is not a valid Date format.",
"pointer": null,
"parameter": "birthdate",
},
],
} }
"404": "404":
description: Not found description: Not found
@ -5471,11 +5469,19 @@ paths:
summary: No birthdate present in PAD of OVpay token summary: No birthdate present in PAD of OVpay token
value: value:
{ {
"type": "https://www.htm.nl/api/v1/404Error", "type": "https://htm.nl/api/v1/probs/404/notfound",
"title": "Missing birthdate in PAD", "title": "Missing birthdate in PAD.",
"detail": "There is no birthdate present in the PAD of the OVpay token, or there is no PAD present at all", "detail": "There is no birthdate present in the PAD of the OVpay token, or there is no PAD present at all.",
"instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c", "instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
"apiErrorCode": "htm.api.err.404.1", "errors":
[
{
"code": "MISSING_BIRTHDATE_IN_PAD",
"detail": "Missing birthdate in PAD.",
"pointer": null,
"parameter": "birthdate",
},
],
} }
components: components:
securitySchemes: securitySchemes: