Skip to content

Commit 43c13f7

Browse files
author
cibot
committed
Definitions Update iris
1 parent 0207a3f commit 43c13f7

File tree

1 file changed

+141
-1
lines changed

1 file changed

+141
-1
lines changed

alsdkdefs/apis/iris/iris.v3.yaml

Lines changed: 141 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ paths:
446446
code: 400
447447
Incident already closed:
448448
value:
449-
error: Incident 12341ab29e36-394e-11e9-a004-720004270420 status is currently the same closed
449+
error: Incident 12341ab29e36-394e-11e9-a004-720004270420 status is currently the same completed
450450
code: 400
451451
'401':
452452
description: Not authorized
@@ -615,6 +615,106 @@ paths:
615615
name: incident_id
616616
in: path
617617
required: true
618+
'/iris/v3/{account_id}/{incident_id}/reopen':
619+
post:
620+
summary: reopen a closed incident
621+
tags:
622+
- UI operations
623+
responses:
624+
'200':
625+
description: OK
626+
content:
627+
application/json:
628+
schema:
629+
$ref: '#/components/schemas/ReopenIncident'
630+
examples:
631+
Complete incident response example:
632+
value:
633+
new:
634+
notes: reopening because of y
635+
reason_code: other
636+
status: open
637+
status_change_time: 2020-05-22T11:09:56.855569+00:00
638+
old:
639+
status: completed
640+
status_change_time: 2020-05-22T07:54:33.555371+00:00
641+
reason_code: further_action
642+
notes: closed because of x
643+
'400':
644+
description: Bad request
645+
content:
646+
application/json:
647+
schema:
648+
$ref: '#/components/schemas/ErrorResponse'
649+
examples:
650+
Invalid account/incident id:
651+
value:
652+
error: Invalid AccountId or IncidentId supplied
653+
code: 400
654+
Invalid body:
655+
value:
656+
error: Request body should be valid JSON
657+
code: 400
658+
Invalid arguments:
659+
value:
660+
error: Invalid arguments
661+
code: 400
662+
Incident already open:
663+
value:
664+
error: Incident 12341ab29e36-394e-11e9-a004-720004270420 status is currently the same open
665+
code: 400
666+
'401':
667+
description: Not authorized
668+
'404':
669+
description: account_id incident_id combination not found
670+
content:
671+
application/json:
672+
schema:
673+
$ref: '#/components/schemas/ErrorResponse'
674+
examples:
675+
Http 404 example:
676+
value:
677+
error: "Not found"
678+
code: 404
679+
'500':
680+
description: Internal Server Error
681+
operationId: reopen_incident
682+
description: reopen an incident
683+
security:
684+
- X-AIMS-Auth-Token: []
685+
x-code-samples:
686+
- lang: Request Sample
687+
source: |
688+
curl -H "x-aims-auth-token: ${TOKEN}" -X POST https://api.cloudinsight.alertlogic.com/iris/v3/12341ab29e36-394e-11e9-a004-720004270420/reopen -d '{"notes": "reopening because of y"}'
689+
requestBody:
690+
description: 'The value in notes will be displayed in the customer console as the reason for opening'
691+
required: true
692+
content:
693+
application/json:
694+
schema:
695+
type: object
696+
properties:
697+
notes:
698+
type: string
699+
description: Notes about completion
700+
required:
701+
- notes
702+
examples:
703+
Complete incident body:
704+
value:
705+
notes: Reopening because of y
706+
parameters:
707+
- schema:
708+
type: string
709+
name: account_id
710+
in: path
711+
required: true
712+
description: AIMS Account ID
713+
- schema:
714+
$ref: '#/components/schemas/IncidentId'
715+
name: incident_id
716+
in: path
717+
required: true
618718
components:
619719
schemas:
620720
IncidentId:
@@ -783,6 +883,46 @@ components:
783883
- feedback_reason
784884
- feedback_uid
785885
- feedback_user
886+
ReopenIncident:
887+
title: Incident completion responses
888+
type: object
889+
description: Incident completion response object
890+
properties:
891+
new:
892+
type: object
893+
properties:
894+
notes:
895+
type: string
896+
reason_code:
897+
type: string
898+
status:
899+
type: string
900+
status_change_time:
901+
type: string
902+
required:
903+
- notes
904+
- reason_code
905+
- status
906+
- status_change_time
907+
old:
908+
type: object
909+
properties:
910+
status:
911+
type: string
912+
status_change_time:
913+
type: string
914+
reason_code:
915+
type: string
916+
notes:
917+
type: string
918+
required:
919+
- notes
920+
- reason_code
921+
- status
922+
- status_change_time
923+
required:
924+
- new
925+
- old
786926
CompleteIncident:
787927
title: Incident completion responses
788928
type: object

0 commit comments

Comments
 (0)