diff options
| author | Clayton Coleman <ccoleman@redhat.com> | 2015-12-20 14:36:34 -0500 |
|---|---|---|
| committer | Clayton Coleman <ccoleman@redhat.com> | 2015-12-20 14:36:34 -0500 |
| commit | ecc0cc2d5b47258f834a82fda4219767c1b0e3f8 (patch) | |
| tree | e6f9dde58e4ee967bddd135c58438dddd5af2bed | |
| parent | 437c98d858fcf5a040fe949a9e4b03651533fc0e (diff) | |
Document that int32 and int64 must be used in external types
| -rw-r--r-- | api-conventions.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/api-conventions.md b/api-conventions.md index 1fe165a6..ab049694 100644 --- a/api-conventions.md +++ b/api-conventions.md @@ -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 |