diff options
| author | k8s-ci-robot <k8s-ci-robot@users.noreply.github.com> | 2018-05-18 10:51:52 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-18 10:51:52 -0700 |
| commit | 7183df1559ba99a286cd7636a0bb70228e690486 (patch) | |
| tree | d1ad3ac14496b95bace1458038457489680704f1 | |
| parent | eed98fee853fa5e7ac0737a75048e17fc3ad5839 (diff) | |
| parent | c63e62b58e791fb2fdbc048182674ee9b2a4b152 (diff) | |
Merge pull request #2146 from austbot/location-typo-apichange-docs
Fix incorrect path in api_changes doc
| -rw-r--r-- | contributors/devel/api_changes.md | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/contributors/devel/api_changes.md b/contributors/devel/api_changes.md index a111a98a..303c43a8 100644 --- a/contributors/devel/api_changes.md +++ b/contributors/devel/api_changes.md @@ -365,10 +365,14 @@ being required otherwise. ### Edit defaults.go If your change includes new fields for which you will need default values, you -need to add cases to `pkg/apis/<group>/<version>/defaults.go` (the core v1 API -is special, its defaults.go is at `pkg/api/v1/defaults.go`. For simplicity, we -will not mention this special case in the rest of the article). Of course, since -you have added code, you have to add a test: +need to add cases to `pkg/apis/<group>/<version>/defaults.go` + +*Note:* In the past the core v1 API +was special. Its `defaults.go` used to live at `pkg/api/v1/defaults.go`. +If you see code referencing that path, you can be sure its outdated. Now the core v1 api lives at +`pkg/apis/core/v1/defaults.go` which follows the above convention. + +Of course, since you have added code, you have to add a test: `pkg/apis/<group>/<version>/defaults_test.go`. Do use pointers to scalars when you need to distinguish between an unset value |