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

Document constraints for api model fields to avoid errors when posting to the API #66

Open
madsoliver opened this issue Sep 23, 2022 · 0 comments

Comments

@madsoliver
Copy link

Example today:

POST /product
field: number 
constaints: 
string
maxLength: 100

... It should also contain what chars are valid and not ...

I have clients that have experienced issues when transferring products that have productnumber that is a string with max 100 chars, but have invalid characters. There was no understandable error message. We therefore needed to add a strict filter at our end to avoid products not being transferred. Since we dont know what the constraints really are.
Documenting invalid characters in the API doc will help partners a lot avoiding bad transfers.

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

No branches or pull requests

1 participant