Update doc

pblottiere · Aug 21, 2024 · 48826b7 · 48826b7
1 parent 1545415
commit 48826b7
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/docs/src/qsa-api/endpoints/projects.md b/docs/src/qsa-api/endpoints/projects.md
@@ -175,3 +175,28 @@ $ curl "http://localhost:5000/api/projects/my_project/styles" \
     }
   }'
 ````
+
+## Cache
+
+| Method  |                      URL                         |         Description                                                                                                          |
+|---------|--------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
+| GET     | `/api/projects/{project}/cache`                  | Return metadata about the cache                                                                                              |
+| POST    | `/api/projects/{project}/cache/reset`            | Clear cached data and reset cache configuration                                                                              |
+
+Example:
+
+```` shell
+$ curl "http://localhost:5000/api/projects/my_project/cache"
+{
+  "valid":true,
+  "storage":"filesystem"
+}
+````
+
+<div class="warning">
+Reset cache
+
+When a QGIS project is created manually without QSA, the cache is not
+initialized. This method allows to create the MapProxy configuration file
+accordingly.
+</div>