github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-01 09:18:45 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #18673 from pmorie/api-changes

Browse Source 
Auto commit by PR queue bot
This commit is contained in:
k8s-merge-robot
2015-12-14 13:58:28 -08:00
parent 6cd73690e1 90df71e5a5
commit 29bc5a3639
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/devel/api_changes.md
View File

@@ -320,7 +320,8 @@ before starting "all the rest".
The struct definitions for each API are in `pkg/api/<version>/types.go`. Edit
those files to reflect the change you want to make. Note that all types and non-inline
fields in versioned APIs must be preceded by descriptive comments - these are used to generate
documentation.
documentation. Comments for types should not contain the type name; API documentation is
generated from these comments and end-users should not be exposed to golang type names.
Optional fields should have the `,omitempty` json tag; fields are interpreted as being
required otherwise.