Update config docs/lock

ghga-de · Apr 9, 2024 · 339167d · 339167d
1 parent 81e2382
commit 339167d
Show file tree

Hide file tree

Showing 6 changed files with 325 additions and 285 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -48,7 +48,7 @@ repos:
       - id: no-commit-to-branch
         args: [--branch, dev, --branch, int, --branch, main]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.3
+    rev: v0.3.5
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

diff --git a/README.md b/README.md
@@ -101,7 +101,7 @@ The service requires the following configuration parameters:
   ```
 
 
-- **`access_request_created_type`** *(string)*: The type to use for access request created events.
+- **`access_request_created_event_type`** *(string)*: The type to use for access request created events.
 
 
   Examples:
@@ -111,7 +111,7 @@ The service requires the following configuration parameters:
   ```
 
 
-- **`access_request_allowed_type`** *(string)*: The type to use for access request allowed events.
+- **`access_request_allowed_event_type`** *(string)*: The type to use for access request allowed events.
 
 
   Examples:
@@ -121,7 +121,7 @@ The service requires the following configuration parameters:
   ```
 
 
-- **`access_request_denied_type`** *(string)*: The type to use for access request denied events.
+- **`access_request_denied_event_type`** *(string)*: The type to use for access request denied events.
 
 
   Examples:

diff --git a/config_schema.json b/config_schema.json
@@ -44,28 +44,28 @@
       "title": "Access Request Events Topic",
       "type": "string"
     },
-    "access_request_created_type": {
+    "access_request_created_event_type": {
       "description": "The type to use for access request created events",
       "examples": [
         "access_request_created"
       ],
-      "title": "Access Request Created Type",
+      "title": "Access Request Created Event Type",
       "type": "string"
     },
-    "access_request_allowed_type": {
+    "access_request_allowed_event_type": {
       "description": "The type to use for access request allowed events",
       "examples": [
         "access_request_allowed"
       ],
-      "title": "Access Request Allowed Type",
+      "title": "Access Request Allowed Event Type",
       "type": "string"
     },
-    "access_request_denied_type": {
+    "access_request_denied_event_type": {
       "description": "The type to use for access request denied events",
       "examples": [
         "access_request_denied"
       ],
-      "title": "Access Request Denied Type",
+      "title": "Access Request Denied Event Type",
       "type": "string"
     },
     "file_registered_event_topic": {
@@ -198,9 +198,9 @@
     "notification_event_topic",
     "notification_event_type",
     "access_request_events_topic",
-    "access_request_created_type",
-    "access_request_allowed_type",
-    "access_request_denied_type",
+    "access_request_created_event_type",
+    "access_request_allowed_event_type",
+    "access_request_denied_event_type",
     "file_registered_event_topic",
     "file_registered_event_type",
     "service_instance_id",

diff --git a/example_config.yaml b/example_config.yaml
@@ -1,6 +1,6 @@
-access_request_allowed_type: access_request_allowed
-access_request_created_type: access_request_created
-access_request_denied_type: access_request_denied
+access_request_allowed_event_type: access_request_allowed
+access_request_created_event_type: access_request_created
+access_request_denied_event_type: access_request_denied
 access_request_events_topic: access_request_events
 central_data_stewardship_email: test@test.abc
 db_connection_str: '**********'