Skip to content

Commit 14df6b6

Browse files
author
cibot
committed
Definitions Update herald
1 parent c8c8c04 commit 14df6b6

File tree

1 file changed

+0
-241
lines changed

1 file changed

+0
-241
lines changed

alsdkdefs/apis/herald/herald.v1.yaml

Lines changed: 0 additions & 241 deletions
Original file line numberDiff line numberDiff line change
@@ -16,134 +16,6 @@ servers:
1616
description: Production
1717
x-alertlogic-session-endpoint: true
1818
paths:
19-
'/herald/v2/{account_id}/integrations/{id}':
20-
parameters:
21-
- schema:
22-
type: string
23-
name: account_id
24-
in: path
25-
required: true
26-
description: AIMS Account ID
27-
- schema:
28-
type: string
29-
name: id
30-
in: path
31-
required: true
32-
description: Entity ID
33-
get:
34-
summary: Get account integrations for the specified account
35-
deprecated: true
36-
tags:
37-
- Integrations
38-
responses:
39-
'200':
40-
description: OK
41-
content:
42-
application/json:
43-
schema:
44-
anyOf:
45-
- $ref: '#/components/schemas/Integration-Webhook'
46-
examples:
47-
Webhook Response Example:
48-
value:
49-
id: E31302AE-C9B7-4A4B-BC83-85806383D3FE
50-
account_id: '12345678'
51-
target_url: 'https://www.example.com'
52-
name: My Webhook
53-
type: webhook
54-
headers:
55-
X-Header: HeaderValue
56-
created:
57-
at: 1517452871
58-
by: 3B8EAFA0-1E1A-4744-AB53-0EE45EA8B102
59-
modified:
60-
at: 1517452871
61-
by: 3B8EAFA0-1E1A-4744-AB53-0EE45EA8B102
62-
'403':
63-
description: Forbidden
64-
'404':
65-
description: Not Found
66-
operationId: get_account_integration
67-
description: Get the specified account integration
68-
security:
69-
- X-AIMS-Auth-Token: []
70-
'/herald/v2/{account_id}/integrations':
71-
get:
72-
deprecated: true
73-
summary: List account integrations for the specified account
74-
tags:
75-
- Integrations
76-
responses:
77-
'200':
78-
description: OK
79-
content:
80-
application/json:
81-
schema:
82-
type: object
83-
properties:
84-
integrations:
85-
type: array
86-
items:
87-
$ref: '#/components/schemas/Integration-Webhook'
88-
examples:
89-
List account Integrations for the Specified Account Response Example:
90-
value:
91-
integrations:
92-
- id: E31302AE-C9B7-4A4B-BC83-85806383D3FE
93-
account_id: '12345678'
94-
target_url: 'https://www.example.com'
95-
name: My Webhook
96-
type: webhook
97-
headers:
98-
X-Header: HeaderValue
99-
created:
100-
at: 1517452871
101-
by: 3B8EAFA0-1E1A-4744-AB53-0EE45EA8B102
102-
modified:
103-
at: 1517452871
104-
by: 3B8EAFA0-1E1A-4744-AB53-0EE45EA8B102
105-
'403':
106-
description: Forbidden
107-
operationId: get_account_integrations
108-
security:
109-
- X-AIMS-Auth-Token: []
110-
description: List the specified account integration
111-
parameters:
112-
- schema:
113-
type: string
114-
name: account_id
115-
in: path
116-
required: true
117-
description: AIMS Account ID
118-
/herald/v2/integration_types:
119-
get:
120-
deprecated: true
121-
summary: List available integration types
122-
tags:
123-
- Integrations
124-
responses:
125-
'200':
126-
description: OK
127-
content:
128-
application/json:
129-
schema:
130-
type: object
131-
properties:
132-
integration_types:
133-
type: array
134-
items:
135-
$ref: '#/components/schemas/Integration-Type'
136-
examples:
137-
List Available Integration Types Response:
138-
value:
139-
integration_types:
140-
- name: webhook
141-
'403':
142-
description: Forbidden
143-
operationId: get_integration_types
144-
description: Get the list of available integration types
145-
security:
146-
- X-AIMS-Auth-Token: []
14719
'/herald/v2/notifications/{notification_id}':
14820
get:
14921
summary: Get a notification
@@ -1020,55 +892,6 @@ paths:
1020892
required: true
1021893
components:
1022894
schemas:
1023-
Integration-Webhook:
1024-
title: Integration-Webhook
1025-
type: object
1026-
properties:
1027-
id:
1028-
type: string
1029-
account_id:
1030-
type: string
1031-
target_url:
1032-
type: string
1033-
name:
1034-
type: string
1035-
type:
1036-
type: string
1037-
header:
1038-
type: object
1039-
properties:
1040-
X-Header:
1041-
type: string
1042-
created:
1043-
type: object
1044-
properties:
1045-
at:
1046-
type: number
1047-
by:
1048-
type: string
1049-
modified:
1050-
type: object
1051-
properties:
1052-
at:
1053-
type: number
1054-
by:
1055-
type: string
1056-
x-examples:
1057-
Integration Webhook Example:
1058-
id: E31302AE-C9B7-4A4B-BC83-85806383D3FE
1059-
account_id: '12345678'
1060-
target_url: 'https://www.example.com'
1061-
name: My Webhook
1062-
type: webhook
1063-
headers:
1064-
X-Header: HeaderValue
1065-
created:
1066-
at: 1517452871
1067-
by: 3B8EAFA0-1E1A-4744-AB53-0EE45EA8B102
1068-
modified:
1069-
at: 1517452871
1070-
by: 3B8EAFA0-1E1A-4744-AB53-0EE45EA8B102
1071-
description: ''
1072895
Notification:
1073896
title: Notification
1074897
type: object
@@ -1257,26 +1080,6 @@ components:
12571080
- destination: [email protected]
12581081
status: SENT
12591082
sent_at: 1536094181
1260-
integration_statuses:
1261-
- type: webhook
1262-
status: QUEUED
1263-
integration_id: 857625F7-BAC7-4A90-9FAD-CB829D2ADC83
1264-
queue_data:
1265-
id: E53E01A6-43D3-41EE-8E53-81BAE6025B47
1266-
config:
1267-
type: webhook
1268-
target_url: 'https://example.com'
1269-
- type: webhook
1270-
status: SENT
1271-
integration_id: 713CB1FD-D010-4A98-8D53-BF5B3F1F882C
1272-
queue_data:
1273-
id: BA46561C-5ECE-4423-9C6C-D550E24966B1
1274-
config:
1275-
type: webhook
1276-
target_url: 'https://example.com/webhook/endpoint'
1277-
integration_response:
1278-
code: 200
1279-
body: null
12801083
- id: 53EA67BA-16DF-4E25-A590-A26FC74272DA
12811084
feature: incidents
12821085
subkey: escalated/primary
@@ -1319,39 +1122,6 @@ components:
13191122
- '"FAILED"'
13201123
sent_at:
13211124
type: number
1322-
integration_statuses:
1323-
type: array
1324-
items:
1325-
type: object
1326-
properties:
1327-
type:
1328-
type: string
1329-
integration_id:
1330-
type: string
1331-
status:
1332-
type: string
1333-
enum:
1334-
- '"QUEUED"'
1335-
- '"SENT"'
1336-
queue_data:
1337-
type: object
1338-
properties:
1339-
id:
1340-
type: string
1341-
config:
1342-
type: object
1343-
properties:
1344-
type:
1345-
type: string
1346-
target_url:
1347-
type: string
1348-
integration_response:
1349-
type: object
1350-
properties:
1351-
code:
1352-
type: string
1353-
body:
1354-
type: string
13551125
Subscriber:
13561126
title: Subscriber
13571127
type: object
@@ -1396,15 +1166,6 @@ components:
13961166
- Log Review Escalated
13971167
default_email_subject: Incidents Template Email Subject
13981168
description: ''
1399-
Integration-Type:
1400-
title: Integration-Type
1401-
type: object
1402-
properties:
1403-
name:
1404-
type: string
1405-
x-examples:
1406-
Integration Type Example:
1407-
name: webhook
14081169
Subscription:
14091170
title: Subscription
14101171
type: object
@@ -1558,8 +1319,6 @@ components:
15581319
type: apiKey
15591320
in: header
15601321
tags:
1561-
- name: Integrations
1562-
description: Integrations
15631322
- name: Notification Types
15641323
description: Notification Types
15651324
- name: Notifications

0 commit comments

Comments
 (0)