-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
2348 lines (2345 loc) · 88.2 KB
/
openapi.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.3
info:
title: Global.health curator service API
description: Server for CRUD operations on Global.health data
termsOfService: 'https://global.health/terms-of-use/'
contact:
name: Global.health
url: https://global.health
email: info@global.health
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'
version: 1.0.0
tags:
- name: Case
description: Case related operations
- name: Suggest
description: Suggestion for input of cases
- name: Geocode
description: Geolocation of a case
- name: User
description: User of the system
- name: Source
description: A source of case data
- name: Upload
description: >
A bundle of case data that were uploaded as part of a batch upload
or an automated ingestion pipeline
- name: Auth
description: Authentication-related operations
paths:
/auth/register:
post:
tags:
- Auth
- User
summary: >
Creates a local user for testing.The user can have any specified roles
in the request and the returned cookies can be used for subsequent
requests acting as this new user.
Note that this endpoint is only exposed in a local environment.
servers:
- url: http://localhost:3001/api
operationId: registerAuth
requestBody:
description: User to register
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'200':
$ref: '#/components/responses/200Auth'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
/sources:
get:
tags: [Source]
summary: Lists sources
operationId: listSources
parameters:
- name: page
in: query
description: The pages of sources to skip before starting to collect the result set
required: false
schema:
type: integer
format: int32
minimum: 1
default: 1
- name: limit
in: query
description: The number of sources to return
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 10
- name: url
in: query
description: Origin URL substring on which to filter the result set
required: false
allowEmptyValue: true
allowReserved: true
schema:
type: string
- name: access_token
description: Bearer token used by automated ingestion lambdas.
in: query
required: false
schema:
type: string
responses:
'200':
$ref: '#/components/responses/200SourceArray'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
post:
tags: [Source]
summary: Creates a new source
operationId: createSource
requestBody:
description: Source to add
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NewSource'
responses:
'201':
$ref: '#/components/responses/201Source'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
/acknowledgment-sources:
get:
tags: [Source]
summary: Lists sources for acknowledgments table
operationId: listSourcesForTable
responses:
'200':
$ref: '#/components/responses/200AcknowledgmentSource'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
/sources/{id}:
parameters:
- name: id
in: path
description: The source ID
required: true
schema:
type: string
pattern: '^[a-f\d]{24}$'
get:
tags: [Source]
summary: Gets a specific source
operationId: getSource
responses:
'200':
$ref: '#/components/responses/200Source'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
put:
tags: [Source]
summary: Updates a specific source
operationId: updateSource
requestBody:
description: Source to update
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Source'
responses:
'200':
$ref: '#/components/responses/200Source'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
delete:
tags: [Source]
summary: Deletes a specific source
operationId: deleteSource
responses:
'204':
description: Source deleted
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/sources/{id}/retrieve:
parameters:
- name: id
in: path
description: The source ID for which to retrieve content
required: true
schema:
type: string
pattern: '^[a-f\d]{24}$'
- name: parse_start_date
in: query
description: >
The date on which to begin parsing/ingesting data (inclusive).
Provided in YYYY-MM-DD format.
required: false
schema:
type: string
pattern: '^[\d]{4}-[\d]{2}-[\d]{2}$'
- name: parse_end_date
in: query
description: >
The date on which to end parsing/ingesting data (inclusive).
Provided in YYYY-MM-DD format.
required: false
schema:
type: string
pattern: '^[\d]{4}-[\d]{2}-[\d]{2}$'
post:
tags: [Source]
summary: Trigger a retrieval of the content for the specified source
operationId: retrieve
responses:
'200':
$ref: '#/components/responses/200Retrieval'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/sources/uploads:
get:
tags: [Source, Upload]
summary: Lists all uploads for all sources
operationId: listUploads
parameters:
- name: page
in: query
description: The pages of uploads to skip before starting to collect the result set
required: false
schema:
type: integer
format: int32
minimum: 1
default: 1
- name: limit
in: query
description: The number of uploads to return
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 10
- name: changes_only
in: query
description: >
Filters successful uploads to only include those that created or modified
cases. The response will still include non-successful uploads.
required: false
schema:
type: boolean
default: false
responses:
'200':
$ref: '#/components/responses/200UploadsArray'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'500':
$ref: '#/components/responses/500'
/sources/{sourceId}/uploads:
parameters:
- name: sourceId
in: path
description: The parent source ID in which to create the upload
required: true
schema:
type: string
pattern: '^[a-f\d]{24}$'
post:
tags: [Source, Upload]
summary: Creates a new upload in the specified source
operationId: createUpload
requestBody:
description: Upload to add
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Upload'
responses:
'201':
$ref: '#/components/responses/201Upload'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
/sources/{sourceId}/uploads/{id}:
parameters:
- name: sourceId
in: path
description: The parent source ID in which to find the upload
required: true
schema:
type: string
pattern: '^[a-f\d]{24}$'
- name: id
in: path
description: The ID of the upload to update
required: true
schema:
type: string
pattern: '^[a-f\d]{24}$'
put:
tags: [Source, Upload]
summary: Updates an existing upload in the specified source
operationId: updateUpload
requestBody:
description: New upload content
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Upload'
responses:
'200':
$ref: '#/components/responses/200Upload'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
/sources/parsers:
get:
summary: Lists parsers available for automated ingestion
tags: [Suggest]
operationId: listParsers
responses:
'200':
$ref: '#/components/responses/200ParsersArray'
'500':
$ref: '#/components/responses/500'
/cases:
get:
tags: [Case]
summary: Lists cases
operationId: listCases
parameters:
- name: page
in: query
description: The pages of sources to skip before starting to collect the result set
required: false
schema:
type: integer
format: int32
minimum: 1
default: 1
- name: limit
in: query
description: The number of cases to return
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 10
- name: count_limit
in: query
description: The maximum number of documents that will be counted in mongoDB to make queries faster
required: false
schema:
type: integer
format: int32
minimum: 100
default: 10000
maximum: 50000
- name: sort_by
in: query
description: Keyword to sort by
required: false
schema:
type: string
- name: order
in: query
description: Sorting order
required: false
schema:
type: string
- name: q
in: query
description: The search query
required: false
allowEmptyValue: true
allowReserved: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/200CaseArray'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
post:
tags: [Case]
summary: Creates one (or multiple identical) new cases
operationId: createCase
requestBody:
description: Case to add
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NewCase'
parameters:
- name: validate_only
in: query
description: Whether to validate the case without creating it
required: false
schema:
type: boolean
default: false
allowEmptyValue: true
- name: num_cases
in: query
description: The number of cases to create
required: false
schema:
type: integer
format: int32
minimum: 1
default: 1
responses:
'201':
$ref: '#/components/responses/201Create'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
put:
tags: [Case]
summary: Upserts a case
description: >
Creates or updates a case, depending on whether the provided values for
the `caseReference.sourceId` and `caseReference.sourceEntryId` fields
correspond to an existing case record.
operationId: upsertCase
requestBody:
description: Case to upsert
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/NewCase'
required:
- caseReference
responses:
'200':
$ref: '#/components/responses/200Case'
'201':
$ref: '#/components/responses/201Case'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
delete:
summary: >
Deletes multiple cases. It is required to supply exactly one of either
caseIds or query in the request body. If caseIds are supplied, cases
corresponding to those caseIds will be deleted. If query is supplied,
all cases that match the query will be deleted.
tags: [Case]
operationId: deleteCases
requestBody:
description: Cases to delete
required: true
content:
application/json:
schema:
type: object
properties:
caseIds:
description: Cases corresponding to these ids will be deleted
type: array
items:
type: integer
format: int32
minimum: 1
query:
description: >
Cases matching this query will be deleted. Must contain
non-whitespace characters.
type: string
pattern: \S+
oneOf:
- required: [caseIds]
- required: [query]
responses:
'204':
description: Cases deleted
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
/cases/download:
post:
summary: >
Streams a CSV, TSV or JSON attachment of cases matching the search query.
If caseIds are supplied the CSV only contains cases with those ids.
You cannot supply both query and caseIds.
tags: [Case]
operationId: downloadCases
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
caseIds:
description: Cases corresponding to these ids will be returned
type: array
items:
type: string
query:
description: >
Cases matching this query will be returned. This is ignored
if empty.
type: string
limit:
description: >
Max number of rows that can be downloaded when query is provided
type: string
format:
description: Format of data to be downloaded
type: string
responses:
'200':
$ref: '#/components/responses/200CasesDownload'
'500':
$ref: '#/components/responses/500'
/cases/downloadAsync:
post:
summary: >
Streams an attachment of cases matching the search query.
tags: [Case]
operationId: downloadAsync
requestBody:
content:
application/json:
schema:
type: object
properties:
query:
description: >
Cases matching this query will be returned.
type: string
responses:
'200':
$ref: '#/components/responses/200FilteredDataSetDownload'
'204':
$ref: '#/components/responses/204'
'500':
$ref: '#/components/responses/500'
/cases/getDownloadLink:
post:
summary: >
Generates signed URL to download full data set from AWS S3
tags: [Case]
operationId: generateSignedUrl
requestBody:
content:
application/json:
schema:
properties:
format:
description: Format in which data should be downloaded
type: string
responses:
'200':
$ref: '#/components/responses/200FullDataSetDownload'
'500':
$ref: '#/components/responses/500'
/cases/countryData:
get:
summary: Data for cases by country table
operationId: listCountryData
tags: [ Suggest ]
responses:
'200':
$ref: '#/components/responses/200CasesByCountryObject'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'500':
$ref: '#/components/responses/500'
/cases/symptoms:
get:
summary: Lists most frequently used sypmtoms
tags: [Suggest]
operationId: listSymptoms
parameters:
- name: limit
in: query
description: The number of items to return
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 5
responses:
'200':
$ref: '#/components/responses/200SymptomArray'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'500':
$ref: '#/components/responses/500'
/cases/placesOfTransmission:
get:
summary: Lists most frequently used places of transmission
tags: [Suggest]
operationId: listPlacesOfTransmission
parameters:
- name: limit
in: query
description: The number of items to return
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 5
responses:
'200':
$ref: '#/components/responses/200PlacesOfTransmissionArray'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'500':
$ref: '#/components/responses/500'
/cases/occupations:
get:
summary: Lists most frequently used occupations
tags: [Suggest]
operationId: listOccupations
parameters:
- name: limit
in: query
description: The number of items to return
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 5
responses:
'200':
$ref: '#/components/responses/200OccupationArray'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'500':
$ref: '#/components/responses/500'
/cases/locationComments:
get:
summary: Lists most frequently used location comments
tags: [ Suggest ]
operationId: listLocationComments
parameters:
- name: limit
in: query
description: The number of items to return
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 5
responses:
'200':
$ref: '#/components/responses/200LocationCommentArray'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'500':
$ref: '#/components/responses/500'
/cases/batchStatusChange:
post:
summary: Changes status for a list of cases
tags: [Case]
operationId: batchStatusChange
requestBody:
description: >
Case IDs are passed through an array of strings, note may be provided as well.
A query may be provided instead of list of IDs, this will change status for all
cases matching the query.
required: true
content:
application/json:
schema:
properties:
caseIds:
description: >
Cases having IDs provided here will have their
status changed to one specified in status field.
type: array
items:
type: string
status:
$ref: '#/components/schemas/CaseStatus'
query:
description: >
Cases matching this query will have their status
changed. Must contain non-whitespace characters.
type: string
pattern: \S+
note:
description: >
The reason behind exclusion (or other important info).
This field is ignored if a status is not "Excluded".
type: string
oneOf:
- required: [caseIds]
- required: [query]
required:
- status
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
/cases/batchUpsert:
post:
tags: [Case]
summary: Upserts multiple cases
operationId: batchUpsertCase
requestBody:
description: Cases to upsert
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CaseArray'
responses:
'200':
$ref: '#/components/responses/200BatchCaseUpsert'
'207':
$ref: '#/components/responses/207BatchCaseUpsert'
'500':
$ref: '#/components/responses/500'
/cases/batchUpdate:
post:
summary: Batch updates cases
tags: [Case]
operationId: batchUpdateCases
requestBody:
description: Cases to update
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CaseArray'
responses:
'200':
$ref: '#/components/responses/200BatchCaseUpdateResponse'
'400':
$ref: '#/components/responses/400'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
/cases/batchUpdateQuery:
post:
summary: Batch updates cases that match the query property
tags: [Case]
operationId: batchUpdateQueryCases
requestBody:
description: Cases to update
required: true
content:
application/json:
schema:
properties:
query:
description: >
Cases matching this query will be updated. Must contain
non-whitespace characters.
type: string
pattern: \S+
case:
$ref: '#/components/schemas/Case'
required:
- query
- case
responses:
'200':
$ref: '#/components/responses/200BatchCaseUpdateResponse'
'400':
$ref: '#/components/responses/400'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
/cases/{id}:
parameters:
- name: id
in: path
description: The case ID
required: true
schema:
type: integer
format: int32
minimum: 1
get:
tags: [Case]
summary: Gets a specific case
operationId: getCase
responses:
'200':
$ref: '#/components/responses/200Case'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
put:
tags: [Case]
summary: Updates a specific case
operationId: updateCase
requestBody:
description: Case to update
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Case'
responses:
'200':
$ref: '#/components/responses/200Case'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
delete:
tags: [Case]
summary: Deletes a specific case
operationId: deleteCase
responses:
'204':
description: Case deleted
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'500':
$ref: '#/components/responses/500'
/cases/verify/{id}:
post:
tags: [ Case ]
# summary: Creates one (or multiple identical) new cases
# operationId: verifyCase
# requestBody:
# description: Case with verifier
# required: true
# content:
# application/json:
# schema:
# $ref: '#/components/schemas/Verifier'
responses:
'200':
$ref: '#/components/responses/200Case'
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422'
'500':
$ref: '#/components/responses/500'
/geocode/seed:
post:
tags: [Geocode]
summary: Adds geocodes to the geocoding database
operationId: seedGeocodes
requestBody:
description: A single geocode record
required: true
content:
application/json:
schema:
type: object
responses:
'200':
$ref: '#/components/responses/200'
/geocode/clear:
post:
tags: [Geocode]
summary: Clears geocodes from the geocoding database
operationId: clearGeocodes
responses:
'200':
$ref: '#/components/responses/200'
/geocode/suggest:
get:
tags: [Suggest, Geocode]
summary: Suggests geocodes for a given query string
operationId: suggestGeocodes
parameters:
- name: q
in: query
description: The location string for which to find geocodes
required: true
allowReserved: true
schema:
type: string
- name: limitToResolution
in: query
allowReserved: true
schema:
type: string