diff options
| author | Paul Morie <pmorie@redhat.com> | 2015-12-14 15:03:21 -0500 |
|---|---|---|
| committer | Paul Morie <pmorie@redhat.com> | 2015-12-14 15:03:21 -0500 |
| commit | ad6bfda32161984d88dd14e8c3c43a739f4db2d4 (patch) | |
| tree | f2433c255fc0c9be22c89a79a5da50912d5917e4 /api_changes.md | |
| parent | a64798d24c9ce71c4843327fd2a090771f7b74c4 (diff) | |
Add note about type comments to API changes doc
Diffstat (limited to 'api_changes.md')
| -rw-r--r-- | api_changes.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/api_changes.md b/api_changes.md index 4bbb5bd4..d2f0aea7 100644 --- a/api_changes.md +++ b/api_changes.md @@ -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. |