diff options
| author | Paul Morie <pmorie@redhat.com> | 2019-05-22 10:07:45 -0400 |
|---|---|---|
| committer | Paul Morie <pmorie@redhat.com> | 2019-05-22 10:07:45 -0400 |
| commit | f2ea3534886871c781fad6c16ad28d3b27e7bf0a (patch) | |
| tree | 0ee3937010661c00b8658de896910d53ec4f9412 /contributors | |
| parent | 714c3647b919bafedccd97673e5e95edc82b541d (diff) | |
Remove inconsistent use of bool as example
Diffstat (limited to 'contributors')
| -rw-r--r-- | contributors/devel/sig-architecture/api-conventions.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/contributors/devel/sig-architecture/api-conventions.md b/contributors/devel/sig-architecture/api-conventions.md index be47d470..1d47ff27 100644 --- a/contributors/devel/sig-architecture/api-conventions.md +++ b/contributors/devel/sig-architecture/api-conventions.md @@ -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. |