Skip to content

Commit 4b40e91

Browse files
committed
Update README
1 parent 190ab17 commit 4b40e91

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Add the following configuration and adapt it to your service in `tenantConfig.js
5656
Usage
5757
-----
5858

59-
### Script
59+
### CLI interface
6060

6161
Show command options:
6262

@@ -74,7 +74,12 @@ Generate permissions file:
7474

7575
uv run src/config_generator_cli.py ./tenantConfig.json permissions
7676

77-
### Service
77+
Additionally, the following command line args may be specified:
78+
79+
- `--use_cached_project_metadata=1`: Whether to use cached project metadata
80+
- `--force_readonly_datasets=1`: Whether to force read-only dataset permissions
81+
82+
### Service interface
7883

7984
Set the `INPUT_CONFIG_PATH` environment variable to the base directory where for the configuration files are that should be read by the ConfigGenerator (default: `config-in/`).
8085
Set the `OUTPUT_CONFIG_PATH` environment variable to the base directory where the ConfigGenerator should output service configurations and permissions (default: `/tmp/`).
@@ -85,7 +90,24 @@ Base URL:
8590

8691
Generate both service configs and permissions for `default` tenant:
8792

88-
curl -X POST "http://localhost:5010/generate_configs?tenant=default"
93+
# Non-blocking call, returns task_id
94+
curl "http://localhost:5010/generate_configs?tenant=default"
95+
96+
# Blocking call, streams log output
97+
curl "http://localhost:5010/generate_configs?tenant=default&stream_response=1"
98+
99+
Additionally, the following query parameters may be specified:
100+
101+
- `use_cached_project_metadata=1`: Whether to use cached project metadata
102+
- `force_readonly_datasets=1`: Whether to force read-only dataset permissions
103+
104+
Watch config generator task status:
105+
106+
curl "http://localhost:5010/generate_configs_status?task_id=<task_id>"
107+
108+
Cancel config generator task:
109+
110+
curl "http://localhost:5010/generate_configs_cancel?task_id=<task_id>"
89111

90112
### Update JSON schemas
91113

0 commit comments

Comments
 (0)