From d8e88ec37593acf27fdd48a6c3d3f65a8206ce28 Mon Sep 17 00:00:00 2001 From: EntireTwix Date: Mon, 19 Dec 2022 16:26:00 -0800 Subject: [PATCH] :memo: versioning documented --- docs/connected_services/how_to/APIs.md | 2 +- docs/versioning.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 docs/versioning.md diff --git a/docs/connected_services/how_to/APIs.md b/docs/connected_services/how_to/APIs.md index 38e6e88..e1f35e2 100644 --- a/docs/connected_services/how_to/APIs.md +++ b/docs/connected_services/how_to/APIs.md @@ -1,6 +1,6 @@ [PREVIOUS PAGE](explanation.md) | [NEXT PAGE](endpoints.md) -CCash is backwards compatible, so even if a language API does not support the newester version it can still call the old endpoints. Only when the major version increments are deprecated features made defunct (e.g `v1.0.0 -> v2.0.0`), check [endpoints.md](endpoints.md) to avoid using deprecated endpoints. +CCash is backwards compatible, so even if a language API does not support the newester version it can still call the old endpoints. Only when the major version increments are deprecated features made defunct (e.g `v1.0.0 -> v2.0.0`), check the [endpoint docs](endpoints.md) to avoid using deprecated endpoints. For more information about versioning check out [versioning docs](../../versioning.md) | author | language | | newest CCash supported version | | :------------------------------------------- | :------: | ------------------------------------------------------------------- | :----------------------------: | | [SpaceCat](https://github.com/SpaceCat-Chan) | CCLua | [CatsCCashLuaApi](https://github.com/SpaceCat-Chan/CatsCCashLuaApi) | `v1.4.3` | diff --git a/docs/versioning.md b/docs/versioning.md new file mode 100644 index 0000000..937b39a --- /dev/null +++ b/docs/versioning.md @@ -0,0 +1,12 @@ +# Versioning + +## Endpoint Version +When changing an existing endpoint in a breaking way the version will increment in the path e.g `api/v1/user/log` -> `api/v2/user/log`. If the change is non-breaking then extra parameters will simply be added to the endpoint. If the older version is marked deprecated it will be documented in [endpoints.md](connected_services/how_to/endpoints.md) + +## Release Version + +Major changes (e.g `v1.0.0` -> `v2.0.0`) denote a breaking change as all previously deprecated endpoints will now be made defunct and wont be built with that release. + +Minor changes (e.g `v1.0.0` -> `v1.1.0`) denote a non-breaking change that adds or changes something about CCash. + +Patches (e.g `v1.0.0` -> `v1.0.1`) denote bug fixes.