Skip to content
This repository was archived by the owner on Dec 2, 2022. It is now read-only.

Commit e2cce74

Browse files
authored
Merge pull request #32 from jackelder/api-spec
Remove Swagger base path
2 parents dbf3cb9 + 7ba22be commit e2cce74

File tree

1 file changed

+39
-25
lines changed

1 file changed

+39
-25
lines changed

public/swagger.yaml

Lines changed: 39 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,6 @@ x-tagGroups:
121121
- Locations
122122
- Species
123123
- Vehicles
124-
# will be prefixed to all paths
125-
basePath: /
126124
produces:
127125
- application/json
128126
paths:
@@ -210,8 +208,7 @@ paths:
210208
in: path
211209
description: film `id`
212210
required: true
213-
type: integer
214-
format: int64
211+
type: string
215212
- name: fields
216213
in: query
217214
description: comma-separated list of fields to include in the response
@@ -339,8 +336,7 @@ paths:
339336
in: path
340337
description: person `id`
341338
required: true
342-
type: integer
343-
format: int64
339+
type: string
344340
- name: fields
345341
in: query
346342
description: comma-separated list of fields to include in the response
@@ -476,8 +472,7 @@ paths:
476472
in: path
477473
description: location `id`
478474
required: true
479-
type: integer
480-
format: int64
475+
type: string
481476
- name: fields
482477
in: query
483478
description: comma-separated list of fields to include in the response
@@ -509,7 +504,7 @@ paths:
509504
$ref: '#/definitions/Locations'
510505
examples:
511506
application/json:
512-
id: 1
507+
id: 11014596-71b0-4b3e-b8c0-1c4b15f28b9a
513508
name: Irontown
514509
climate: Continental
515510
terrain: Mountain
@@ -609,8 +604,7 @@ paths:
609604
in: path
610605
description: film `id`
611606
required: true
612-
type: integer
613-
format: int64
607+
type: string
614608
- name: fields
615609
in: query
616610
description: comma-separated list of fields to include in the response
@@ -751,8 +745,7 @@ paths:
751745
in: path
752746
description: film `id`
753747
required: true
754-
type: integer
755-
format: int64
748+
type: string
756749
- name: fields
757750
in: query
758751
description: comma-separated list of fields to include in the response
@@ -803,7 +796,7 @@ definitions:
803796
type: object
804797
properties:
805798
id:
806-
type: integer
799+
type: string
807800
description: Unique identifier representing a specific film
808801
title:
809802
type: string
@@ -833,14 +826,25 @@ definitions:
833826
type: string
834827
description: Rotten Tomato score of film
835828
people:
836-
type: string
829+
type: array
837830
description: People found in film
831+
items:
832+
type: string
838833
species:
839-
type: string
834+
type: array
840835
description: Species found in film
836+
items:
837+
type: string
841838
locations:
842-
type: string
839+
type: array
843840
description: Locations found in film
841+
items:
842+
type: string
843+
vehicles:
844+
type: array
845+
description: Vehicles found in film
846+
items:
847+
type: string
844848
url:
845849
type: string
846850
description: URL of film
@@ -866,8 +870,10 @@ definitions:
866870
type: string
867871
description: Hair color of the person
868872
films:
869-
type: string
873+
type: array
870874
description: Array of films the person appears in
875+
items:
876+
type: string
871877
species:
872878
type: string
873879
description: Species the person belongs to
@@ -878,7 +884,7 @@ definitions:
878884
type: object
879885
properties:
880886
id:
881-
type: integer
887+
type: string
882888
description: Unique identifier representing a specific location
883889
name:
884890
type: string
@@ -887,17 +893,21 @@ definitions:
887893
type: string
888894
description: Climate of location
889895
terrain:
890-
type: integer
896+
type: string
891897
description: Terrain type of location
892898
surface_water:
893899
type: string
894900
description: Percent of location covered in water
895901
residents:
896-
type: integer
902+
type: array
897903
description: Array of residents in location
904+
items:
905+
type: string
898906
films:
899-
type: string
900-
description: Climate of location
907+
type: array
908+
description: Array of films the location appears in
909+
items:
910+
type: string
901911
url:
902912
type: integer
903913
description: Individual URL of the location
@@ -920,11 +930,15 @@ definitions:
920930
type: string
921931
description: Hair color of the species
922932
people:
923-
type: string
933+
type: array
924934
description: People belonging to the species
935+
items:
936+
type: string
925937
films:
926-
type: string
938+
type: array
927939
description: Array of films the species appears in
940+
items:
941+
type: string
928942
url:
929943
type: string
930944
description: Unique url of the species

0 commit comments

Comments
 (0)