Update api versioning

This commit is contained in:
2019-05-13 22:07:44 +10:00
parent f32abcf08b
commit 44fe9a2dea
+13
View File
@@ -129,6 +129,19 @@ redoc-cli bundle swagger.json
```
Some sample swagger files: <http://rackerlabs.github.io/wadl2swagger/openstack.html>
## Versioning
### Proper define the version of your application
According to [semver](https://semver.org/), the following is the general guideline.
> Given a version number MAJOR.MINOR.PATCH, increment the:
>
> 1. MAJOR version when you make incompatible API changes,
> 2. MINOR version when you add functionality in a backwards-compatible manner, and
> 3. PATCH version when you make backwards-compatible bug fixes.
> Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
# Log and Error
## Sentry