@@ -129,7 +129,7 @@ definitions:
129129 TagDataType :
130130 title : Tag Data Type
131131 description : The data type of the tags which a rule applies to. Rules are only evaluated
132- against tags whose data type matches their tagDataType.
132+ against tags whose data type matches their * tagDataType* .
133133 type : string
134134 enum : [DOUBLE, INT, STRING, BOOLEAN, U_INT64, DATE_TIME]
135135 example : DOUBLE
@@ -158,32 +158,32 @@ definitions:
158158 type : string
159159 example : Preconfigured rule for monitoring managed systems' disk space
160160 AlarmInstanceDisplayNameTemplate :
161- description : Template string which will be used to set the displayName field on alarms created
161+ description : Template string which will be used to set the * displayName* field on alarms created
162162 by a rule. Values surrounded by angle brackets will be substituted with values from the tag's property
163- dictionary. For example, if an alarmInstanceDisplayNameTemplate contained the string "Excessive vibration
163+ dictionary. For example, if an * alarmInstanceDisplayNameTemplate* contained the string "Excessive vibration
164164 on turbine <turbine_number>", and the rule was evaluated against a tag whose property dictionary
165165 contained the key "turbine_number" with value "5", then the rule would request that an alarm with
166166 display name "Excessive vibration on turbine 5" be created.
167167 example : Excessive vibration on turbine <turbine_number>
168168 type : string
169169 AlarmInstanceDescriptionTemplate :
170- description : Template string which will be used to set the description field on alarms created by a rule.
170+ description : Template string which will be used to set the * description* field on alarms created by a rule.
171171 Values surrounded by angle brackets will be substituted with values from the tag's property dictionary.
172172 See the description of AlarmInstanceDisplayNameTemplate for more information.
173173 example : Disk space on <system> is low. Disk usage was <value>% when this alarm was triggered.
174174 type : string
175175 Keywords :
176- description : Words or phrases associated with a rule. Rules can be tagged
177- with keywords to make it easier to find them with queries.
176+ description : Words or phrases associated with a rule. Rules can be taggedwith keywords to make it easier
177+ to find them with queries.
178178 type : array
179179 items :
180180 type : string
181181 example :
182182 - keyword1
183183 - keyword2
184184 Properties :
185- description : Key-value-pair metadata associated with a rule. Rules can be tagged with properties
186- to make it easier to find them with queries.
185+ description : Key-value-pair metadata associated with a rule. Rules can be tagged with properties to make
186+ it easier to find them with queries.
187187 type : object
188188 additionalProperties :
189189 type : string
@@ -493,12 +493,12 @@ paths:
493493 schema :
494494 properties :
495495 displayName :
496- description : Display name query. Returns rules whose *displayName* field contains the query
496+ description : Display name query. Returns rules whose *displayName* fields contain the query
497497 string, without taking case into account.
498498 type : string
499499 example : low disk space
500500 description :
501- description : Description query. Returns rules whose *description) field contains the query
501+ description : Description query. Returns rules whose *description* fields contain the query
502502 string, without taking case into account.
503503 type : string
504504 example : turbine 5
@@ -516,15 +516,15 @@ paths:
516516 example : System1.System.Health.DiskUsePercentage
517517 properties :
518518 type : object
519- description : Property query. The service will return instances whose *properties* fields
519+ description : Property query. The service will return rules whose *properties* fields
520520 contain all of the specified key/value pairs.
521521 additionalProperties :
522522 type : string
523523 example :
524524 key1 : value1
525525 keywords :
526526 type : array
527- description : Keyword query. The service will return instances whose *keywords* fields contain
527+ description : Keyword query. The service will return rules whose *keywords* fields contain
528528 all of the specified keywords.
529529 items :
530530 type : string
0 commit comments