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