📝 update CHANGELOG with deployment warning

maykinmedia · Feb 28, 2024 · b5925e8 · b5925e8
1 parent 1b9b789
commit b5925e8
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -29,6 +29,16 @@ Change history
   * added `typeVersion` query parameter (#306)
   * fixed date-time parsing in API filtering (#308)
 
+.. warning::
+
+   Change in deployment is required. `/media/` volume should be configured to share OAS files.
+
+   Explanation:
+
+   The new version of ``zgw_consumers`` library adds ``oas_file`` filed to ``Service`` model.
+   This field saves OAS file into ``MEDIA_ROOT`` folder.
+   The deployment now should have a volume for it.
+   Please look at the example in ``docker-compose.yml``
 
 2.1.1 (2022-06-24)
 ------------------

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -22,3 +22,8 @@ services:
       - 8000:8000
     depends_on:
       - db
+    volumes:
+      - media:/app/media  # Shared media volume to get access to saved OAS files
+
+volumes:
+  media: