From d0c8f52d9cc65faa4d2fc0453955d400fa0ea6f5 Mon Sep 17 00:00:00 2001 From: Paul Morie Date: Mon, 4 May 2015 15:37:07 -0400 Subject: [PATCH] Add step to API changes doc for swagger regen --- docs/devel/api_changes.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/devel/api_changes.md b/docs/devel/api_changes.md index 6c495c4ce21..f46d2d4e1e2 100644 --- a/docs/devel/api_changes.md +++ b/docs/devel/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