summaryrefslogtreecommitdiff
path: root/api_changes.md
diff options
context:
space:
mode:
authorPaul Morie <pmorie@redhat.com>2015-05-04 15:37:07 -0400
committerPaul Morie <pmorie@redhat.com>2015-05-04 16:32:08 -0400
commitf3f8354b3ab7ece1e62212d12f6cdd0b21e7b6cf (patch)
treec0c63641f291e9eca630307e282d0dfaca942af9 /api_changes.md
parentc7f8e8e7f8f037b0e7d94b0e361b75ea5c50676d (diff)
Add step to API changes doc for swagger regen
Diffstat (limited to 'api_changes.md')
-rw-r--r--api_changes.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/api_changes.md b/api_changes.md
index 6c495c4c..f46d2d4e 100644
--- a/api_changes.md
+++ b/api_changes.md
@@ -301,6 +301,14 @@ you'll figure it out. Put `grep` or `ack` to good use.
If you added functionality, you should consider documenting it and/or writing
an example to illustrate your change.
+Make sure you update the swagger API spec by running:
+
+```shell
+$ hack/update-swagger-spec.sh
+```
+
+The API spec changes should be in a commit separate from your other changes.
+
## Incompatible API changes
If your change is going to be backward incompatible or might be a breaking change for API
consumers, please send an announcement to `kubernetes-dev@googlegroups.com` before