Skip to content

Commit e28149b

Browse files
authored
Add missing query fields to alarm API document (#54)
Adds the description and resourceType query fields to the alarm API document.
1 parent e0d0eac commit e28149b

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

alarm/nialarm.yml

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -305,12 +305,17 @@ definitions:
305305
alarmId:
306306
type: string
307307
description: AlarmId query. The service will return alarm instances whose *alarmId* fields are equal
308-
to the query, taking case into account.
308+
to the query. This query takes case into account.
309309
example: System.Health.DiskSpaceLow.Bdd9u!4aMd!$pYrf*CnaIZ2tbu$-Ct%?
310+
description:
311+
type: string
312+
description: Description query. The service will return alarm instances whose *description* fields
313+
contain the description query string. This query does not take case into account.
314+
example: Disk usage
310315
displayName:
311316
type: string
312317
description: Display name query. The service will return alarm instances whose *displayName* fields
313-
contain the display name query string, without taking case into account.
318+
contain the display name query string. This query does not take case into account.
314319
example: Low disk space on CRIO1
315320
active:
316321
type: boolean
@@ -371,13 +376,18 @@ definitions:
371376
createdBy:
372377
type: string
373378
description: Created by query. The service will return instances whose *createdBy* fields are equal to
374-
the query, taking case into account.
379+
the query. This query takes case into account.
375380
example: TagRuleEngine
376381
channel:
377382
type: string
378383
description: Channel query. The service will return instances whose *channel* fields are equal to the
379-
query, taking case into account. Supports wildcard match checking with glob-style wildcards.
384+
query. This query takes case into account and supports wildcard match checking with glob-style wildcards.
380385
example: '*.System.Health.DiskSpaceUsePercentage'
386+
resourceType:
387+
type: string
388+
description: Resource type query. The service will return instances whose *resourceType* fields are
389+
equal to the query. This query takes case into account.
390+
example: Tag
381391
properties:
382392
type: object
383393
description: Property query. The service will return instances whose *properties* fields contain all
@@ -790,4 +800,4 @@ paths:
790800
401:
791801
$ref: '#/responses/Unauthorized'
792802
default:
793-
$ref: '#/responses/Error'
803+
$ref: '#/responses/Error'

0 commit comments

Comments
 (0)