From 7b43eae21598a2d0b4301d2d9e6fed57dea07851 Mon Sep 17 00:00:00 2001 From: Marica Antonacci Date: Fri, 6 Mar 2020 18:08:15 +0100 Subject: [PATCH] Add documentation for allowed_groups metadata --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d06ef1286..56177b92a 100644 --- a/README.md +++ b/README.md @@ -61,13 +61,15 @@ The Orchestrator dashboard can exploit some optional information provided in the In particular, the following tags are supported: -| Tag name | Description -| -------------- | ------------- | -| description | Used for showing the card description | | -| metadata.display_name | Used for the card title. If not pro | | -| metadata.icon . | Used for showing the card image. If no image URL is provided, the dashboard will load this [icon](https://cdn4.iconfinder.com/data/icons/mosaicon-04/512/websettings-512.png). | -| metadata.display_name | Used for the card title. If not provided, the template name will be used | | -| metadata.tag | Used for the card ribbon (displayed on the right bottom corner) | | +| Tag name | Description | Type | +| -------------- | ------------- | ------------------ | +| description | Used for showing the card description | String | +| metadata.display_name | Used for the card title. If not pro | String | +| metadata.icon | Used for showing the card image. If no image URL is provided, the dashboard will load this [icon](https://cdn4.iconfinder.com/data/icons/mosaicon-04/512/websettings-512.png). | String | +| metadata.display_name | Used for the card title. If not provided, the template name will be used | String | +| metadata.tag | Used for the card ribbon (displayed on the right bottom corner) | String | +| metadata.allowed_groups | Used for showing the template only to members of specific groups | String
- "*" == any group can see the template
- "group1,group2" == only members of _group1_ and _group2_ can see the template | + Example of template metadata: