diff options
| author | Nikhita Raghunath <nikitaraghunath@gmail.com> | 2018-06-13 22:27:52 +0530 |
|---|---|---|
| committer | Nikhita Raghunath <nikitaraghunath@gmail.com> | 2018-06-13 22:27:52 +0530 |
| commit | 6fc625b0e31acf46865bfc8a4114210dca070a0a (patch) | |
| tree | ea2ca89751ae2b3779e4c0cb665e02bdd1e7bac8 | |
| parent | d251c97aff20fe94fea9761a2ce9b922e6b68239 (diff) | |
api_changes: remove proto tags from examples
Some examples have proto tags and some don't. Since proto tags are
generated and not manually written, this commit removes the proto tags
from the examples to remain consistent.
| -rw-r--r-- | contributors/devel/api_changes.md | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/contributors/devel/api_changes.md b/contributors/devel/api_changes.md index 303c43a8..4aa930a6 100644 --- a/contributors/devel/api_changes.md +++ b/contributors/devel/api_changes.md @@ -791,9 +791,9 @@ For example, consider the following object: // API v6. type Frobber struct { // height ... - Height *int32 `json:"height" protobuf:"varint,1,opt,name=height"` + Height *int32 `json:"height" // param ... - Param string `json:"param" protobuf:"bytes,2,opt,name=param"` + Param string `json:"param" } ``` @@ -803,11 +803,11 @@ A developer is considering adding a new `Width` parameter, like this: // API v6. type Frobber struct { // height ... - Height *int32 `json:"height" protobuf:"varint,1,opt,name=height"` + Height *int32 `json:"height" // param ... - Param string `json:"param" protobuf:"bytes,2,opt,name=param"` + Param string `json:"param" // width ... - Width *int32 `json:"width,omitempty" protobuf:"varint,3,opt,name=width"` + Width *int32 `json:"width,omitempty" } ``` @@ -861,13 +861,13 @@ The preferred approach adds an alpha field to the existing object, and ensures i // API v6. type Frobber struct { // height ... - Height int32 `json:"height" protobuf:"varint,1,opt,name=height"` + Height int32 `json:"height"` // param ... - Param string `json:"param" protobuf:"bytes,2,opt,name=param"` + Param string `json:"param"` // width indicates how wide the object is. // This field is alpha-level and is only honored by servers that enable the Frobber2D feature. // +optional - Width *int32 `json:"width,omitempty" protobuf:"varint,3,opt,name=width"` + Width *int32 `json:"width,omitempty"` } ``` @@ -934,15 +934,15 @@ In future Kubernetes versions: Another option is to introduce a new type with an new `alpha` or `beta` version designator, like this: -``` +```go // API v7alpha1 type Frobber struct { // height ... - Height *int32 `json:"height" protobuf:"varint,1,opt,name=height"` + Height *int32 `json:"height"` // param ... - Param string `json:"param" protobuf:"bytes,2,opt,name=param"` + Param string `json:"param"` // width ... - Width *int32 `json:"width,omitempty" protobuf:"varint,3,opt,name=width"` + Width *int32 `json:"width,omitempty"` } ``` |
