versia-pub/docs
2
0
Fork 0
mirror of https://github.com/versia-pub/docs.git synced 2025-12-06 14:28:20 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: 📝 Specify number precision validation in docs

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-07-27 15:50:58 +02:00
parent cfd818c2ba
commit 2b8e2f087a
No known key found for this signature in database
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
app/federation/validation/page.mdx
View file

@ -25,6 +25,9 @@ Things that should be validated include, but are not limited to:
- If you do set limits, they should be reasonable and well-documented. - If you do set limits, they should be reasonable and well-documented.
- The **type**, **precision** and **scale** of all numeric fields. - The **type**, **precision** and **scale** of all numeric fields.
- For example, a `size` field on a `ContentFormat` structure should be a positive integer, not a negative number or a floating-point number. - For example, a `size` field on a `ContentFormat` structure should be a positive integer, not a negative number or a floating-point number.
<Note>
All numeric fields in these docs have the appropriate precision (`u64`, `i64`, `f32`, etc.) specified. Do not use a different type in memory than the one specified in the docs.
</Note>
- The **validity** of all URLs and URIs (run them through your favorite URL parser). - The **validity** of all URLs and URIs (run them through your favorite URL parser).
- The **time** of all dates and times (people should not be born in the future, or in the year 0). - The **time** of all dates and times (people should not be born in the future, or in the year 0).