Merge pull request #28651 from YuPengZTE/devMD002

First header should be a top level header
Upstream-commit: 48c3df015d3118b92032b7bdbf105b5e7617720d
Component: engine
This commit is contained in:
Vincent Demeester
2016-11-22 13:11:37 +01:00
committed by GitHub
4 changed files with 9 additions and 9 deletions
@@ -1,10 +1,10 @@
## Legacy API type versions
# Legacy API type versions
This package includes types for legacy API versions. The stable version of the API types live in `api/types/*.go`.
Consider moving a type here when you need to keep backwards compatibility in the API. This legacy types are organized by the latest API version they appear in. For instance, types in the `v1p19` package are valid for API versions below or equal `1.19`. Types in the `v1p20` package are valid for the API version `1.20`, since the versions below that will use the legacy types in `v1p19`.
### Package name conventions
## Package name conventions
The package name convention is to use `v` as a prefix for the version number and `p`(patch) as a separator. We use this nomenclature due to a few restrictions in the Go package name convention: