From dcdf1ba5a9535e31e8875ac3897cb8e2bf5e31ee Mon Sep 17 00:00:00 2001 From: Daniel Sinai Date: Tue, 7 Feb 2023 13:35:47 +0200 Subject: [PATCH] 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 --- docs/resources/blueprint.md | 22 +++++++++++++++++++++- docs/resources/entity.md | 1 + 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/resources/blueprint.md b/docs/resources/blueprint.md index 1b63ca8b..c7cb77ec 100644 --- a/docs/resources/blueprint.md +++ b/docs/resources/blueprint.md @@ -17,16 +17,17 @@ Port blueprint ### Required -- `icon` (String) The icon of the blueprint - `identifier` (String) The identifier of the blueprint - `properties` (Block Set, Min: 1) The metadata of the entity (see [below for nested schema](#nestedblock--properties)) - `title` (String) The display name of the blueprint ### Optional +- `calculation_properties` (Block Set) A set of properties that are calculated upon Entitys regular properties. (see [below for nested schema](#nestedblock--calculation_properties)) - `changelog_destination` (Block List, Max: 1) Blueprints changelog destination, Supports WEBHOOK and KAFKA (see [below for nested schema](#nestedblock--changelog_destination)) - `data_source` (String, Deprecated) The data source for entities of this blueprint - `description` (String) The description of the blueprint +- `icon` (String) The icon of the blueprint - `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)) - `relations` (Block Set) The blueprints that are connected to this blueprint (see [below for nested schema](#nestedblock--relations)) @@ -59,6 +60,25 @@ Optional: - `required` (Boolean) Whether or not the property is required + +### Nested Schema for `calculation_properties` + +Required: + +- `calculation` (String) A jq expression that calculates the value of the property, for instance "'https://grafana.' + .identifier" +- `identifier` (String) The identifier of the property +- `type` (String) The type of the property + +Optional: + +- `colorized` (Boolean) Whether or not the property is colorized +- `colors` (Map of String) A map of colors for the property +- `description` (String) The description of the property +- `format` (String) The format of the Property +- `icon` (String) The icon of the property +- `title` (String) The name of this property + + ### Nested Schema for `changelog_destination` diff --git a/docs/resources/entity.md b/docs/resources/entity.md index 9443bae5..2a71f49c 100644 --- a/docs/resources/entity.md +++ b/docs/resources/entity.md @@ -27,6 +27,7 @@ Port entity - `relations` (Block Set) The other entities that are connected (see [below for nested schema](#nestedblock--relations)) - `run_id` (String) The runID of the action run that created the entity - `team` (String) The team related to the entity +- `teams` (Set of String) The teams related to the entity ### Read-Only