Properties
Properties are key-value pairs where the key is the identifier of the property, and the value is a dynamic type based on the configured catalog property.
Property identifiers can easily be found in the catalog admin section under each entity type, next to the property name.
Example
Example where language is the property identifier for a multi-select property:
{
"language": ["Ruby", "HTML", "Shell"]
}Types of Properties
| Name | Description | Example |
|---|---|---|
boolean |
Simple true/false value. | {"approved": true} |
computed |
Has a SQL query to compute the value. | {"open-prs": 2} |
number |
Simple integer value | {"q3-incidents": 12} |
relation |
Relates one entity to another, like a link. | {"resource": ["db", "s3"]} |
select |
Has a distinct set of possible values. One value allowed. | {"service-tier": "Tier-1"} |
multi-select |
Has a distinct set of possible values. Multiple values allowed. | {"languages": ["Ruby", "Javascript"]} |
text |
Simple open-ended text value. | {"note": "Do not deploy"} |
url |
A string which is a URL. | {"slack-team": "https://company.slack.com/archive/2394kfl3"} |
date |
A string which is a date. | {"reviewed_on": "2025-01-12"} |
json |
A nested json object. | {"json_config": {"key1":"value1", "array": [0,1,2]}} |
Properties
Properties are stored as key-value pairs where:
| Key | Type | Description |
|---|---|---|
<property_identifier> |
varies | The value of the property. The type depends on the property configuration (boolean, string, number, array, object, etc.). |
Removing Properties
To remove a property, simply update or upsert a catalog entity with the desired property to remove and set null as the value. Omitted properties will not be affected.
Example:
{
"language": null
}