-
Notifications
You must be signed in to change notification settings - Fork 2
/
spec.yaml
1222 lines (1186 loc) · 36.6 KB
/
spec.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:
version: 1.0.0
title: wikifeeds
description: A node webservice supporting featured wiki content feeds
termsOfService: https://wikimediafoundation.org/wiki/Terms_of_Use
contact:
name: Wikimedia Product Infrastructure Team
url: https://www.mediawiki.org/wiki/Wikimedia_Product/Wikimedia_Product_Infrastructure_team
license:
name: Apache2
url: http://www.apache.org/licenses/LICENSE-2.0
x-default-params:
domain: en.wikipedia.org
parameters:
domain:
in: path
name: domain
required: true
type: string
description: |
Project domain for the requested data.
title:
in: path
name: title
required: true
type: string
description: |
Page title. Use underscores instead of spaces. Example: `Main_Page`
revision:
in: path
name: revision
required: false
type: integer
description: Revision ID
tid:
in: path
name: tid
required: false
type: integer
description: Time UUID of the rendering (used for rerenders when non-revision content changes)
year:
in: path
name: year
required: true
type: integer
description: Four digit year (2016 and later)
minimum: 2016
maximum: 2999
month:
in: path
name: month
required: true
type: integer
description: Two digit month, 0-padded if necessary (01 - 12)
minimum: 01
maximum: 31
day:
in: path
name: day
required: true
type: integer
description: Two digit day of the month, 0-padded if necessary (01 - 31)
minimum: 01
maximum: 31
paths:
# from routes/root.js
/robots.txt:
get:
tags:
- Root
description: Gets robots.txt
responses:
200:
description: Success
default:
description: Error
schema:
$ref: "#/definitions/problem"
x-monitor: false
/:
get:
tags:
- Root
description: The root service end-point
produces:
- application/json
- application/problem+json
responses:
200:
description: Success
default:
description: Error
schema:
$ref: "#/definitions/problem"
x-amples:
- title: spec from root
request:
query:
spec: true
response:
status: 200
# from routes/info.js
/_info:
get:
tags:
- Root
description: Gets information about the service.
produces:
- application/json
- application/problem+json
responses:
200:
description: Success
default:
description: Error
schema:
$ref: "#/definitions/problem"
x-amples:
- title: retrieve service info
request: {}
response:
status: 200
headers:
content-type: application/json
body:
name: /.+/
description: /.+/
version: /.+/
home: /.+/
# from routes/feed/availability.js
/{domain}/v1/feed/availability:
get:
tags:
- Feed
summary: Get availability of featured feed content by wiki domain.
produces:
- application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Availability/1.0.1"
- application/problem+json
parameters:
- $ref: "#/parameters/domain"
responses:
200:
description: Availability of the feed content by wiki domain
schema:
$ref: "#/definitions/availability"
default:
description: Error
schema:
$ref: "#/definitions/problem"
x-amples:
- title: Retrieve feed content availability from \'wikipedia.org\'
request:
params:
domain: wikimedia.org
response:
status: 200
headers:
content-type: application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Availability/1.0.1"
vary: /.+/
etag: /^"[^/"]+/[^/"]+"$/
access-control-allow-origin: "*"
access-control-allow-headers: accept, x-requested-with, content-type
content-security-policy: default-src
x-content-security-policy: default-src
x-frame-options: SAMEORIGIN
body:
todays_featured_article: [ /.+/ ]
most_read: [ "*" ]
picture_of_the_day: [ "*" ]
in_the_news: [ /.+/ ]
on_this_day: [ /.+/ ]
# from routes/feed/announcements.js
/{domain}/v1/feed/announcements:
get:
tags:
- Feed
summary: Get announcements for the Explore feed in the mobile apps.
description: |
Gets announcements for display in the official Wikipedia iOS and Android apps.
This is usually used to show announcements for surveys or fundraising.
produces:
- application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Announcements/0.3.0"
- application/problem+json
parameters:
- $ref: "#/parameters/domain"
responses:
200:
description: Announcements for the given Wiki
schema:
$ref: "#/definitions/announcements"
default:
description: Error
schema:
$ref: "#/definitions/problem"
x-amples:
- title: Retrieve announcements
response:
status: 200
headers:
content-type: application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Announcements/0.3.0"
cache-control: public, max-age=86400, s-maxage=900
vary: /.+/
etag: /^"[^/"]+/[^/"]+"$/
access-control-allow-origin: "*"
access-control-allow-headers: accept, x-requested-with, content-type
content-security-policy: default-src
x-content-security-policy: default-src
x-frame-options: SAMEORIGIN
# from routes/feed/on-this-day.js
/{domain}/v1/feed/onthisday/{type}/{month}/{day}:
get:
tags:
- Feed
summary: Get events on this day in history for the Explore feed.
description: |
Provides events that historically happened on the provided day and month.
Supported types of events are:
- Selected: a list of a few selected anniversaries which happen on the provided day and month; often the entries are curated for the current year
- Births: a list of birthdays which happened on the provided day and month
- Deaths: a list of deaths which happened on the provided day and month
- Holidays: a list of fixed holidays celebrated on the provided day and month
- Events: a list of significant events which happened on the provided day and month and which are not covered by the other types yet
- All: all of the above
produces:
- application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/OnThisDay/0.5.0"
- application/problem+json
parameters:
- $ref: "#/parameters/domain"
- name: type
in: path
description: Type of events
type: string
required: true
enum:
- selected
- births
- deaths
- holidays
- events
- all
- $ref: "#/parameters/month"
- $ref: "#/parameters/day"
responses:
200:
description: Annual events listed on this wiki for the requested month and day
schema:
$ref: "#/definitions/onthisdayResponse"
404:
description: No data found for the requested date
schema:
$ref: "#/definitions/problem"
501:
description: Unsupported language
schema:
$ref: "#/definitions/problem"
default:
description: Error
schema:
$ref: "#/definitions/problem"
x-amples:
- title: retrieve selected events on January 15
request:
params:
type: selected
month: 01
day: 15
response:
status: 200
headers:
content-type: application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/OnThisDay/0.5.0"
vary: /.+/
etag: /^"[^/"]+/[^/"]+"$/
access-control-allow-origin: "*"
access-control-allow-headers: accept, x-requested-with, content-type
content-security-policy: default-src
x-content-security-policy: default-src
x-frame-options: SAMEORIGIN
body:
selected:
- text: /.+/
year: /.+/
pages:
- title: /.+/
# from routes/feed/featured.js
/{domain}/v1/page/featured/{year}/{month}/{day}:
get:
tags:
- Feed
summary: Get featured article of the day for the Explore feed.
description: |
Page title of "Today's featured article" (only works on select wikis for now).
produces:
- application/json
- application/problem+json
parameters:
- $ref: "#/parameters/domain"
- $ref: "#/parameters/year"
- $ref: "#/parameters/month"
- $ref: "#/parameters/day"
responses:
200:
description: The title of a Wikipedia's Featured Article of the Day
schema:
$ref: "#/definitions/summary"
204:
description: Empty response (for feed content aggregation requests from RESTBase)
schema:
$ref: "#/definitions/empty"
404:
description: Not found
schema:
$ref: "#/definitions/problem"
500:
description: API Error
schema:
$ref: "#/definitions/problem"
501:
description: Unsupported language
schema:
$ref: "#/definitions/problem"
default:
description: Error
schema:
$ref: "#/definitions/problem"
x-amples:
- title: retrieve title of the featured article for April 29, 2016
request:
params:
year: 2016
month: "04"
day: 29
response:
status: 200
headers:
content-type: application/json; charset=utf-8
vary: /.+/
etag: /^"[^/"]+/[^/"]+"$/
access-control-allow-origin: "*"
access-control-allow-headers: accept, x-requested-with, content-type
content-security-policy: default-src
x-content-security-policy: default-src
x-frame-options: SAMEORIGIN
body:
title: /.+/
extract: /.+/
- title: retrieve featured article info for unsupported site (with aggregated=true)
request:
params:
domain: is.wikipedia.org
year: 2016
month: "04"
day: 29
query:
aggregated: true
response:
status: 204
body: ""
# from routes/feed/featured-image.js
/{domain}/v1/media/image/featured/{year}/{month}/{day}:
get:
tags:
- Feed
summary: Get the Picture of the Day from Wikimedia Commons for the Explore feed.
description: |
Featured image for a given date (aka Picture of the day).
Provides thumbnail and full res image URLs and a localized description based
on the domain used.
produces:
- application/json
- application/problem+json
parameters:
- $ref: "#/parameters/domain"
- $ref: "#/parameters/year"
- $ref: "#/parameters/month"
- $ref: "#/parameters/day"
responses:
200:
description: Info on the Commons Featured Image of the Day for the requested date
schema:
$ref: "#/definitions/image"
204:
description: Empty response (for feed content aggregation requests from RESTBase)
schema:
$ref: "#/definitions/empty"
404:
description: Not found (no featured image for the requested date)
schema:
$ref: "#/definitions/problem"
default:
description: Error
schema:
$ref: "#/definitions/problem"
x-amples:
- title: retrieve featured image data for April 29, 2016
request:
params:
year: 2016
month: "04"
day: 29
response:
status: 200
headers:
content-type: application/json; charset=utf-8
vary: /.+/
etag: /^"[^/"]+/[^/"]+"$/
access-control-allow-origin: "*"
access-control-allow-headers: accept, x-requested-with, content-type
content-security-policy: default-src
x-content-security-policy: default-src
x-frame-options: SAMEORIGIN
body:
title: /.+/
description:
html: /.+/
text: /.+/
lang: /.+/
image:
source: /.+/
width: /.+/
height: /.+/
credit:
html: /.+/
text: /.+/
license:
type: /.+/
code: /.+/
url: /.+/
artist:
html: /.+/
text: /.+/
file_page: /.+/
wb_entity_id: /.+/
structured:
captions: /.+/
thumbnail:
source: /.+/
width: /.+/
height: /.+/
# from routes/feed/most-read.js
/{domain}/v1/page/most-read/{year}/{month}/{day}:
get:
tags:
- Feed
summary: Get most viewed pages for a date.
description: |
Gets the most read articles for the date provided.
The date is in UTC, as other endpoints, too.
Only days prior to today's date are accepted.
produces:
- application/json
- application/problem+json
parameters:
- $ref: "#/parameters/domain"
- $ref: "#/parameters/year"
- $ref: "#/parameters/month"
- $ref: "#/parameters/day"
responses:
200:
description: Most read article titles for this wiki for the requested date
schema:
$ref: "#/definitions/mostread"
204:
description: Empty response (for feed content aggregation requests from RESTBase)
schema:
$ref: "#/definitions/empty"
404:
description: No data found for the requested date
schema:
$ref: "#/definitions/problem"
default:
description: Error
schema:
$ref: "#/definitions/problem"
x-amples:
- title: retrieve the most read articles for January 1, 2016
request:
params:
year: 2016
month: "01"
day: "01"
response:
status: 200
headers:
content-type: application/json
vary: /.+/
etag: /^"[^/"]+/[^/"]+"$/
access-control-allow-origin: "*"
access-control-allow-headers: accept, x-requested-with, content-type
content-security-policy: default-src
x-content-security-policy: default-src
x-frame-options: SAMEORIGIN
body:
date: 2016-01-01Z
articles:
- views: /.+/
rank: /.+/
title: /.+/
extract: /.+/
- title: retrieve the most-read articles for January 1, 2016 (with aggregated=true)
request:
params:
year: 2016
month: "01"
day: "01"
query:
aggregated: true
response:
status: 200
headers:
content-type: application/json; charset=utf-8
vary: /.+/
etag: /^"[^/"]+/[^/"]+"$/
access-control-allow-origin: "*"
access-control-allow-headers: accept, x-requested-with, content-type
content-security-policy: default-src
x-content-security-policy: default-src
x-frame-options: SAMEORIGIN
body:
date: 2015-12-31Z
articles:
- views: /.+/
rank: /.+/
title: /.+/
extract: /.+/
- title: retrieve most-read articles for date with no data (with aggregated=true)
request:
params:
year: 2015
month: "01"
day: "01"
query:
aggregated: true
response:
status: 204
body: ""
# from routes/feed/news.js
/{domain}/v1/page/news:
get:
tags:
- Feed
summary: Get current news headlines.
description: |
Gets content related to the current "In the News" template
(for some wikis for now).
produces:
- application/json
- application/problem+json
parameters:
- $ref: "#/parameters/domain"
responses:
200:
description: News content from the a Wikipedia main page
schema:
$ref: "#/definitions/news"
204:
description: Empty response (for feed content aggregation requests from RESTBase)
schema:
$ref: "#/definitions/empty"
501:
description: Unsupported language
schema:
$ref: "#/definitions/problem"
default:
description: Error
schema:
$ref: "#/definitions/problem"
x-amples:
- title: get 'In the News' content
response:
status: 200
headers:
content-type: application/json; charset=utf-8
vary: /.+/
etag: /^"[^/"]+/[^/"]+"$/
access-control-allow-origin: "*"
access-control-allow-headers: accept, x-requested-with, content-type
content-security-policy: default-src
x-content-security-policy: default-src
x-frame-options: SAMEORIGIN
body:
- story: /.+/
links:
- title: /.+/
extract: /.+/
- title: get "In the News" content for unsupported language (with aggregated=true)
request:
params:
domain: is.wikipedia.org
query:
aggregated: true
response:
status: 204
body: ""
# from routes/page/random.js
/{domain}/v1/page/random/title:
get:
tags:
- Feed
summary: Get a random article title.
description: |
Gets the title of a randomly picked article from main namespace.
Preference is given to articles with a thumbnail and an associated Wikidata description.
produces:
- application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Random/0.7.0"
- application/problem+json
parameters:
- $ref: "#/parameters/domain"
responses:
200:
description: A random (good) article title
schema:
$ref: "#/definitions/random"
400:
description: Bad request
schema:
$ref: "#/definitions/problem"
default:
$ref: "#/definitions/problem"
x-amples:
- title: retrieve a random article title
response:
status: 200
headers:
content-type: application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Random/0.7.0"
vary: /.+/
access-control-allow-origin: "*"
access-control-allow-headers: accept, x-requested-with, content-type
content-security-policy: default-src
x-content-security-policy: default-src
x-frame-options: SAMEORIGIN
body:
items:
- title: /.+/
definitions:
# A https://tools.ietf.org/html/draft-nottingham-http-problem
problem:
required:
- type
properties:
status:
type: integer
type:
type: string
title:
type: string
detail:
type: string
method:
type: string
uri:
type: string
empty:
type: object
properties:
type:
type: string
description: description of original content type (buffer)
data:
type: array
description: Buffer contents
items:
type: string
additionalProperties: false
dated_pageview:
type: object
properties:
date:
type: string
description: ISO 8601 timestamp of pageviews recorded
views:
type: integer
description: Number of views on date
required:
- date
- views
additionalProperties: false
mostread_article:
allOf:
- $ref: "#/definitions/summary"
- type: object
properties:
views:
type: integer
description: Number of views on the requested day
view_history:
type: array
items:
$ref: "#/definitions/dated_pageview"
rank:
type: integer
description: Position in the list of most viewed articles
required:
- views
- rank
mostread:
type: object
properties:
date:
type: string
description: The date which the data correspond to
articles:
type: array
description: Array of most popular articles
items:
$ref: "#/definitions/mostread_article"
required:
- date
- articles
onthisdayList:
type: array
items:
type: object
properties:
text:
type: string
description: Short description of the event
year:
type: integer
description: The year this event occurred
pages:
type: array
description: List of pages related to the event
items:
$ref: "#/definitions/summary"
required:
- text
- pages
onthisdayResponse:
type: object
description: Lists of events which happened on the provided day and month
properties:
births:
$ref: "#/definitions/onthisdayList"
deaths:
$ref: "#/definitions/onthisdayList"
events:
$ref: "#/definitions/onthisdayList"
holidays:
$ref: "#/definitions/onthisdayList"
selected:
$ref: "#/definitions/onthisdayList"
additionalProperties: false
news_item:
type: object
properties:
story:
type: string
description: A cover story for the news item
links:
type: array
description: |
A collection of pages mentioned in the headline. The first page is the headline topic.
items:
$ref: "#/definitions/summary"
required:
- story
- links
news:
type: array
items:
$ref: "#/definitions/news_item"
image:
type: object
properties:
title:
type: string
description: Image title
thumbnail:
$ref: "#/definitions/image_props"
image:
$ref: "#/definitions/image_props"
description:
$ref: "#/definitions/extmetadata_property"
file_page:
type: string
description: Full URL to the file page for the item on Wikimedia Commons
artist:
type: object
description: structured info about the author of the media item
properties:
html:
type: string
description: HTML string describing the artist
name:
type: string
description: the plain text artist name, if available
user_page:
type: string
description: Wikimedia Commons user page for the artist, if available
required:
- html
credit:
$ref: "#/definitions/extmetadata_property"
license:
type: object
description: license under which the media item is available on Wikimedia Commons
properties:
type:
type: string
description: license type
url:
type: string
description: URL describing the terms and conditions of the license, if any
required:
- type
wb_entity_id:
type: string
description: Commons Wikibase ID, if the file is on Wikimedia Commons
structured:
type: object
description: structured image metadata from Structured Data on Commons (SDC)
properties:
captions:
type: object
description: caption (label) values by language
required: [ captions ]
required:
- title
- thumbnail
- image
- license
- structured
announcements:
type: object
properties:
announce:
type: array
description: list of active announcements for this wiki
items:
$ref: "#/definitions/announcement"
required:
- announce
availability:
type: object
properties:
todays_featured_article:
type: array
description: domains for wikis with this feature enabled, or [ '*.<project>.org' ] for all wikis in a project
items:
type: string
most_read:
type: array
description: domains for wikis with this feature enabled or [ '*.<project>.org' ] for all wikis in a project
items:
type: string
picture_of_the_day:
type: array
description: domains for wikis with this feature enabled or [ '*.<project>.org' ] for all wikis in a project
items:
type: string
in_the_news:
type: array
description: domains for wikis with this feature enabled or [ '*.<project>.org' ] for all wikis in a project
items:
type: string
on_this_day:
type: array
description: domains for wikis with this feature enabled or [ '*.<project>.org' ] for all wikis in a project
items:
type: string
required: [ todays_featured_article, most_read, picture_of_the_day, in_the_news, on_this_day ]
additionalProperties: false
announcement:
type: object
properties:
id:
type: string
description: Unique ID of the announcement
type:
type: string
description: The announcement type
enum:
- survey
- fundraising
- announcement
start_time:
type: string
description: The ISO 8601 date to begin showing the announcement.
end_time:
type: string
description: The ISO 8601 date to stop showing the announcement.
platforms:
type: array
description: |
An array of platforms on which to display the announcement.
items:
type: string
enum:
- iOSApp
- iOSAppV2
- iOSAppV3
- iOSAppV4
- iOSAppV5
- AndroidApp
- AndroidAppV2
text:
type: string
description: The text of the announcement
image:
type: string
description: \[DEPRECATED\] The URL of the image for the announcement (Android only)
image_url:
type: string
description: The URL of the image for the announcement
action:
$ref: "#/definitions/action"
caption_HTML:
type: string
description: HTML to display below the announcement. Usually a privacy statment and link to a policy
countries:
type: array
description: |
An array of country codes in which to display the announcement. Clients should derive
the country from 'GeoIP' portion of the Set-Cookie header.
items:
type: string
min_version:
type: string
description: minimum app version code for which to show the announcement
max_version:
type: string
description: maximum app version code for which to show the announcement
beta:
type: boolean
description: |
(AndroidAppV2 only) Optional boolean flag controlling the release builds for which the announcement should be shown.
Set to true if the announcement should be shown only in pre-production builds (beta, alpha, dev).
Set to false if the announcement should be shown only in release builds.
If not defined, the announcement will be shown for all builds.
logged_in:
type: boolean
description: |
(AndroidAppV2 only) Optional boolean flag controlling whether announcements should be shown based on the user login state.
Set to true if the announcement should be shown only if the user is logged in.
Set to false if the announcement should be shown only if the user is NOT logged in.
If not defined, the announcement will be shown regardless of the user's login state.
reading_list_sync_enabled:
type: boolean
description: |
(AndroidAppV2 only) Optional boolean flag controlling whether announcements should be shown based on whether the user
has enabled reading list syncing.
Set to true if the announcement should be shown only if the user has enabled reading list syncing.
Set to false if the announcement should be shown only if the user has NOT enabled reading list syncing.
If not defined, the announcement will be shown regardless of whether the user has enabled reading list syncing.
negative_text:
type: string
description: |
(AndroidAppV2 only) text to show on a "negative" button on the announcement. If absent, the button is not shown
image_height:
type: integer
description: |
(AndroidAppV2 only) height, in device-independent pixels, of the image portion of the announcement card
articleTitles:
type: array
description: |
(iOSAppV3+ only, survey type only) Array of article titles that will display the survey announcement.
items:
type: string
displayDelay:
type: integer
description: |
(iOSAppV3+ only, survey type only) Number in seconds to wait for survey announcement to appear after content load.
percent_receiving_experiment:
type: integer
description: |
(iOSAppV4+ only, survey type only) Integer between 0 and 100 representing the percentage of users that will fall into the iOS Article as a Living Document experiment. This percentage will see the feature, the others will not. Both groups will see the survey announcement.
required:
- id
- type
- start_time
- end_time