forked from AdobeDocs/adobeio-events
-
Notifications
You must be signed in to change notification settings - Fork 0
/
events-api-reference.yaml
1069 lines (1069 loc) · 32.5 KB
/
events-api-reference.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
title: Adobe I/O Events API
version: '2.0'
host: api-stage.adobe.io
basePath: /
tags:
- name: Providers
- name: Event Metadata
- name: Sample Event
- name: Registrations
- name: Tracing
- name: Journaling
paths:
'/events/providers/{providerId}/eventmetadata/{eventCode}':
get:
tags:
- Event Metadata
summary: Get the Event Metadata associated with a given Adobe I/O Events Provider ID and event code
operationId: getByProviderIdAndEventCode
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/eventCode'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/EventMetadataHalModel'
'/events/providers/{providerId}/eventmetadata':
get:
tags:
- Event Metadata
summary: List the Event Metadata associated with a given Adobe I/O Events Provider ID
description: ''
operationId: getByProviderId
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/EventMetadataCollectionHalModel'
'/events/{consumerOrgId}/{projectId}/{workspaceId}/providers/{providerId}/eventmetadata':
post:
tags:
- Event Metadata
summary: Create an Adobe I/O Events Provider Event Metadata
description: ''
operationId: post
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/workspaceId'
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
- in: body
name: body
description: The Input Model necessary to create an Adobe I/O Events Provider Event Metadata
required: false
schema:
$ref: '#/definitions/EventMetadataInputModel'
responses:
'201':
description: The created Adobe I/O Events Provider Event Metadata.
schema:
$ref: '#/definitions/EventMetadataHalModel'
delete:
tags:
- Event Metadata
summary: Delete all Event Metadata associated with the given Adobe I/O Events Provider ID
description: ''
operationId: deleteByProviderId
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/workspaceId'
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
responses:
'204':
description: Successful deletion
'404':
description: The providerId does not exist
'/events/{consumerOrgId}/{projectId}/{workspaceId}/providers/{providerId}/eventmetadata/{eventCode}':
put:
tags:
- Event Metadata
summary: Update an Adobe I/O Events Provider Event Metadata
description: ''
operationId: putEventMetadata
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/workspaceId'
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/eventCode'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
- in: body
name: body
description: The Input Model necessary to update an Adobe I/O Events Provider Event Metadata
required: false
schema:
$ref: '#/definitions/EventMetadataInputModel'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/EventMetadataHalModel'
patch:
tags:
- Event Metadata
summary: PATCH an Adobe I/O Events Provider Event Metadata using JSON Patch
description: ''
operationId: patchEventMetadata
consumes:
- application/json-patch+json
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/workspaceId'
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/eventCode'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
- in: body
name: body
description: 'A JSON Patch of the EventMetadata Input Model see https://tools.ietf.org/html/rfc6902, http://jsonpatch.com/'
required: false
schema:
$ref: '#/definitions/JsonPatch'
- $ref: '#/parameters/contentTypeJSONPatch'
responses:
'200':
description: The updated/patched Event Metadata
schema:
$ref: '#/definitions/EventMetadataHalModel'
'204':
description: If the patch had no effect
delete:
tags:
- Event Metadata
summary: Delete the Event Metadata associated with the given Adobe I/O Events Provider ID and event code
description: ''
operationId: deleteByProviderIdAndEventCode
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/workspaceId'
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/eventCode'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
responses:
'204':
description: Successful deletion
'404':
description: The event metadata does not exist
'/events/{consumerOrgId}/providers':
get:
tags:
- Providers
summary: List all Adobe I/O Events Providers entitled to the provided Organization ID
description: ''
operationId: getProvidersByConsumerOrgId
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ProviderCollectionHalModel'
'/events/providers/{id}':
get:
tags:
- Providers
summary: View Adobe I/O Events Provider by ID
description: ''
operationId: getProvidersById
produces:
- application/hal+json
parameters:
- name: id
in: path
description: The requested provider Id
required: true
type: string
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
- name: eventmetadata
in: query
description: The optional boolean to fetch or not this provider's event metadata
required: false
type: boolean
default: false
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ProviderHalModel'
'/events/{consumerOrgId}/{projectId}/{workspaceId}/providers':
post:
tags:
- Providers
summary: Create an Adobe I/O Events Provider
description: ''
operationId: createProvider
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/workspaceId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
- in: body
name: body
description: The Input Model necessary to create an Adobe I/O Events Provider
required: false
schema:
$ref: '#/definitions/ProviderInputModel'
responses:
'201':
description: The created Adobe I/O Events Provider.
schema:
$ref: '#/definitions/ProviderHalModel'
'/events/{consumerOrgId}/{projectId}/{workspaceId}/providers/{providerId}':
put:
tags:
- Providers
summary: Update an Adobe I/O Events Provider
description: ''
operationId: putProvider
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/workspaceId'
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
- in: body
name: body
description: The Input Model necessary to update an Adobe I/O Events Provider
required: false
schema:
$ref: '#/definitions/ProviderInputModel'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ProviderHalModel'
patch:
tags:
- Providers
summary: PATCH an Adobe I/O Events Provider using JSON Patch
description: ''
operationId: patchProvider
consumes:
- application/json-patch+json
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/workspaceId'
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
- $ref: '#/parameters/contentTypeJSONPatch'
- in: body
name: body
description: 'A JSON Patch of the Provider Input Model see https://tools.ietf.org/html/rfc6902, http://jsonpatch.com/'
required: false
schema:
$ref: '#/definitions/JsonPatch'
responses:
'200':
description: The updated/patched provider
schema:
$ref: '#/definitions/ProviderHalModel'
'204':
description: If the patch had no effect
delete:
tags:
- Providers
summary: Delete an Adobe I/O Events Provider by ID
description: ''
operationId: deleteProvider
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/projectId'
- $ref: '#/parameters/workspaceId'
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
responses:
'204':
description: Successful deletion
'404':
description: The providerId does not exist
'/events/providers/{providerId}/eventmetadata/{eventCode}/sample_event':
get:
tags:
- Sample Event
summary: Get a sample event HAL JSON model of the provided Adobe I/O Events Provider ID and event code
description: ''
operationId: getSampleByProviderIdAndEventCode
produces:
- application/hal+json
parameters:
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/eventCode'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/accept-hal-json'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/TheSampleEventHALmodel'
head:
tags:
- Sample Event
summary: Check if a sample event is available for the provided Adobe I/O Events Provider ID and event code
description: ''
operationId: checkSampleEvent
parameters:
- $ref: '#/parameters/providerId'
- $ref: '#/parameters/eventCode'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
responses:
'200':
description: If a sample event is available
'404':
description: If no sample event is available
'/events/organizations/{consumerOrgId}/integrations/{integrationId}/{registrationId}/validate':
get:
tags:
- Journaling
summary: Validate and get all Events from journal
operationId: getValidateEventsFromJournal
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/integrationId'
- $ref: '#/parameters/registrationId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/x-ims-org-id'
- name: x-adobe-io-events-url-links
in: header
required: false
type: boolean
- name: limit
in: query
required: false
type: integer
format: int32
- name: since
in: query
required: false
type: string
responses:
default:
description: successful operation
'/events/organizations/{consumerOrgId}/integrations/{integrationId}/{registrationId}':
get:
tags:
- Journaling
summary: Get all Events for a registration from journal
operationId: getEventsFromJournal
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/integrationId'
- $ref: '#/parameters/registrationId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/x-ims-org-id'
- name: x-adobe-io-events-url-links
in: header
required: false
type: boolean
- name: limit
in: query
required: false
type: integer
format: int32
- name: since
in: query
required: false
type: string
- name: seek
in: query
required: false
type: string
- name: latest
in: query
required: false
type: boolean
responses:
default:
description: successful operation
'/events/organizations/{consumerOrgId}/integrations/{integrationId}/registrations':
get:
tags:
- Registrations
summary: List all registration details
operationId: getRegistrations
produces:
- application/json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/integrationId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/x-ims-org-id'
- name: delivery_type
in: query
required: false
type: string
enum:
- WEBHOOK
- JOURNAL
- WEBHOOK_BATCH
responses:
'200':
description: successful operation
schema:
type: array
items:
$ref: '#/definitions/Registration'
post:
tags:
- Registrations
summary: Create a Webhook/Journal registration for given integration
operationId: createRegistrationCli
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/integrationId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/x-ims-org-id'
- in: body
name: body
required: false
schema:
$ref: '#/definitions/Registration'
responses:
'200':
description: successful operation
schema:
type: array
items:
$ref: '#/definitions/Registration'
'/events/organizations/{consumerOrgId}/integrations/{integrationId}/registrations/{registrationId}':
get:
tags:
- Registrations
summary: Get registration details based on Organization ID, Integration ID, and Registration ID
operationId: getRegistrationDetails
produces:
- application/json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/integrationId'
- $ref: '#/parameters/registrationId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/x-ims-org-id'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/Registration'
delete:
tags:
- Registrations
summary: Delete registration details based on Organization ID, Integration ID, and Registration ID
operationId: deleteRegistrationDetails
produces:
- application/json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/integrationId'
- $ref: '#/parameters/registrationId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/x-ims-org-id'
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/Registration'
'/events/organizations/{consumerOrgId}/integrations/{integrationId}/tracing/{registrationId}':
get:
tags:
- Tracing
summary: Get tracing details for a specific webhook
operationId: getTracesApi
produces:
- application/json
parameters:
- $ref: '#/parameters/consumerOrgId'
- $ref: '#/parameters/integrationId'
- $ref: '#/parameters/registrationId'
- $ref: '#/parameters/authorization'
- $ref: '#/parameters/x-api-key'
- $ref: '#/parameters/x-ims-org-id'
responses:
'200':
description: successful operation
schema:
type: array
items:
$ref: '#/definitions/TracingRequestResponse'
parameters:
consumerOrgId:
name: consumerOrgId
in: path
description: Your consumer organization Id (owning the Adobe I/O Events Provider)
required: true
type: string
projectId:
name: projectId
in: path
description: The project Id where the Adobe I/O Events Provider belongs
required: true
type: string
workspaceId:
name: workspaceId
in: path
description: The workspace Id where the Adobe I/O Events Provider belongs
required: true
type: string
providerId:
name: providerId
in: path
description: The requested provider ID.
required: true
type: string
eventCode:
name: eventCode
in: path
description: The requested eventmetadata event code
required: true
type: string
integrationId:
name: integrationId
in: path
description: The integration Id associated with the project/workspace you created your registration in
required: true
type: string
registrationId:
name: registrationId
in: path
required: true
type: string
authorization:
name: Authorization
description: 'Authorization access token in the format "Bearer {TOKEN}".'
required: true
type: string
in: header
x-api-key:
name: x-api-key
description: 'API key whiltelisted at Adobe.io'
required: true
type: string
in: header
x-ims-org-id:
name: x-ims-org-id
in: header
required: false
type: string
content-type:
name: Content-Type
description: Type of content being sent in the body of the request. Should be 'application/json'.
required: true
type: string
in: header
default: application/json
accept-hal-json:
name: Accept
in: header
required: true
type: string
description: Content type accepted in the response.
default: application/hal+json
contentTypeJSONPatch:
name: Content-Type
in: header
required: true
type: string
default: application/json-patch+json
definitions:
CreateEnterpriseIntegrationResponse:
type: object
properties:
id:
type: string
apiKey:
type: string
orgId:
type: string
technicalAccountId:
type: string
trace:
$ref: '#/definitions/CreateEnterpriseIntegrationResponse'
SubscribeItem:
type: object
properties:
sdkCode:
type: string
licenceConfigs:
type: array
items:
$ref: '#/definitions/LicenseConfig'
roles:
type: array
items:
$ref: '#/definitions/Role'
trace:
$ref: '#/definitions/SubscribeItem'
LicenseConfig:
type: object
properties:
id:
type: string
name:
type: string
productId:
type: string
description:
type: string
selected:
type: boolean
Role:
type: object
properties:
id:
type: integer
format: int64
code:
type: string
name:
type: string
EventMetadataHalModel:
type: object
properties:
description:
type: string
description: 'The description of this Event, as shown on the Adobe I/O console'
label:
type: string
description: 'The label of this Event, as shown on the Adobe I/O console'
event_code:
type: string
description: 'This event_code describes the type of event. Ideally it should be prefixed with a reverse-DNS name (dictating the organization which defines the semantics of this event type) It is equivalent to the CloudEvents'' type. See https://github.com/cloudevents/spec/blob/master/spec.md#type'
_embedded:
type: object
properties:
sample_event:
description: A sample event HAL Model
$ref: '#/definitions/TheSampleEventHALmodel'
_links:
type: object
properties:
'rel:sample_event':
$ref: '#/definitions/HALLink'
'rel:update':
description: 'The link to the workspace context to perform update and delete operations.This link will only be set if the Events Provider is yours to update, and not Adobe''s.'
$ref: '#/definitions/HALLink'
self:
$ref: '#/definitions/HALLink'
description: The Adobe I/O Events Provider Event Metadata HAL model
HALLink:
type: object
properties:
href:
type: string
templated:
type: boolean
type:
type: string
deprecation:
type: string
format: url
name:
type: string
profile:
type: string
format: uri
title:
type: string
hreflang:
type: string
seen:
type: string
TheSampleEventHALmodel:
type: object
properties:
format:
type: string
description: 'The delivery format associated with this event sample,`adobe_io`, `cloud_events` '
sample_payload:
type: string
description: A generated sample Json Payload as expected in the webhook or journal deliveries of Adobe I/O Events
_links:
type: object
properties:
self:
$ref: '#/definitions/HALLink'
EventMetadataCollectionHalModel:
type: object
properties:
_embedded:
type: object
properties:
eventmetadata:
type: array
description: Adobe I/O Events Providers Event Metadata collection.
items:
$ref: '#/definitions/EventMetadataHalModel'
_links:
type: object
properties:
self:
$ref: '#/definitions/HALLink'
description: Adobe I/O Events Providers Event Metadata Collection HAL model
JsonPatch:
type: object
EventMetadataInputModel:
type: object
required:
- description
- event_code
- label
properties:
description:
type: string
description: 'The description of this Event Metadata, as shown on the Adobe I/O console'
minLength: 1
maxLength: 255
pattern: '[\w\s-_\.\(\)\,\@:''`?#!]+'
label:
type: string
description: 'The label of this Event Metadata, as shown on the Adobe I/O console'
minLength: 1
maxLength: 255
pattern: '[\w\s-_\.\(\)\,\@:''`?#!]+'
event_code:
type: string
description: 'The event_code of this Event Metadata. This event_code describes the type of event. Ideally it should be prefixed with a reverse-DNS name (dictating the organization which defines the semantics of this event type) It is equivalent to the CloudEvents'' type. see https://github.com/cloudevents/spec/blob/master/spec.md#type'
minLength: 1
maxLength: 255
pattern: '[\w-_\.]+'
sample_event_template:
type: string
description: An optional base64 encoded sample event template
minLength: 0
maxLength: 87382
pattern: '^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$'
description: The Input Model necessary to POST/PUT an Adobe I/O Events Provider Event Metadata
ProviderHalModel:
type: object
properties:
id:
type: string
description: The Id of this Events Provider
label:
type: string
description: 'The label of this Events Provider, as shown on the Adobe I/O console'
description:
type: string
description: 'The description of this Events Provider, as shown on the Adobe I/O console'
source:
type: string
description: 'A URI-reference (this provider id prefixed with `urn:uuid:`), identifying the context in which an event happened. Producers MUST ensure that source + event.id is unique for each distinct event. See https://github.com/cloudevents/spec/blob/master/spec.md#source-1'
readOnly: true
docs_url:
type: string
description: 'The documentation url of this Events Provider, as shown on the Adobe I/O console'
publisher:
type: string
description: 'The publisher is `Adobe` for Adobe Cloud Solution. In the case of multi-instances or on-premise Adobe solutions: the publisher will be set to the organization_id owning this solution. In the case of event-providers registered by an organization using Adobe I/O registration API: the publisher will be set to the organization_id which registered this events provider'
_embedded:
type: object
properties:
eventmetadata:
type: array
description: The list of event metadata associated with this Events Provider
items:
$ref: '#/definitions/EventMetadataHalModel'
_links:
type: object
properties:
'rel:eventmetadata':
description: The links to the event metadata associated with this Events Provider
$ref: '#/definitions/HALLink'
'rel:update':
description: 'The link to the workspace context to perform update and delete operations.This link will only be set if the Events Provider is yours to update, and not Adobe''s.'
$ref: '#/definitions/HALLink'
self:
description: link to self
$ref: '#/definitions/HALLink'
description: The Adobe I/O Events Provider HAL model
ProviderCollectionHalModel:
type: object
properties:
_embedded:
type: object
properties:
providers:
type: array
description: Adobe I/O Events Providers collection.
items:
$ref: '#/definitions/ProviderHalModel'
_links:
type: object
properties:
self:
$ref: '#/definitions/HALLink'
description: Adobe I/O Events Providers Collection HAL model
ProviderInputModel:
type: object
required:
- label
properties:
label:
type: string
description: 'The label of this Events Provider, as shown on the Adobe I/O console'
minLength: 1
maxLength: 255
pattern: '[\w\s-_\.\(\)\,\@:''`?#!]+'
description:
type: string
description: 'The description of this Events Provider, as shown on the Adobe I/O console'
minLength: 0
maxLength: 255
pattern: '[\w\s-_\.\(\)\,\@:''`?#!]+'
docs_url:
type: string
description: 'The documentation url of this Events Provider, as shown on the Adobe I/O console'
minLength: 0
maxLength: 255
pattern: 'https?://(([^/:.\s]+(\.[^/:.\s]+)*)|([0-9](\.[0-9]{3})))(:[0-9]+)?((/[^?#\s]+)(\?[^#\s]+)?(#.+)?)?/?'
description: The Input Model necessary to POST/PUT an Adobe I/O Events Provider
EventsOfInterest:
type: object
properties:
event_code:
type: string
minLength: 1
maxLength: 255
event_label:
type: string
event_description:
type: string
provider_id:
type: string
minLength: 1
maxLength: 38
provider:
type: string
minLength: 1
maxLength: 255
provider_label:
type: string
provider_description:
type: string
provider_docs_url:
type: string
event_delivery_format:
type: string
Registration:
type: object
required:
- client_id
- name
properties:
id:
type: integer
format: int64
name:
type: string
minLength: 3
maxLength: 255
description:
type: string
minLength: 0
maxLength: 5000
client_id:
type: string
minLength: 3
maxLength: 255
parent_client_id:
type: string
minLength: 0
maxLength: 255
webhook_url:
type: string
minLength: 0
maxLength: 4000
status:
type: string
enum:
- ACCEPTED
- VERIFIED
- VERIFICATION_FAILED
- HOOK_UNREACHABLE
- DELETED
type:
type: string
enum:
- USER
- APP
integration_status:
type: string
enum:
- ENABLED
- DISABLED
events_of_interest:
type: array
uniqueItems: true
items:
$ref: '#/definitions/EventsOfInterest'
registration_id:
type: string
minLength: 0
maxLength: 255
delivery_type:
type: string
enum:
- WEBHOOK
- JOURNAL
- WEBHOOK_BATCH
events_url:
type: string
created_date:
type: string
updated_date:
type: string
runtime_action:
type: string
minLength: 0
maxLength: 255
Trace:
type: object
properties:
tracingRequest:
$ref: '#/definitions/TracingRequest'
tracingResponse:
$ref: '#/definitions/TracingResponse'
ts:
type: integer