github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-03 01:06:27 +00:00
Code Issues Projects Releases Wiki Activity

Add step to API changes doc for swagger regen

Browse Source
This commit is contained in:
Paul Morie 2015-05-04 15:37:07 -04:00
parent dd8184247e
commit d0c8f52d9c
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/devel/api_changes.md
View File

@ -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 If you added functionality, you should consider documenting it and/or writing
an example to illustrate your change. 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 ## Incompatible API changes
If your change is going to be backward incompatible or might be a breaking change for API 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 consumers, please send an announcement to `kubernetes-dev@googlegroups.com` before