Skip to content

Commit 99fa1c7

Browse files
committed
Misc feedback
- id -> instanceId in URL previews - fix double negative in CreateOrUpdate description - use alarmId-like example for the acknowledge request
1 parent b78b1c2 commit 99fa1c7

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

alarm/nialarm.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ paths:
535535
type: array
536536
items:
537537
type: string
538-
example: [5c40ec55e0d6441168b4c543, 5c40ec55e0d6441168b4c543]
538+
example: [System1.Health.DiskSpaceAlarm, System2.Health.DiskSpaceAlarm]
539539
forceClear:
540540
description: Whether or not the affected alarm instances should have their *clear* field set
541541
to true.
@@ -586,8 +586,8 @@ paths:
586586
parameters:
587587
- in: body
588588
name: Request body
589-
description: Container which holds data for the request. For requests which do not result in a
590-
new alarm instance being created, all fields other than *alarmId* and *transition* are ignored.
589+
description: Container which holds data for the request. For requests which result in an update to
590+
an existing alarm instance, all fields other than *alarmId* and *transition* are ignored.
591591
schema:
592592
type: object
593593
title: CreateOrUpdateInstanceRequest
@@ -670,10 +670,10 @@ paths:
670670
$ref: '#/definitions/Error'
671671
default:
672672
$ref: '#/responses/Error'
673-
/v1/instances/{id}:
673+
/v1/instances/{instanceId}:
674674
parameters:
675675
- in: path
676-
name: id
676+
name: instanceId
677677
description: Instance ID
678678
type: string
679679
required: true
@@ -701,10 +701,10 @@ paths:
701701
$ref: '#/responses/Unauthorized'
702702
default:
703703
$ref: '#/responses/Error'
704-
/v1/instances/{id}/notes:
704+
/v1/instances/{instanceId}/notes:
705705
parameters:
706706
- in: path
707-
name: id
707+
name: instanceId
708708
description: Instance ID
709709
type: string
710710
required: true

0 commit comments

Comments
 (0)