Skip to content

Commit dcdf1ba

Browse files
danielsinairoot
and
root
authored
Add calc property and teams (#25)
* added calculated properties * fixed tests * added support for team array * fixed issues with teams state * gen docs --------- Co-authored-by: root <[email protected]>
1 parent 34f61be commit dcdf1ba

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

docs/resources/blueprint.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,17 @@ Port blueprint
1717

1818
### Required
1919

20-
- `icon` (String) The icon of the blueprint
2120
- `identifier` (String) The identifier of the blueprint
2221
- `properties` (Block Set, Min: 1) The metadata of the entity (see [below for nested schema](#nestedblock--properties))
2322
- `title` (String) The display name of the blueprint
2423

2524
### Optional
2625

26+
- `calculation_properties` (Block Set) A set of properties that are calculated upon Entitys regular properties. (see [below for nested schema](#nestedblock--calculation_properties))
2727
- `changelog_destination` (Block List, Max: 1) Blueprints changelog destination, Supports WEBHOOK and KAFKA (see [below for nested schema](#nestedblock--changelog_destination))
2828
- `data_source` (String, Deprecated) The data source for entities of this blueprint
2929
- `description` (String) The description of the blueprint
30+
- `icon` (String) The icon of the blueprint
3031
- `mirror_properties` (Block Set) When two Blueprints are connected via a Relation, a new set of properties becomes available to Entities in the source Blueprint. (see [below for nested schema](#nestedblock--mirror_properties))
3132
- `relations` (Block Set) The blueprints that are connected to this blueprint (see [below for nested schema](#nestedblock--relations))
3233

@@ -59,6 +60,25 @@ Optional:
5960
- `required` (Boolean) Whether or not the property is required
6061

6162

63+
<a id="nestedblock--calculation_properties"></a>
64+
### Nested Schema for `calculation_properties`
65+
66+
Required:
67+
68+
- `calculation` (String) A jq expression that calculates the value of the property, for instance "'https://grafana.' + .identifier"
69+
- `identifier` (String) The identifier of the property
70+
- `type` (String) The type of the property
71+
72+
Optional:
73+
74+
- `colorized` (Boolean) Whether or not the property is colorized
75+
- `colors` (Map of String) A map of colors for the property
76+
- `description` (String) The description of the property
77+
- `format` (String) The format of the Property
78+
- `icon` (String) The icon of the property
79+
- `title` (String) The name of this property
80+
81+
6282
<a id="nestedblock--changelog_destination"></a>
6383
### Nested Schema for `changelog_destination`
6484

docs/resources/entity.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Port entity
2727
- `relations` (Block Set) The other entities that are connected (see [below for nested schema](#nestedblock--relations))
2828
- `run_id` (String) The runID of the action run that created the entity
2929
- `team` (String) The team related to the entity
30+
- `teams` (Set of String) The teams related to the entity
3031

3132
### Read-Only
3233

0 commit comments

Comments
 (0)