[#467] update documentation & docker configuration example

maykinmedia · Dec 12, 2024 · 342ee27 · 342ee27
1 parent e495899
commit 342ee27
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 1 deletion.
diff --git a/docker/setup_configuration/data.yaml b/docker/setup_configuration/data.yaml
@@ -1 +1,9 @@
-...
+zgw_consumers_config_enable: true
+zgw_consumers:
+  services:
+  - identifier: objecttypes-api
+    label: Objecttypes API
+    api_root: http://objecttypes.local/api/v1/
+    api_connection_check_path: objecttypes
+    api_type: orc
+    auth_type: api_key
diff --git a/docs/installation/config_cli.rst b/docs/installation/config_cli.rst
@@ -34,6 +34,29 @@ Objects API
 Objecttypes connection configuration
 ------------------------------------
 
+In order to be able to retrieve objecttypes, a corresponding ``Service`` should be
+created. An example of a configuration could be seen below:
+
+.. code-block:: yaml
+   ...
+
+    zgw_consumers_config_enable: true
+    zgw_consumers:
+      services:
+      - identifier: objecttypes-api-1
+        label: Objecttypes API 1
+        api_root: http://objecttypes-1.local/api/v1/
+        api_connection_check_path: objecttypes
+        api_type: orc
+        auth_type: api_key
+      - identifier: objecttypes-api-2
+        label: Objecttypes API 2
+        api_root: http://objecttypes-2.local/api/v1/
+        api_connection_check_path: objecttypes
+        api_type: orc
+        auth_type: api_key
+   ....
+
 Tokens configuration
 -------------------