-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathbc_gov_news.yaml
1340 lines (1340 loc) · 33.7 KB
/
bc_gov_news.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
openapi: 3.0.0
servers:
- url: https://news.api.gov.bc.ca/
info:
version: '1.0'
title: BC Gov News API Service 1.0
description: |
This is a news API devoted to the news of British Columbia, Canada. It's used to retrieve news post from the https://news.gov.bc.ca/ website and social media posts. Also, the API hosts info about British Columbia ministries and services.
The `api-version` parameter is required in every endpoint. Always pass the string '1.0' in it.
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
paths:
/api/FacebookPosts/ByUri:
get:
tags:
- FacebookPosts
summary: Get a Facebook post based on a Uri
description: Get a Facebook post based on a Uri
operationId: FacebookPosts_GetByUri
parameters:
- name: uri
in: query
required: false
schema:
type: string
default: ''
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/FacebookPost'
application/json:
schema:
$ref: '#/components/schemas/FacebookPost'
text/json:
schema:
$ref: '#/components/schemas/FacebookPost'
/api/Home:
get:
tags:
- Home
summary: Returns the top level content for the home page
description: Get the top level content for the home page
operationId: Home_Get
parameters:
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Home'
application/json:
schema:
$ref: '#/components/schemas/Home'
text/json:
schema:
$ref: '#/components/schemas/Home'
/api/Ministries:
get:
tags:
- Ministries
summary: Get all ministries
operationId: Ministries_GetAll
parameters:
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Ministry'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Ministry'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Ministry'
/api/Ministries/{key}:
get:
tags:
- Ministries
summary: Get the Ministry associated with the ministry key
description: Get the Ministry by ministry key
operationId: Ministries_GetOne
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Ministry'
application/json:
schema:
$ref: '#/components/schemas/Ministry'
text/json:
schema:
$ref: '#/components/schemas/Ministry'
/api/Ministries/{key}/Minister:
get:
tags:
- Ministries
summary: Get the Minister associated with the ministry key
description: Get the Minister by the ministry key
operationId: Ministries_GetMinister
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Minister'
application/json:
schema:
$ref: '#/components/schemas/Minister'
text/json:
schema:
$ref: '#/components/schemas/Minister'
/api/Newsletters:
get:
tags:
- Newsletters
summary: Get all newsletters
operationId: Newsletters_GetAll
parameters:
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Newsletter'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Newsletter'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Newsletter'
/api/Newsletters/{newsletterKey}:
get:
tags:
- Newsletters
summary: Get a specific newsletter
description: Get a specific newsletter by newsletterKey
operationId: Newsletters_GetOne
parameters:
- name: newsletterKey
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Newsletter'
application/json:
schema:
$ref: '#/components/schemas/Newsletter'
text/json:
schema:
$ref: '#/components/schemas/Newsletter'
/api/Newsletters/{newsletterKey}/Editions/{editionKey}:
get:
tags:
- Newsletters
summary: Returns a specific edition of a newsletter
description: Get a specific edition of a newsletter by newsletterKey and editionKey
operationId: Newsletters_GetEdition
parameters:
- name: newsletterKey
in: path
required: true
schema:
type: string
- name: editionKey
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Edition'
application/json:
schema:
$ref: '#/components/schemas/Edition'
text/json:
schema:
$ref: '#/components/schemas/Edition'
/api/Newsletters/{newsletterKey}/Editions/{editionKey}/Articles/{articleKey}:
get:
tags:
- Newsletters
summary: Get an article belonging to a Newsletter edition
description: Get an article belonging to a Newsletter edition
operationId: Newsletters_GetArticle
parameters:
- name: newsletterKey
in: path
required: true
schema:
type: string
- name: editionKey
in: path
required: true
schema:
type: string
- name: articleKey
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Article'
application/json:
schema:
$ref: '#/components/schemas/Article'
text/json:
schema:
$ref: '#/components/schemas/Article'
/api/Posts/{key}:
get:
tags:
- Posts
summary: Get the post associated with the key
description: Get the post associated with the key
operationId: Posts_GetOne
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Post'
application/json:
schema:
$ref: '#/components/schemas/Post'
text/json:
schema:
$ref: '#/components/schemas/Post'
/api/Posts:
get:
tags:
- Posts
summary: Get the posts associated with the keys in the list passed in.
description: Get multiple posts by their keys.
operationId: Posts_Get
parameters:
- name: postKeys
in: query
description: One or more post keys
required: false
explode: true
schema:
type: array
items:
type: string
default: ''
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
/api/Posts/Latest/{indexKind}/{indexKey}:
get:
tags:
- Posts
summary: Get the latest posts of postKind for the specified index (default or category)
description: Get the latest posts of postKind for the specified index (default or category)
operationId: Posts_GetLatest
parameters:
- name: indexKind
in: path
description: home or one of categories
required: true
schema:
type: string
- name: indexKey
in: path
description: default or one key of categories (ministries, sectors, services, tags, themes)
required: true
schema:
type: string
- name: postKind
in: query
description: 'One of: releases, stories, factsheets, updates or default (releases+stories except top/feature)'
required: false
schema:
type: string
default: ''
- name: count
in: query
description: number of posts to return
required: false
schema:
type: integer
format: int32
default: ''
- name: skip
in: query
description: number of posts to skip
required: false
schema:
type: integer
format: int32
default: ''
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
/api/Posts/Keys/{indexKind}/{indexKey}:
get:
tags:
- Posts
summary: Get all keys for the specified index (newsroom or category)
description: Get all keys for the specified index (newsroom or category)
operationId: Posts_GetAllKeys
parameters:
- name: indexKind
in: path
description: home or one of categories
required: true
schema:
type: string
- name: indexKey
in: path
description: default or one key of the categories (ministries, sectors, services, tags, themes)
required: true
schema:
type: string
- name: postKind
in: query
description: 'One of: releases, stories, factsheets, updates or default (releases+stories+factsheets)'
required: false
schema:
type: string
default: ''
- name: count
in: query
description: number of posts to return
required: false
schema:
type: integer
format: int32
default: ''
- name: skip
in: query
description: number of posts to skip
required: false
schema:
type: integer
format: int32
default: ''
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/KeyValuePair_2'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/KeyValuePair_2'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/KeyValuePair_2'
/api/Posts/Keys/{reference}:
get:
tags:
- Posts
summary: Get the post key associated with the reference.
description: Get the post key associated with the reference.
operationId: Posts_GetKeyFromReference
parameters:
- name: reference
in: path
description: ''
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/KeyValuePair_2'
application/json:
schema:
$ref: '#/components/schemas/KeyValuePair_2'
text/json:
schema:
$ref: '#/components/schemas/KeyValuePair_2'
/api/ResourceLinks:
get:
tags:
- ResourceLinks
summary: Get all resource links
operationId: ResourceLinks_GetAll
parameters:
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/ResourceLink'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResourceLink'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResourceLink'
/api/Sectors:
get:
tags:
- Sectors
summary: Get all Sectors
operationId: Sectors_GetAll
parameters:
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Sector'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Sector'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Sector'
/api/Sectors/{key}:
get:
tags:
- Sectors
summary: Get the sector associated with the key
description: Get one sector by key
operationId: Sectors_GetOne
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Sector'
application/json:
schema:
$ref: '#/components/schemas/Sector'
text/json:
schema:
$ref: '#/components/schemas/Sector'
/api/Services:
get:
tags:
- Services
summary: Get all Services
operationId: Services_GetAll
parameters:
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Service'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Service'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Service'
/api/Services/{key}:
get:
tags:
- Services
summary: Get the service associated with the passed key
description: Get a service by key
operationId: Services_GetOne
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Service'
application/json:
schema:
$ref: '#/components/schemas/Service'
text/json:
schema:
$ref: '#/components/schemas/Service'
/api/Slides/{id}:
get:
tags:
- Slides
summary: Get the slide associated to the id
description: Get a slide by id
operationId: Slides_GetOne
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Slide'
application/json:
schema:
$ref: '#/components/schemas/Slide'
text/json:
schema:
$ref: '#/components/schemas/Slide'
/api/Slides:
get:
tags:
- Slides
summary: Get all Slides
operationId: Slides_GetAll
parameters:
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Slide'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Slide'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Slide'
/api/Tags:
get:
tags:
- Tags
summary: Get all Tags
operationId: Tags_GetAll
parameters:
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Tag'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Tag'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Tag'
/api/Tags/{key}:
get:
tags:
- Tags
summary: Get the Tag associated with the key
description: Get a Tag by key
operationId: Tags_GetOne
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Tag'
application/json:
schema:
$ref: '#/components/schemas/Tag'
text/json:
schema:
$ref: '#/components/schemas/Tag'
/api/Themes:
get:
tags:
- Themes
summary: Get all Themes
operationId: Themes_GetAll
parameters:
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/Theme'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Theme'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Theme'
/api/Themes/{key}:
get:
tags:
- Themes
summary: Get the Theme associated with the key
description: Get a Theme by key
operationId: Themes_GetOne
parameters:
- name: key
in: path
required: true
schema:
type: string
- name: api-version
in: query
required: true
schema:
type: string
default: '1.0'
responses:
'200':
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/Theme'
application/json:
schema:
$ref: '#/components/schemas/Theme'
text/json:
schema:
$ref: '#/components/schemas/Theme'
components:
schemas:
FacebookPost:
type: object
allOf:
- $ref: '#/components/schemas/DataModel'
properties:
poster:
type: string
posterLogo:
type: string
posterSubtitle:
type: string
posterLikes:
format: int32
type: integer
content:
type: string
postLikes:
format: int32
type: integer
postComments:
format: int32
type: integer
postShares:
format: int32
type: integer
facebookObjectId:
format: int32
type: integer
type:
type: string
pictureUri:
type: string
DataModel:
type: object
properties:
key:
type: string
timestamp:
format: date-time
type: string
Home:
type: object
allOf:
- $ref: '#/components/schemas/DataIndex'
properties:
liveWebcastFlashMediaManifestUrl:
type: string
liveWebcastM3uPlaylist:
type: string
name:
type: string
topPostKey:
type: string
featurePostKey:
type: string
DataIndex:
type: object
allOf:
- $ref: '#/components/schemas/DataModel'
properties:
kind:
type: string
name:
type: string
topPostKey:
type: string
featurePostKey:
type: string
Ministry:
type: object
allOf:
- $ref: '#/components/schemas/Category'
properties:
childMinistryKey:
type: string
parentMinistryKey:
type: string
ministryUrl:
type: string
displayAdditionalName:
type: string
topicLinks:
type: array
items:
$ref: '#/components/schemas/ResourceLink'
serviceLinks:
type: array
items:
$ref: '#/components/schemas/ResourceLink'
newsletterLinks: