Skip to content

Commit 5334868

Browse files
committed
feat(global config): add json schema
1 parent a770667 commit 5334868

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed

docs/jobs/qglobal_config_manager.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,12 @@ If no value defined in jobs, default values are used. The value is defined with
7070
1. Check `src` definition (use default value / download from url / check if exists)
7171
1. Copy `src` .ini file to `dst` .ini with environment variable conversion
7272
1. Update `QGIS_GLOBAL_SETTINGS_FILE` environment variable with `dst` .ini file path
73+
74+
----
75+
76+
## Schema
77+
78+
```{eval-rst}
79+
.. literalinclude:: ../schemas/scenario/jobs/qglobal-config-manager.json
80+
:language: json
81+
```

docs/schemas/scenario/jobs/qdt_job_base.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"qplugins-synchronizer",
3131
"qprofiles-downloader",
3232
"qprofiles-synchronizer",
33+
"qglobal-config-manager",
3334
"qprofiles-manager",
3435
"shortcuts-manager",
3536
"splash-screen-manager"
@@ -107,6 +108,16 @@
107108
}
108109
}
109110
},
111+
{
112+
"properties": {
113+
"uses": {
114+
"const": "qglobal-config-manager"
115+
},
116+
"with": {
117+
"$ref": "qglobal-config-manager.json"
118+
}
119+
}
120+
},
110121
{
111122
"properties": {
112123
"uses": {
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"$schema": "https://json-schema.org/draft/2020-12/schema",
3+
"$id": "https://github.com/qgis-deployment/qgis-deployment-toolbelt-cli/raw/main/docs/schemas/scenario/jobs/qglobal-config-manager.json",
4+
"description": "This jobs handles copy of a source .ini file to a destination .ini file and definition of `QGIS_GLOBAL_SETTINGS_FILE` environment variable so the file can be used by QGIS.",
5+
"title": "QGIS global config manager",
6+
"type": "object",
7+
"properties": {
8+
"src": {
9+
"description": "Source .ini file path. Can use environment variable that will be converted before use.",
10+
"type": "string"
11+
},
12+
"dst": {
13+
"description": "Destination .ini file path. Can use environment variable that will be converted before use.",
14+
"type": "string"
15+
}
16+
}
17+
}

0 commit comments

Comments
 (0)