You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: splunk_sdk/action/v1beta2/openapi.yaml
+19-43Lines changed: 19 additions & 43 deletions
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,7 @@
1
1
components:
2
2
parameters:
3
3
ActionName:
4
-
description: The name of the action as one or more identifier strings separated
5
-
by periods. Each identifier string consists of lowercase letters, digits,
6
-
and underscores, and cannot start with a digit.
4
+
description: The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
7
5
in: path
8
6
name: action_name
9
7
required: true
@@ -69,8 +67,7 @@ components:
69
67
ActionImmutable:
70
68
properties:
71
69
createdAt:
72
-
description: The date and time this action template was created (ISO-8601
73
-
date/time with zone).
70
+
description: The date and time this action template was created (ISO-8601 date/time with zone).
74
71
format: date-time
75
72
readOnly: true
76
73
type: string
@@ -81,14 +78,11 @@ components:
81
78
kind:
82
79
$ref: '#/components/schemas/ActionKind'
83
80
name:
84
-
description: The name of the action, as one or more identifier strings separated
85
-
by periods. Each identifier string consists of lowercase letters, digits,
86
-
and underscores, and cannot start with a digit.
81
+
description: The name of the action, as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
description: The date and time this action template was updated (ISO-8601
91
-
date/time with zone).
85
+
description: The date and time this action template was updated (ISO-8601 date/time with zone).
92
86
format: date-time
93
87
readOnly: true
94
88
type: string
@@ -151,34 +145,26 @@ components:
151
145
type: string
152
146
type: array
153
147
body:
154
-
description: HTML content to send as the body of the email. You can use
155
-
a template in this field.
148
+
description: HTML content to send as the body of the email. You can use a template in this field.
156
149
example: <html><body>Hello, this is my test email.</body></html>
157
150
type: string
158
151
bodyPlainText:
159
-
description: Optional text to send as the text/plain part of the email.
160
-
If this field is not set for an email action, the Action service converts
161
-
the value from the body field to text and sends that as the text/plain
162
-
part when invoking the action. You can use a template in this field.
152
+
description: Optional text to send as the text/plain part of the email. If this field is not set for an email action, the Action service converts the value from the body field to text and sends that as the text/plain part when invoking the action. You can use a template in this field.
163
153
example: Hello, this is my test email.
164
154
type: string
165
155
fromName:
166
-
description: Optional text providing a human-friendly name for the sender.
167
-
Must be less than or equal to 81 characters. You can use a template in
168
-
this field.
156
+
description: Optional text providing a human-friendly name for the sender. Must be less than or equal to 81 characters. You can use a template in this field.
169
157
type: string
170
158
members:
171
-
description: An array of tenant member names, whose profile email addresses
172
-
will be included as recipients.
159
+
description: An array of tenant member names, whose profile email addresses will be included as recipients.
173
160
items:
174
161
type: string
175
162
type: array
176
163
subject:
177
164
description: The subject of the email. You can use a template in this field.
178
165
type: string
179
166
title:
180
-
description: A human-readable title for the action. Must be less than or
181
-
equal to 128 characters.
167
+
description: A human-readable title for the action. Must be less than or equal to 128 characters.
182
168
type: string
183
169
type: object
184
170
PublicWebhookKey:
@@ -225,8 +211,7 @@ components:
225
211
type: string
226
212
type: array
227
213
members:
228
-
description: An array of tenant member names, whose profile email addresses
229
-
will be included as recipients.
214
+
description: An array of tenant member names, whose profile email addresses will be included as recipients.
230
215
items:
231
216
type: string
232
217
type: array
@@ -240,8 +225,7 @@ components:
240
225
readOnly: true
241
226
type: string
242
227
id:
243
-
description: A unique identifier for this trigger event. Generated from
244
-
a hash of all recursively-sorted event field values.
228
+
description: A unique identifier for this trigger event. Generated from a hash of all recursively-sorted event field values.
245
229
readOnly: true
246
230
type: string
247
231
kind:
@@ -262,8 +246,7 @@ components:
262
246
type: string
263
247
ttlSeconds:
264
248
default: 3600
265
-
description: A time to live (TTL), expressed as seconds after createdAt,
266
-
after which the trigger event will no longer be acted upon.
249
+
description: A time to live (TTL), expressed as seconds after createdAt, after which the trigger event will no longer be acted upon.
267
250
format: int32
268
251
minimum: 1
269
252
type: integer
@@ -283,8 +266,7 @@ components:
283
266
WebhookActionMutable:
284
267
properties:
285
268
title:
286
-
description: A human-readable title for the action. Must be less than 128
287
-
characters.
269
+
description: A human-readable title for the action. Must be less than 128 characters.
288
270
type: string
289
271
webhookHeaders:
290
272
additionalProperties:
@@ -532,17 +514,14 @@ paths:
532
514
application/json:
533
515
schema:
534
516
$ref: '#/components/schemas/TriggerEvent'
535
-
description: The action payload, which should include values for any templated
536
-
fields.
517
+
description: The action payload, which should include values for any templated fields.
537
518
required: true
538
519
responses:
539
520
"201":
540
521
description: The trigger event was received successfully.
541
522
headers:
542
523
Location:
543
-
description: The URL of the run status, with the format "{tenant}/action/v1beta2/actions/{action_name}/status/{status_id}".
544
-
Send a GET request to this URL to check the status, which will be
545
-
available for 4 days.
524
+
description: The URL of the run status, with the format "{tenant}/action/v1beta2/actions/{action_name}/status/{status_id}". Send a GET request to this URL to check the status, which will be available for 4 days.
546
525
schema:
547
526
type: string
548
527
"400":
@@ -601,8 +580,7 @@ paths:
601
580
schema:
602
581
$ref: '#/components/schemas/ServiceError'
603
582
description: An error occurred.
604
-
summary: Returns the status of an action that was invoked. The status is available
605
-
for 4 days after the last status change.
583
+
summary: Returns the status of an action that was invoked. The status is available for 4 days after the last status change.
606
584
tags:
607
585
- Actions
608
586
x-authz-scope: action.actions.read
@@ -647,8 +625,7 @@ paths:
647
625
schema:
648
626
$ref: '#/components/schemas/ServiceError'
649
627
description: An error occurred.
650
-
summary: Returns the status details of the invoked email action. The status
651
-
is available for 4 days after the last status change.
628
+
summary: Returns the status details of the invoked email action. The status is available for 4 days after the last status change.
652
629
tags:
653
630
- Actions
654
631
x-authz-scope: action.actions.read
@@ -675,10 +652,9 @@ paths:
675
652
schema:
676
653
$ref: '#/components/schemas/ServiceError'
677
654
description: An error occurred.
678
-
summary: Returns an array of one or two webhook keys. The first key is active.
679
-
The second key, if present, is expired.
655
+
summary: Returns an array of one or two webhook keys. The first key is active. The second key, if present, is expired.
680
656
tags:
681
657
- Webhook Keys
682
658
x-auth-required: false
683
659
684
-
# Retrieved from scp-openapi commit 0946f4bc226a17b28c46e9494b83fff7a8f8720c path: action/v1beta2/openapi.yaml
660
+
# Retrieved from scp-openapi commit 2a83a71fc5f034d6a6308d40793cf42658bfbf9a path: action/v1beta2/openapi.yaml
Copy file name to clipboardExpand all lines: splunk_sdk/action/v2alpha1/openapi.yaml
+23-51Lines changed: 23 additions & 51 deletions
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,7 @@
1
1
components:
2
2
parameters:
3
3
ActionName:
4
-
description: The name of the action as one or more identifier strings separated
5
-
by periods. Each identifier string consists of lowercase letters, digits,
6
-
and underscores, and cannot start with a digit.
4
+
description: The name of the action as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
7
5
in: path
8
6
name: action_name
9
7
required: true
@@ -64,8 +62,7 @@ components:
64
62
ActionImmutable:
65
63
properties:
66
64
createdAt:
67
-
description: The date and time this action template was created (ISO-8601
68
-
date/time with zone).
65
+
description: The date and time this action template was created (ISO-8601 date/time with zone).
69
66
format: date-time
70
67
readOnly: true
71
68
type: string
@@ -76,14 +73,11 @@ components:
76
73
kind:
77
74
$ref: '#/components/schemas/ActionKind'
78
75
name:
79
-
description: The name of the action, as one or more identifier strings separated
80
-
by periods. Each identifier string consists of lowercase letters, digits,
81
-
and underscores, and cannot start with a digit.
76
+
description: The name of the action, as one or more identifier strings separated by periods. Each identifier string consists of lowercase letters, digits, and underscores, and cannot start with a digit.
description: A message delivered to a tenant member from the platform or a subscribed
114
-
app.
107
+
description: A message delivered to a tenant member from the platform or a subscribed app.
115
108
type: object
116
109
AppMessageAction:
117
110
allOf:
@@ -143,8 +136,7 @@ components:
143
136
AppMessageImmutable:
144
137
properties:
145
138
clientId:
146
-
description: Application or service client ID that caused the message to
147
-
be created.
139
+
description: Application or service client ID that caused the message to be created.
148
140
readOnly: true
149
141
type: string
150
142
clientKind:
@@ -185,8 +177,7 @@ components:
185
177
AppMessageInternal:
186
178
properties:
187
179
createdAt:
188
-
description: The date and time this trigger map entry was created (ISO-8601
189
-
date/time with zone).
180
+
description: The date and time this trigger map entry was created (ISO-8601 date/time with zone).
190
181
format: date-time
191
182
readOnly: true
192
183
type: string
@@ -199,8 +190,7 @@ components:
199
190
readOnly: true
200
191
type: string
201
192
updatedAt:
202
-
description: The date and time this trigger map entry was updated (ISO-8601
203
-
date/time with zone).
193
+
description: The date and time this trigger map entry was updated (ISO-8601 date/time with zone).
204
194
format: date-time
205
195
readOnly: true
206
196
type: string
@@ -224,18 +214,15 @@ components:
224
214
- state
225
215
type: object
226
216
AppMessagePaginatedList:
227
-
description: A list of app messages delivered to the user. May also include
228
-
a next token which can be returned to the service to retrieve the next page
229
-
of messages.
217
+
description: A list of app messages delivered to the user. May also include a next token which can be returned to the service to retrieve the next page of messages.
230
218
properties:
231
219
items:
232
220
description: An array of app messages
233
221
items:
234
222
$ref: '#/components/schemas/AppMessage'
235
223
type: array
236
224
next:
237
-
description: A token that can be returned to the service to retrieve the
238
-
next page of messages
225
+
description: A token that can be returned to the service to retrieve the next page of messages
239
226
type: string
240
227
required:
241
228
- items
@@ -265,34 +252,26 @@ components:
265
252
type: string
266
253
type: array
267
254
body:
268
-
description: HTML content to send as the body of the email. You can use
269
-
a template in this field.
255
+
description: HTML content to send as the body of the email. You can use a template in this field.
270
256
example: <html><body>Hello, this is my test email.</body></html>
271
257
type: string
272
258
bodyPlainText:
273
-
description: Optional text to send as the text/plain part of the email.
274
-
If this field is not set for an email action, the Action service converts
275
-
the value from the body field to text and sends that as the text/plain
276
-
part when triggering the action. You can use a template in this field.
259
+
description: Optional text to send as the text/plain part of the email. If this field is not set for an email action, the Action service converts the value from the body field to text and sends that as the text/plain part when triggering the action. You can use a template in this field.
277
260
example: Hello, this is my test email.
278
261
type: string
279
262
fromName:
280
-
description: Optional text providing a human-friendly name for the sender.
281
-
Must be less than or equal to 81 characters. You can use a template in
282
-
this field.
263
+
description: Optional text providing a human-friendly name for the sender. Must be less than or equal to 81 characters. You can use a template in this field.
283
264
type: string
284
265
members:
285
-
description: An array of tenant member names, whose profile email addresses
286
-
will be included as recipients.
266
+
description: An array of tenant member names, whose profile email addresses will be included as recipients.
287
267
items:
288
268
type: string
289
269
type: array
290
270
subject:
291
271
description: The subject of the email. You can use a template in this field.
292
272
type: string
293
273
title:
294
-
description: A human-readable title for the action. Must be less than or
295
-
equal to 128 characters.
274
+
description: A human-readable title for the action. Must be less than or equal to 128 characters.
296
275
type: string
297
276
type: object
298
277
PublicWebhookKey:
@@ -349,12 +328,10 @@ components:
349
328
type: string
350
329
type: array
351
330
expiresAtUTCEpoch:
352
-
description: Unix epoch timestamp in UTC indicating when the message
353
-
expires.
331
+
description: Unix epoch timestamp in UTC indicating when the message expires.
354
332
type: integer
355
333
members:
356
-
description: An array of tenant member names, whose profile email addresses
357
-
will be included as recipients.
334
+
description: An array of tenant member names, whose profile email addresses will be included as recipients.
358
335
items:
359
336
type: string
360
337
type: array
@@ -400,8 +377,7 @@ components:
400
377
TriggerMapEntryImmutable:
401
378
properties:
402
379
createdAt:
403
-
description: The date and time this trigger map entry was created (ISO-8601
404
-
date/time with zone).
380
+
description: The date and time this trigger map entry was created (ISO-8601 date/time with zone).
0 commit comments