github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #18941 from smarterclayton/document_typed_ints 

Auto commit by PR queue bot
pull/6/head
k8s-merge-robot 2015-12-21 12:16:47 -08:00
parent 29754318ad a79dc07e07
commit c59fad149b
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/devel/api-conventions.md
View File

@ -256,6 +256,7 @@ This rule maintains the invariant that all JSON/YAML keys are fields in API obje
* Do not use unsigned integers, due to inconsistent support across languages and libraries. Just validate that the integer is non-negative if that's the case.
* Do not use enums. Use aliases for string instead (e.g., `NodeConditionType`).
* Look at similar fields in the API (e.g., ports, durations) and follow the conventions of existing fields.
* All public integer fields MUST use the Go `(u)int32` or Go `(u)int64` types, not `(u)int` (which is ambiguous depending on target platform). Internal types may use `(u)int`.
#### Constants