Skip to content

Commit ea53983

Browse files
committed
Update permission documentation
1 parent 169094e commit ea53983

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/configuration/ResourcesPermissions.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -13,33 +13,31 @@ Roles can be given permissions on resources. That means that if you want to give
1313
The following resource types are available:
1414

1515
* `Map`: WMS corresponding to a QGIS Project
16-
* `Layer`: layer of a map
17-
* `Attribute`: attribute of a map layer
18-
* `Print template`: print composer template of a QGIS Project
16+
* `Layer`: Layer of a map
17+
* `Attribute`: Attribute of a map layer (i.e. for WFS)
18+
* `Print template`: Print composer template of a QGIS Project
1919
* `Data`: Data layer for editing
20-
* `Attribute`: attribute of a data layer
20+
* `Attribute`: Attribute of a data layer
2121
* `Data (create)`: Data layer for creating features
2222
* `Data (read)`: Data layer for reading features
2323
* `Data (update)`: Data layer for updating features
2424
* `Data (delete)`: Data layer for deleting features
25-
* `Viewer`: custom map viewer configuration
26-
* `Viewer task`: permittable viewer tasks
25+
* `Viewer task`: Permittable viewer tasks
2726
* `FeatureInfo service`: Feature info service
2827
* `FeatureInfo layer`: Feature info layer
28+
* `Attribute`: Attribute of a info layer
2929

3030
The resource name corresponds to the technical name of its resource (e.g. WMS layer name). Most notably, the name of a `map` resource corresponds to the relative path to the project below `qgs-resources` without `.qgs` extension (so i.e. the resource name for `qgs-resources/subfolder/project.qgs` will be `subfolder/project`).
3131

3232
*Note:* If your QGIS project is configured to return the field aliases rather than the field names in `GetFeatureInfo`, the resource name for layer `attribute` resources corresponds to the alias of the field.
3333

3434
Available `map`, `layer`, `attribute` and `print_template` resources are determined from WMS `GetProjectSettings` and the QGIS projects.
3535

36-
`data` and their `attribute` resources define a data layer for the [Data service](https://github.com/qwc-services/qwc-data-service).
36+
The `data` and their `attribute` resources define a data layer for the [Data service](https://github.com/qwc-services/qwc-data-service).
3737

3838
For more detailed [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) permissions `data_create`, `data_read`, `data_update` and `data_delete` can be used instead of `data`
3939
(`data` and `write=False` is equivalent to `data_read`; `data` and `write=True` is equivalent to all CRUD resources combined).
4040

41-
The `viewer` resource defines a custom viewer configuration for the map viewer (see [Custom viewer configurations](https://github.com/qwc-services/qwc-map-viewer#custom-viewer-configurations)).
42-
4341
The `viewer_task` resource defines viewer functionalities (e.g. printing or raster export) that can be restricted or permitted.
4442
Their `name` (e.g. `RasterExport`) will be matched against:
4543
- The `key` in `menuItems` and `toolbarItems` in the QWC2 `config.json`.
@@ -48,6 +46,8 @@ Their `name` (e.g. `RasterExport`) will be matched against:
4846

4947
*Note*: You can restrict tasks entires which specify a mode (i.e. `{"key": "Measure", "mode": "LineString"}`) by concatenating the task key and the mode as the `viewer_task` resource name, i.e. `MeasureLineString`.
5048

49+
The `FeatureInfo service`, `FeatureInfo layer` and subordinate `Attribute` resources allow controlling whether an entire WMS service, its layers or its attributes are queryable via GetFeatureInfo.
50+
5151
Restricted viewer task items are then removed from the menu and toolbar in the map viewer. Viewer tasks not explicitly added as resources are kept unchanged from the `config.json`.
5252

5353
*Note*: The resource types, i.e. for custom QWC2 plugins, can be extended by inserting new types into the `qwc_config.resource_types` table.

0 commit comments

Comments
 (0)