-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathecosystem.yml
1240 lines (1237 loc) · 31.3 KB
/
ecosystem.yml
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
openapi: 3.0.3
info:
version: 0.0.6
title: Ecosystem API
description: 'Ecosystem API'
contact:
email: [email protected]
url: 'https://developers.apideck.com'
x-logo:
url: 'https://developers.apideck.com/icon.png'
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
externalDocs:
description: Apideck Developer Docs
url: 'https://developers.apideck.com'
servers:
- url: 'https://api.apideck.com'
description: Production
security: []
tags:
- name: Ecosystem
description: ''
- name: Listing
description: ''
- name: Collection
description: ''
- name: Category
description: ''
- name: Product
description: ''
components:
schemas:
Category:
type: object
additionalProperties: false
required: [name, slug]
properties:
id:
type: string
description:
type: string
name:
type: string
slug:
type: string
count:
type: integer
example: 1
translations:
$ref: '#/components/schemas/Translations'
listing_description_text_template:
type: string
listing_pricing_text_template:
type: string
listing_features_text_template:
type: string
logo:
$ref: '#/components/schemas/Logo'
created_at:
type: string
readOnly: true
format: date-time
updated_at:
type: string
readOnly: true
format: date-time
Collection:
type: object
additionalProperties: false
required: [name, slug, visible]
properties:
id:
type: string
card_background_color:
type: string
card_background_image:
$ref: '#/components/schemas/File'
card_columns:
type: integer
card_style:
type: string
count:
type: integer
example: 1
description:
type: string
logo:
$ref: '#/components/schemas/File'
name:
type: string
hidden_from_homepage:
type: boolean
show_max_items_homepage:
type: integer
sequence:
type: integer
slug:
type: string
translations:
$ref: '#/components/schemas/Translations'
visible:
type: boolean
CardSettings:
type: object
additionalProperties: false
properties:
background_color:
type: string
border_color:
type: string
border_radius:
type: string
border_size:
type: string
color:
type: string
columns:
type: integer
description_lines:
type: integer
icon_border_radius:
type: string
icon_shadow_enabled:
type: boolean
icon_size:
type: integer
shadow_enabled:
type: boolean
show_action:
type: boolean
show_badges:
type: boolean
show_category:
type: boolean
show_description:
type: boolean
style:
type: string
Contact:
type: object
required: [name]
properties:
id:
type: string
readOnly: true
example: '12345'
first_name:
type: string
last_name:
type: string
name:
type: string
email:
type: string
role:
type: string
linked_in:
type: string
twitter:
type: string
CTASettings:
type: object
additionalProperties: false
properties:
background_color:
type: string
button_background_color:
type: string
button_color:
type: string
button_label:
type: string
button_link:
type: string
color:
type: string
description:
type: string
enabled:
type: boolean
title:
type: string
CustomSettings:
type: object
additionalProperties: false
properties:
css:
type: string
css_link:
type: string
domain:
type: string
html_footer:
type: string
html_nav:
type: string
java_script_link:
type: string
Ecosystem:
type: object
additionalProperties: false
required: [name, slug, is_published]
properties:
id:
type: string
readOnly: true
example: '12345'
about:
type: string
alternatives_background_color:
type: string
alternatives_color:
type: string
attribution:
type: boolean
body_background_color:
type: string
body_button_background_color:
type: string
body_button_color:
type: string
body_color:
type: string
body_link_color:
type: string
card_settings:
$ref: '#/components/schemas/CardSettings'
categories_count_badge:
type: boolean
categories_show_max_items:
type: integer
collections_count_badge:
type: boolean
collections_title:
type: string
create_link:
type: string
cta_settings:
$ref: '#/components/schemas/CTASettings'
custom_domain:
type: string
custom_settings:
$ref: '#/components/schemas/CustomSettings'
detail_pages_enabled:
type: boolean
footer_background_color:
type: string
footer_color:
type: string
google_site_verification_id:
type: string
hide_install_buttons:
type: boolean
home_page_collection_category_cards:
type: boolean
home_page_show_all_listings:
type: boolean
installation_request_flow_enabled:
type: boolean
integration_settings:
$ref: '#/components/schemas/IntegrationSettings'
is_published:
type: boolean
lead_form_settings:
$ref: '#/components/schemas/LeadFormSettings'
listing_settings:
$ref: '#/components/schemas/ListingSettings'
masthead_settings:
$ref: '#/components/schemas/MastheadSettings'
menu_position:
enum:
- TOP
- LEFT
- RIGHT
- HIDDEN
type: string
menu_style:
enum:
- LIST
- PILL
- FILTER
type: string
meta_tag_settings:
$ref: '#/components/schemas/MetaTagSettings'
name:
type: string
navigation_background_color:
type: string
navigation_color:
type: string
navigation_logo_post_fix:
type: string
navigation_mobile_menu_type:
enum:
- ICON
- TEXT
type: string
navigation_sticky:
type: boolean
primary_color:
type: string
privacy_link:
type: string
request_link:
type: string
shadow_page_description:
type: string
shadow_pages_enabled:
type: boolean
show_attribution_badge:
type: boolean
show_requested_listings:
type: boolean
slug:
type: string
terms_link:
type: string
total_published_listings:
type: integer
unify_application_id:
type: string
utm_campaign:
type: string
website:
type: string
zaps_menu_title:
type: string
zaps_page_enabled:
type: boolean
created_at:
type: string
readOnly: true
format: date-time
updated_at:
type: string
readOnly: true
format: date-time
File:
type: object
required: [url]
properties:
id:
type: string
readOnly: true
example: '12345'
content_type:
type: string
example: 'application/jpeg'
type:
enum:
- LOGO
- BANNER
- SCREENSHOT
type: string
url:
type: string
created_at:
type: string
readOnly: true
format: date-time
updated_at:
type: string
readOnly: true
format: date-time
IntegrationSettings:
type: object
additionalProperties: false
properties:
albacross_id:
type: string
automate_enabled:
type: boolean
blendr_enabled:
type: boolean
combidesk_enabled:
type: boolean
crisp_id:
type: string
drift_id:
type: string
google_analytics_id:
type: string
google_tag_manager_id:
type: string
heap_id:
type: string
hubspot_portal_id:
type: string
integromat_enabled:
type: boolean
intercom_app_id:
type: string
iubenda_cookie_policy_id:
type: string
iubenda_site_id:
type: string
journy_io_domain:
type: string
journy_io_id:
type: string
livechat_id:
type: string
metomic_id:
type: string
microsoft_flow_id:
type: string
microsoft_flow_enabled:
type: boolean
onetrust_id:
type: string
piesync_enabled:
type: boolean
segment_id:
type: string
segment_enabled:
type: boolean
tray_io_enabled:
type: boolean
zapier_beta_link:
type: string
zapier_enabled:
type: boolean
zapier_id:
type: string
LeadFormSettings:
type: object
additionalProperties: false
properties:
capture_form_enabled:
type: boolean
first_name_field_enabled:
type: boolean
first_name_field_required:
type: boolean
integration_enabled:
type: boolean
last_name_field_enabled:
type: boolean
last_name_field_required:
type: boolean
telephone_field_enabled:
type: boolean
telephone_field_required:
type: boolean
work_email_validation:
type: boolean
Links:
type: object
description: Links to navigate to previous or next pages through the API
required: [current]
properties:
previous:
type: string
description: Link to navigate to the previous page through the API
example: 'https://api.apideck.com/ecosystem/123abc/listings?cursor=em9oby1jcm06OnBhZ2U6OjE%3D'
current:
type: string
description: Link to navigate to the current page through the API
example: 'https://api.apideck.com/ecosystem/123abc/listings'
next:
type: string
description: Link to navigate to the previous page through the API
example: 'https://api.apideck.com/ecosystem/123abc/listings?cursor=em9oby1jcm06OnBhZ2U6OjM'
Listing:
type: object
additionalProperties: false
required: [name, slug]
properties:
id:
type: string
readOnly: true
example: '12345'
external_id:
type: string
readOnly: true
example: '12345'
automate_id:
type: string
blendr_id:
type: string
card_background_color:
type: string
card_background_image:
$ref: '#/components/schemas/File'
categories:
type: array
items:
$ref: '#/components/schemas/Category'
cloud_service_id:
type: string
combidesk_id:
type: string
collections:
type: array
items:
$ref: '#/components/schemas/Collection'
description:
type: string
detail_page_disabled:
type: boolean
features:
type: string
integromat_id:
type: string
logo:
$ref: '#/components/schemas/Logo'
meta_tag_description:
type: string
meta_tag_keywords:
type: string
meta_tag_title:
type: string
microsoft_flow_id:
type: string
name:
type: string
native_integration:
type: boolean
native_integration_link:
type: string
media:
type: array
items:
$ref: '#/components/schemas/Media'
partner:
$ref: '#/components/schemas/Partner'
piesync_id:
type: string
pricing:
type: string
products:
type: array
items:
$ref: '#/components/schemas/Product'
published:
type: boolean
published_at:
type: string
readOnly: true
format: date-time
screenshots:
type: array
items:
$ref: '#/components/schemas/Screenshot'
segment_id:
type: string
slug:
type: string
sticky:
type: boolean
tag_line:
type: string
third_party_integration:
type: boolean
third_party_integration_link:
type: string
translations:
$ref: '#/components/schemas/Translations'
tray_io_id:
type: string
unify_connector_id:
type: string
upcoming:
type: boolean
zapier_id:
type: string
created_at:
type: string
readOnly: true
format: date-time
updated_at:
type: string
readOnly: true
format: date-time
ListingSettings:
type: object
additionalProperties: false
properties:
description_text_template:
type: string
description_title:
type: string
features_text_template:
type: string
features_title:
type: string
install_button_label:
type: string
name_postfix:
type: string
naming:
enum:
- LISTING
- LISTINGS
- INTEGRATIONS
- APPS
- CONNECTORS
- DATASOURCES
- ADDONS
- PLUGINS
- PARTNERS
- CHANNELS
- CONNECTIONS
- EXTENSIONS
type: string
native_integration_link:
type: string
pricing_disabled:
type: boolean
pricing_text_template:
type: string
pricing_title:
type: string
sidebar_position:
enum:
- TOP
- LEFT
- RIGHT
- HIDDEN
type: string
Logo:
type: object
additionalProperties: false
required: [url]
properties:
content_type:
type: string
id:
type: string
type:
enum:
- LOGO
- BANNER
- SCREENSHOT
type: string
url:
type: string
MastheadSettings:
type: object
additionalProperties: false
properties:
background:
type: string
background_color:
type: string
color:
type: string
columns:
type: integer
description:
type: string
title:
type: string
Media:
type: object
additionalProperties: false
required: [url]
properties:
id:
type: string
readOnly: true
example: '12345'
caption:
type: string
example: 'Media'
type:
enum:
- SCREENSHOT
- VIDEO
type: string
url:
type: string
sequence:
type: integer
example: 1
translations:
$ref: '#/components/schemas/Translations'
Meta:
type: object
description: Response metadata
properties:
items_on_page:
type: integer
description: Number of items returned in the data property of the response
example: 50
cursors:
type: object
description: Cursors to navigate to previous or next pages through the API
properties:
previous:
type: string
description: Cursor to navigate to the previous page of results through the API
example: em9oby1jcm06OnBhZ2U6OjE=
nullable: true
current:
type: string
description: Cursor to navigate to the current page of results through the API
example: em9oby1jcm06OnBhZ2U6OjI=
nullable: true
next:
type: string
description: Cursor to navigate to the next page of results through the API
example: em9oby1jcm06OnBhZ2U6OjM=
nullable: true
MetaTagSettings:
type: object
additionalProperties: false
properties:
description:
type: string
description_category_page:
type: string
description_collection_page:
type: string
description_listing_page:
type: string
keywords:
type: string
title:
type: string
title_postfix:
type: string
Partner:
type: object
additionalProperties: false
required: [company]
properties:
id:
type: string
readOnly: true
example: '12345'
company:
type: string
contacts:
type: array
items:
$ref: '#/components/schemas/Contact'
icon:
$ref: '#/components/schemas/File'
listed:
type: string
twitter:
type: string
website:
type: string
created_at:
type: string
readOnly: true
format: date-time
updated_at:
type: string
readOnly: true
format: date-time
Product:
type: 'object'
additionalProperties: false
required: [name, slug, visible]
properties:
id:
type: string
readOnly: true
example: '12345'
name:
type: string
slug:
type: string
description:
type: string
visible:
type: boolean
sequence:
type: integer
example: 1
count:
type: integer
example: 1
logo:
$ref: '#/components/schemas/File'
translations:
$ref: '#/components/schemas/Translations'
Screenshot:
type: object
additionalProperties: false
properties:
id:
type: string
readOnly: true
example: '12345'
caption:
type: string
example: 'Screenshot'
file:
$ref: '#/components/schemas/File'
translations:
$ref: '#/components/schemas/Translations'
Translations:
nullable: true
type: array
required: [key, locale, value]
items:
$ref: '#/components/schemas/Translation'
Translation:
type: object
required: [key, locale]
properties:
key:
type: string
locale:
type: string
value:
type: string
GetEcosystemResponse:
type: object
required:
- status_code
- status
- data
properties:
status_code:
type: integer
description: HTTP Response Status Code
example: 200
status:
type: string
description: HTTP Response Status
example: OK
data:
$ref: '#/components/schemas/Ecosystem'
GetCategoriesResponse:
type: object
required:
- status_code
- status
- data
properties:
status_code:
type: integer
description: HTTP Response Status Code
example: 200
status:
type: string
description: HTTP Response Status
example: OK
data:
type: array
items: { $ref: '#/components/schemas/Category' }
meta:
$ref: '#/components/schemas/Meta'
links:
$ref: '#/components/schemas/Links'
GetCategoryResponse:
type: object
required:
- status_code
- status
- data
properties:
status_code:
type: integer
description: HTTP Response Status Code
example: 200
status:
type: string
description: HTTP Response Status
example: OK
data:
$ref: '#/components/schemas/Category'
GetCollectionsResponse:
type: object
required:
- status_code
- status
- data
properties:
status_code:
type: integer
description: HTTP Response Status Code
example: 200
status:
type: string
description: HTTP Response Status
example: OK
data:
type: array
items: { $ref: '#/components/schemas/Collection' }
GetCollectionResponse:
type: object
required:
- status_code
- status
- data
properties:
status_code:
type: integer
description: HTTP Response Status Code
example: 200
status:
type: string
description: HTTP Response Status
example: OK
data:
$ref: '#/components/schemas/Collection'
GetProductsResponse:
type: object
required:
- status_code
- status
- data
properties:
status_code:
type: integer
description: HTTP Response Status Code
example: 200
status:
type: string
description: HTTP Response Status
example: OK
data:
type: array
items: { $ref: '#/components/schemas/Product' }
meta:
$ref: '#/components/schemas/Meta'
links:
$ref: '#/components/schemas/Links'
GetProductResponse:
type: object
required:
- status_code
- status
- data
properties:
status_code:
type: integer
description: HTTP Response Status Code
example: 200
status:
type: string
description: HTTP Response Status
example: OK
data:
$ref: '#/components/schemas/Product'
GetListingsResponse:
type: object
required:
- status_code
- status
- data
properties:
status_code:
type: integer
description: HTTP Response Status Code
example: 200
status:
type: string
description: HTTP Response Status
example: OK
data:
type: array
items: { $ref: '#/components/schemas/Listing' }
meta:
$ref: '#/components/schemas/Meta'
links:
$ref: '#/components/schemas/Links'
GetListingResponse:
type: object
required:
- status_code
- status
- data
properties:
status_code:
type: integer
description: HTTP Response Status Code
example: 200
status:
type: string
description: HTTP Response Status
example: OK
data:
$ref: '#/components/schemas/Listing'
parameters:
cursor:
name: cursor
in: query
description: Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
schema:
type: string
nullable: true
ecosystem_id:
name: ecosystem_id
in: path
required: true
schema:
type: string
external_id:
name: external_id