Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Validate POST/PATCH payloads for required data and correct formatting #274

Open
whyscream opened this issue Nov 8, 2022 · 0 comments
Open

Comments

@whyscream
Copy link
Contributor

whyscream commented Nov 8, 2022

The current client does not check POST/PATCH payloads at all, they're sent to the API as-is, and the API will validate the contents, possibly returning an error. We could apply basic checks on the payload before sending it to the Mollie API:

  • Are all required keys for the request set?
  • Are all values in the correct data type?
  • Possibly: are values correctly formatted?

Example: for the Create Payment call, we could validate:

  • Are the required keys (amount, description, redirectUrl) in the payload all set?
  • For the amount field: is it a dict, with keys currency and value? Is the currency a non-empty string? Is the value a string, and is it a correctly formatted amount?
  • For the description field: is it a non-empty string?
  • For the redirectUrl field: is it a non-empty string, and formatted as a correct URI?
  • For the optional webhookUrl field: if set in the request, is it a non-empty string and formatted as a correct URI?
  • For the optional locale field: if set in the request, is it a non-empty string?
  • etc ...

All of this could be validated easily using tools like pydantic, marshmallow or jsonschema. With local validation, we could provide the developer with better error messages than the API provides (not checked yet), and we avoid invalid calls to the API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant