-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathteleport.yaml
1645 lines (1634 loc) · 50.7 KB
/
teleport.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
info:
title: Teleport
version: 1.0.0-oas3
description: "Provides information on cities (by name, using auto-complete or by geographic coordinates) countries and their administrative divisions timezones urban areas (a.k.a. Teleport Cities).Also included income, living costs & quality of life data in 264+ most creative cities in the world"
paths:
/cities/:
get:
operationId: searchCities
parameters:
- description: search term
in: query
name: search
required: true
schema:
type: string
- description: limit (max 25)
in: query
name: limit
required: false
schema:
type: integer
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/CitySearchResults'
description: Find cities by name
tags:
- cities
/cities/{city_id}/:
get:
operationId: getCityByID
parameters:
- description: The city ID
in: path
name: city_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/City'
'400':
description: Invalid city ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: City ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get city information
tags:
- cities
/continents/:
get:
operationId: listContinents
parameters: []
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/ContinentList'
description: List all continents
tags:
- continents
/continents/{continent_id}/:
get:
operationId: getContinentByID
parameters:
- description: The continent ID
in: path
name: continent_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/Continent'
'400':
description: Invalid continent ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Continent ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get continent information
tags:
- continents
/continents/{continent_id}/countries/:
get:
operationId: listContinentCountries
parameters:
- description: The continent ID
in: path
name: continent_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/ContinentCountryList'
'400':
description: Invalid continent ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Continent ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get continent country list
tags:
- continents
- countries
/continents/{continent_id}/urban_areas/:
get:
operationId: listContinentUrbanAreas
parameters:
- description: The continent ID
in: path
name: continent_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/ContinentUrbanAreaList'
'400':
description: Invalid continent ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Continent ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get continent urban area list
tags:
- continents
- urban_areas
/countries/:
get:
operationId: listCountries
parameters: []
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/CountryList'
description: List all countries
tags:
- countries
/countries/{country_id}/:
get:
operationId: getCountryByID
parameters:
- description: >-
The country ID, consisting of ID scheme and ID, separated by colon
(e.g. iso_alpha2:US)
in: path
name: country_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/Country'
'400':
description: Invalid country ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Country ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get country information
tags:
- countries
/countries/{country_id}/admin1_divisions/:
get:
operationId: listAdmin1Divisions
parameters:
- description: The country ID
in: path
name: country_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/CountryList'
'400':
description: Invalid country ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Country ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: List all first-level administrative divisions for a country
tags:
- countries
/countries/{country_id}/admin1_divisions/{admin1_id}/:
get:
operationId: getAdmin1DivisionByID
parameters:
- description: The country ID
in: path
name: country_id
required: true
schema:
type: string
- description: >-
The administrative division ID, consisting of ID scheme and ID,
separated by colon (e.g. geonames:CA)
in: path
name: admin1_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/Admin1Division'
'400':
description: Invalid country or administrative division ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Country or administrative division ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get first-level administrative division information
tags:
- countries
/countries/{country_id}/admin1_divisions/{admin1_id}/cities/:
get:
operationId: listAdmin1DivisionCities
parameters:
- description: The country ID
in: path
name: country_id
required: true
schema:
type: string
- description: The administrative division ID
in: path
name: admin1_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/Admin1DivisionCityList'
'400':
description: Invalid country or administrative division ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Country or administrative division ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: List cities for a first-level administrative division
tags:
- countries
/countries/{country_id}/salaries/:
get:
operationId: getCountrySalaries
parameters:
- description: The country ID
in: path
name: country_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/CountrySalaries'
'400':
description: Invalid country ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Country ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get 25th, 50th, 75th percentile for country salaries
tags:
- countries
/ipaddresses/{address}/:
get:
operationId: getIPAddress
parameters:
- description: IPv4 address
in: path
name: address
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/IPAddress'
'400':
description: Invalid IP address supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Looks up location based on IP address
tags:
- ipaddress
/locations/{coordinates}/:
get:
operationId: getLocation
parameters:
- description: Latitude and longitude separated by comma
in: path
name: coordinates
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/Location'
'400':
description: Invalid coordinates supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Gets geographical features at a location.
tags:
- locations
/timezones/:
get:
operationId: listTimezones
parameters: []
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/TimezoneList'
description: List all timezones
tags:
- timezones
/timezones/{tz_id}/:
get:
operationId: getTimezoneByID
parameters:
- description: >-
The timezone ID, consisting of ID scheme and ID, separated by colon
(e.g. iana:America/Los_Angeles).
in: path
name: tz_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/Timezone'
'400':
description: Invalid timezone ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Timezone ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get timezone information
tags:
- timezones
/timezones/{tz_id}/offsets/:
get:
operationId: getTimezoneByIDOffset
parameters:
- description: |
The timezone ID, consisting of ID scheme and ID.
in: path
name: tz_id
required: true
schema:
type: string
- description: Date/time as of what time the timezone offsets should be provided
in: query
name: date
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/Timezone'
'400':
description: Invalid timezone ID or date supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Timezone ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get timezone information
tags:
- timezones
/urban_areas/:
get:
operationId: listUrbanAreas
parameters: []
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/UrbanAreaList'
description: List all Teleport Urban Areas
tags:
- urban_areas
/urban_areas/{ua_id}/:
get:
operationId: getUrbanAreaByID
parameters:
- description: >-
The urban area ID, consisting of ID scheme and ID, separated by
colon (e.g. teleport:9q8yy)
in: path
name: ua_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/UrbanArea'
'400':
description: Invalid urban area ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Urban Area ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get urban area information
tags:
- urban_areas
/urban_areas/{ua_id}/cities/:
get:
operationId: listUrbanAreaCities
parameters:
- description: The urban area ID
in: path
name: ua_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/UrbanAreaCityList'
'400':
description: Invalid urban area ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Urban Area ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get urban area cities list
tags:
- urban_areas
/urban_areas/{ua_id}/details/:
get:
operationId: getUrbanAreaDetails
parameters:
- description: The urban area ID
in: path
name: ua_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/UrbanAreaDetails'
'400':
description: Invalid urban area ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Urban Area ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get urban area detailed data
tags:
- urban_areas
/urban_areas/{ua_id}/images/:
get:
operationId: getUrbanAreaImages
parameters:
- description: The urban area ID
in: path
name: ua_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/UrbanAreaImages'
'400':
description: Invalid urban area ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Urban Area ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get urban area images
tags:
- urban_areas
/urban_areas/{ua_id}/salaries/:
get:
operationId: getUrbanAreaSalaries
parameters:
- description: The urban area ID
in: path
name: ua_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/UrbanAreaSalaries'
'400':
description: Invalid urban area ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Urban Area ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get 25th, 50th, 75th percentile for urban area salaries
tags:
- urban_areas
/urban_areas/{ua_id}/scores/:
get:
operationId: getUrbanAreaScores
parameters:
- description: The urban area ID
in: path
name: ua_id
required: true
schema:
type: string
responses:
'200':
description: Successful response
x-teleport-mime-type: application/vnd.teleport.v1+json
content:
application/vnd.teleport.v1+json:
schema:
$ref: '#/components/schemas/UrbanAreaScores'
'400':
description: Invalid urban area ID supplied
x-teleport-mime-type: application/vnd.teleport.v1+json
'404':
description: Urban Area ID not found
x-teleport-mime-type: application/vnd.teleport.v1+json
description: Get urban area scores
tags:
- urban_areas
tags:
- description: Cities and other populated areas
externalDocs:
description: Find out more
url: https://developers.teleport.org/api/
name: cities
- description: World countries
externalDocs:
description: Find out more
url: https://developers.teleport.org/api/
name: countries
- description: Teleport Flock
externalDocs:
description: Find out more
url: https://developers.teleport.org/api/
name: flock
- description: IP Address
externalDocs:
description: Find out more
url: https://developers.teleport.org/api/
name: ipaddress
- description: Everything around a geographic coordinate
externalDocs:
description: Find out more
url: https://developers.teleport.org/api/
name: locations
- description: Root
externalDocs:
description: Find out more
url: https://developers.teleport.org/api/
name: root
- description: Timezones
externalDocs:
description: Find out more
url: https://developers.teleport.org/api/
name: timezones
- description: Teleport Urban Areas (aka Teleport Startup Cities)
externalDocs:
description: Find out more
url: https://developers.teleport.org/api/
name: urban_areas
servers:
- url: https://api.teleport.org/api
components:
schemas:
Admin1Division:
description: The detailed information about an administrative division
properties:
geoname_id:
$ref: '#/components/schemas/GeonameID'
geonames_admin1_code:
description: The GeoNames.org admin1 code of the administrative division
type: string
x-teleport-example: CA
name:
description: The name of the administrative division
type: string
x-teleport-example: California
required:
- geoname_id
- geonames_admin1_code
- name
type: object
x-teleport-resource:
embed-if-root:
- a1:country
relations:
a1:cities:
$ref: '#/components/schemas/Admin1DivisionCityList'
a1:country:
$ref: '#/components/schemas/Country'
url-example-parameters:
admin1_code: geonames:CA
country_id: iso_alpha2:US
url-format: /countries/{country_id}/admin1_divisions/{admin1_code}/
Admin1DivisionCityList:
description: The list of cities in an administrative division
properties:
count:
description: Number of cities
format: int32
type: integer
x-teleport-example: 25
required:
- count
type: object
x-teleport-resource:
relations:
city:admin1_division:
$ref: '#/components/schemas/Admin1Division'
city:items:
$ref: '#/components/schemas/City'
url-example-parameters:
admin1_code: geonames:CA
country_id: iso_alpha2:US
url-format: /countries/{country_id}/admin1_divisions/{admin1_code}/cities/
Admin1DivisionList:
description: The level 1 administrative divisions of a country
properties:
count:
description: Number of administrative divisions
format: int32
type: integer
x-teleport-example: 25
required:
- count
type: object
x-teleport-resource:
embed-if-root:
- a1:items
relations:
a1:country:
$ref: '#/components/schemas/Country'
a1:items:
$ref: '#/components/schemas/Admin1Division'
url-example-parameters:
country_id: iso_alpha2:US
url-format: /countries/{country_id}/admin1_divisions/
AlternateName:
description: An alternate name (e.g. alias, translation, IATA code, etc) for a city
properties:
name:
description: The alternate name
type: string
required:
- name
type: object
BoundingBox:
description: Coordinates of a geographic bounding box in various geocoding systems
properties:
latlon:
$ref: '#/components/schemas/LatLonBoundingBox'
required:
- latlon
type: object
City:
description: Detailed information about a city
properties:
full_name:
description: >-
The full name of the city, qualified with country and administrative
division (if present)
type: string
x-teleport-example: San Francisco, California, United States
geoname_id:
$ref: '#/components/schemas/GeonameID'
location:
$ref: '#/components/schemas/Coordinates'
name:
description: The name of the city
type: string
x-teleport-example: San Francisco
population:
$ref: '#/components/schemas/Population'
required:
- geoname_id
- name
- full_name
- location
type: object
CitySearchResults:
description: The results of a city search
properties:
count:
description: Number of cities found
format: int32
type: integer
x-teleport-example: 25
required:
- count
type: object
x-teleport-resource:
embed-if-root:
- city:search-result/city:item
- city:search-result/city:item/city:urban-area
- city:search-result/city:item/city:admin1-division
- city:search-result/city:item/city:country
- city:search-result/city:item/city:timezone/tz:offsets-now
relations:
city:search-results:
$ref: '#/components/schemas/CitySearchResultsItem'
url-example-parameters:
search: San Francisco
url-format: /cities/{?search}
CitySearchResultsItem:
description: Individual search result of a city search
properties:
matching_alternate_names:
description: >-
List of alternate names that were used for matching the city to the
search criteria
items:
$ref: '#/components/schemas/AlternateName'
type: array
matching_full_name:
description: >-
The full name of the city that contains all terms in the search
parameter
type: string
required:
- matching_full_name
- matching_alternate_names
type: object
x-teleport-resource:
embedded-resource: true
relations:
city:item:
$ref: '#/components/schemas/City'
Continent:
description: The detailed information for a continent
properties:
geonames_code:
description: The GeoNames code for the continent
type: string
x-teleport-example: NA
name:
description: The name of the continent
type: string
x-teleport-example: North America
required:
- geonames_code
- name
type: object
x-teleport-resource:
relations:
continent:countries:
$ref: '#/components/schemas/ContinentCountryList'
continent:urban_areas:
$ref: '#/components/schemas/ContinentUrbanAreaList'
url-example-parameters:
continent_id: geonames:NA
url-format: /continents/{continent_id}/
ContinentCountryList:
description: The list of countries on a continent
properties:
count:
description: Number of countries
format: int32
type: integer
x-teleport-example: 25
required:
- count
type: object
x-teleport-resource:
relations:
country:items:
$ref: '#/components/schemas/Country'
url-example-parameters:
continent_id: geonames:NA
url-format: /continents/{continent_id}/countries/
ContinentList:
description: List of continents
properties:
count:
description: Number of continents
format: int32
type: integer
x-teleport-example: 7
required:
- count
type: object
x-teleport-resource:
embed-if-root:
- continent:items
relations:
continent:items:
$ref: '#/components/schemas/Continent'
url-format: /continents/
ContinentUrbanAreaList:
description: The list of urban areas on a continent
properties:
count:
description: Number of urban areas
format: int32
type: integer
x-teleport-example: 25
required:
- count
type: object
x-teleport-resource:
relations:
ua:items:
$ref: '#/components/schemas/UrbanArea'
url-example-parameters:
continent_id: geonames:NA
url-format: /continents/{continent_id}/urban_areas/
Coordinates:
description: Coordinates of a geographic point in various geocoding systems
properties:
geohash:
$ref: '#/components/schemas/GeoHash'
latlon:
$ref: '#/components/schemas/LatLon'
required:
- latlon
- geohash
type: object
Country:
description: The detailed information for a country
properties:
currency_code:
$ref: '#/components/schemas/CurrencyCode'
geoname_id:
$ref: '#/components/schemas/GeonameID'
iso_alpha2:
$ref: '#/components/schemas/ISOAlpha2Code'
iso_alpha3:
$ref: '#/components/schemas/ISOAlpha3Code'
name:
description: The name of the country
type: string
x-teleport-example: United States
population:
$ref: '#/components/schemas/Population'
required:
- iso_alpha2
- iso_alpha3
- name
- population
type: object
x-teleport-resource:
relations:
country:admin1_divisions:
$ref: '#/components/schemas/Admin1DivisionList'
country:continent:
$ref: '#/components/schemas/Continent'
country:salaries:
$ref: '#/components/schemas/CountrySalaries'
url-example-parameters:
country_id: iso_alpha2:US
url-format: /countries/{country_id}/
CountryJob:
description: Job ID and name
properties:
id:
description: Job unique identifier
type: string
x-teleport-example: ACCOUNT-MANAGER
name:
description: Job title
type: string
x-teleport-example: Account Manager
required:
- id
- title
type: object
CountryJobSalary:
description: Salary information for a particular job in a country
properties:
job:
$ref: '#/components/schemas/CountryJob'
salary_percentiles:
$ref: '#/components/schemas/CountryJobSalaryPercentiles'
required:
- job
- salary_percentiles
type: object
CountryJobSalaryPercentiles:
description: Salary 25th, 50th and 75th percentiles for a job and country combination
properties:
percentile_25:
description: Salary in the 25th percentile in US dollars
format: float32
type: number
x-teleport-example: 24331.233598350085
percentile_50:
description: Mean salary (50th percentile) in US dollars
format: float32