Adding changelog of API endpoints

.github/workflows/tests.yml

@@ -6,6 +6,7 @@ on:
     paths-ignore:
       - 'docs/**'
       - 'l10n/**'
+      - 'CHANGELOG.md'
   pull_request:
 
 jobs:

CHANGELOG.md

@@ -6,6 +6,9 @@
 - l10n: Changed spelling of MIME
   [#988](https://github.com/nextcloud/cookbook/pull/988) @rakekniven
 
+### Documentation
+- Add documentation on updates of the API endpoints
+  [#1001](https://github.com/nextcloud/cookbook/pull/1001) @christianlupus
 
 ## 0.9.12 - 2022-05-12
 

docs/dev/api/changelog/0.md

@@ -0,0 +1,49 @@
+# API changelog for epoch 0.x.x
+
+This file describes the changes made to the API during the development.
+It is sorted in reverse chronological order.
+
+For the most up to date API description please see the specification directly.
+This serves only for developers to find the changes better.
+
+## Unpublished
+
+## Version 0.0.3 - cookbook v0.9.12 - 2022-05-12
+
+See [API specification](../0.0.3/index.html)
+
+### Allow the client to specify the accepted image types
+The client was not able to specify the compatible image types.
+The endpoint `/recipes/{id}/image` just served whatever format was available, be it JPG or SVG.
+
+The endpoint now respects the `Accept` request header and does not send a SVG if only JPGs are requested explicitly.
+If no matching file type was found, a status of 406 is returned.
+
+This affects the following API endpoints:
+- `GET` in `/recipes/{id}/image` can return 406
+
+Related issues: [#954](https://github.com/nextcloud/cookbook/issues/954)
+
+### Prevent adding of recipes with no name
+We are currently storing the recipes in a folder according to the recipe name.
+If no name was provided, this breaks our storage backend.
+Until now, a 500 error was returned.
+This was changed to be 422 with some useful error handling.
+
+This affects the following API endpoints:
+- `POST` on `/api/recipes` can return 422
+- `PUT` on `/api/recipes/{id}` can return 422
+
+Related issues: [#923](https://github.com/nextcloud/cookbook/issues/923)
+
+## Version 0.0.2
+
+See [API specification](../0.0.2/index.html)
+
+This version was the first version to be well documented.
+It was called 0.0.2 as 0.0.1 would be the (undocumented) initial API structure.
+So, please consider this the fist stable API version.
+
+Additionally, some API endpoints were deprecated/removed.
+They were not related to a REST-based APi but the ancient multi-page site approach.
+These endpoints were non-functional anyways.

docs/dev/api/index.md

@@ -4,3 +4,7 @@ This page provides an overview over the possible API endpoints provided by the a
 
 - [Version 0.0.2](0.0.2/index.html)
 - [Version 0.0.3](0.0.3/index.html)
+
+The following list provides a in depth changelog for the individual epochs:
+
+- [Epoch 0.x.x](changelog/0.html)