ComputerSurge/shields
3
0
Fork 0
Code Pull Requests 1 Activity

link to mterczynski.pl/joi-schema-generator in validation docs (#9700)

Browse Source
This commit is contained in:
chris48s
2023-12-23 00:20:10 +00:00
committed by GitHub
parent d0bdb8244c
commit 595a9a90b7
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/input-validation.md
View File

@@ -24,6 +24,8 @@ When we receive input data from an upstream API, we perform input validation to:
- We don't need to validate characteristics we don't rely on. For example, if we're just going to render a version on a badge with the same exact value from the API response and do not need to sort or transform the value, then it doesn't matter what format the version number is in. We can use a very relaxed schema to validate in this case, e.g. `Joi.string().required()`
- http://mterczynski.pl/joi-schema-generator/ is a tool that can be used to reverse engineer a schema from an API response. This can be a great starting point to tweak from. If using this as a starting point, remember to remove fields we don't rely on to render a badge.
- If theory (docs) and practice (real-world API responses) conflict, real-world outputs take precedence over documented behaviour. e.g: if the docs say version is a semver but we learn that there are real-world packages where the version number is `0.3b` or `1.2.1.27` then we should accept those values in preference to enforcing the documented API behaviour.
- Shields is descriptive rather than prescriptive. We reflect the established norms of the communities we serve.