Tripletex / Tripletex/tripletex-api2
Document constraints for api model fields to avoid errors when posting to the API
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 49
- Forks
- 47
- Avg merge
- 1h 1m
- Merged PRs (30d)
- 1
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the API documentation for POST /product and the productnumber field. Review the documented constraints and determine where valid and invalid characters are defined; the work is done when partners can identify the accepted characters and avoid rejected product transfers.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100