diff --git a/README.rst b/README.rst index 6ccbed4315..d46de6a37a 100644 --- a/README.rst +++ b/README.rst @@ -46,52 +46,11 @@ Component This component includes the **Open Forms Admin UI** and the **Open Forms API**. -API specification ------------------ - -============== ============== ============================= -Version Release date API specification -============== ============== ============================= -latest n/a `ReDoc `_, - `Swagger `_ -2.5.0 2024-01-25 `ReDoc `_, - `Swagger `_ -2.4.0 2023-11-09 `ReDoc `_, - `Swagger `_ -2.3.1 2023-09-25 `ReDoc `_, - `Swagger `_ -2.3.0 2023-08-24 `ReDoc `_, - `Swagger `_ -2.2.1 2023-09-25 `ReDoc `_, - `Swagger `_ -2.2.0 2023-06-23 `ReDoc `_, - `Swagger `_ -============== ============== ============================= - -Previous versions are supported for 6 months after the next version is released. - -See: `All versions and changes `_ - -**Unsuported versions** - -============== ============== ============================= -Version Release date API specification -============== ============== ============================= -2.1.1 2023-09-25 `ReDoc `_, - `Swagger `_ -2.1.0 2023-03-03 `ReDoc `_, - `Swagger `_ -2.0.1 2023-09-25 `ReDoc `_, - `Swagger `_ -2.0.0 2022-10-26 `ReDoc `_, - `Swagger `_ -1.1.1 2022-06-21 `ReDoc `_, - `Swagger `_ -1.0.1 2022-05-16 `ReDoc `_, - `Swagger `_ -1.0.0 2022-03-10 `ReDoc `_, - `Swagger `_ -============== ============== ============================= +API Specifications +------------------ + +These can be found in the `documentation `_ + References ========== diff --git a/docs/developers/versioning.rst b/docs/developers/versioning.rst index 1e09bf584c..c1bc5e0dbb 100644 --- a/docs/developers/versioning.rst +++ b/docs/developers/versioning.rst @@ -57,12 +57,11 @@ End-of-life versions are not listed in this table. Open Forms API -------------- -The Open Forms API adheres to semantic versioning with one exception: experimental -functionality. +Open Forms exposes a public and a private API. Semantic versioning is applied for the +public API. However, breaking changes to the private API can happen in minor and patch versions. -We use the `specification extension`_ pattern in the API spec to mark functionality -as experimental, using the ``x-experimental: true`` flag. Experimental functionality -may introduce breaking changes in minor versions, but not in patch versions. +We also use the `specification extension`_ pattern in the API spec to mark functionality +as experimental, using the ``x-experimental: true`` flag. We use this to mark parts of the API that we are not yet convinced about that they are the right implementation. Release notes of Open Forms backend will include which @@ -70,6 +69,52 @@ experimental functionality was changed. .. _specification extension: https://swagger.io/specification/#specification-extensions + +============== ============== ============================= +Version Release date API specification +============== ============== ============================= +latest n/a `ReDoc `__, + `Swagger `__ +2.5.0 2024-01-25 `ReDoc `__, + `Swagger `__ +2.4.0 2023-11-09 `ReDoc `__, + `Swagger `__ +2.3.1 2023-09-25 `ReDoc `__, + `Swagger `__ +2.3.0 2023-08-24 `ReDoc `__, + `Swagger `__ +============== ============== ============================= + +Previous versions are supported for 6 months after the next version is released. + +See: `All versions and changes `_ + +**Unsupported versions** + +============== ============== ============================= +Version Release date API specification +============== ============== ============================= +2.2.3 2023-09-25 `ReDoc `__, + `Swagger `__ +2.2.0 2023-06-23 `ReDoc `__, + `Swagger `__ +2.1.1 2023-09-25 `ReDoc `__, + `Swagger `__ +2.1.0 2023-03-03 `ReDoc `__, + `Swagger `__ +2.0.1 2023-09-25 `ReDoc `__, + `Swagger `__ +2.0.0 2022-10-26 `ReDoc `__, + `Swagger `__ +1.1.1 2022-06-21 `ReDoc `__, + `Swagger `__ +1.0.1 2022-05-16 `ReDoc `__, + `Swagger `__ +1.0.0 2022-03-10 `ReDoc `__, + `Swagger `__ +============== ============== ============================= + + Open Forms backend ------------------