kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove inconsistent use of bool as example

This commit is contained in:
Paul Morie 2019-05-22 10:07:45 -04:00
parent 714c3647b9
commit f2ea353488
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
contributors/devel/sig-architecture/api-conventions.md
View File

@ -618,7 +618,7 @@ Fields must be either optional or required.
Optional fields have the following properties:
- They have the `+optional` comment tag in Go.
- They are a pointer type in the Go definition (e.g. `bool *awesomeFlag`) or
- They are a pointer type in the Go definition (e.g. `AwesomeFlag *SomeFlag`) or
have a built-in `nil` value (e.g. maps and slices).
- The API server should allow POSTing and PUTing a resource with this field
unset.
@ -637,7 +637,7 @@ Required fields have the opposite properties, namely:
- They do not have an `+optional` comment tag.
- They do not have an `omitempty` struct tag.
- They are not a pointer type in the Go definition (e.g. `bool otherFlag`).
- They are not a pointer type in the Go definition (e.g. `AnotherFlag SomeFlag`).
- The API server should not allow POSTing or PUTing a resource with this field
unset.