Fix OpenAPI spec warnings

ideal-postcodes · Nov 1, 2024 · c77485f · c77485f
1 parent 3fd42bf
commit c77485f
Show file tree

Hide file tree

Showing 8 changed files with 1,402 additions and 642 deletions.
diff --git a/openapi/components/schemas/Place.yaml b/openapi/components/schemas/Place.yaml
@@ -109,13 +109,15 @@ properties:
     example: "Wales"
   longitude:
     title: Longitude
-    type: double float
+    type: number
+    format: double
     description: >-
       The WGS84 longitude given the Place's national grid reference.
     example: "-3.14971194307843"
   latitude:
     title: Latitude
-    type: double float
+    type: number
+    format: double
     description: >-
       The WGS84 latitude given the Place's national grid reference.
     example: "52.6606391732959"

diff --git a/openapi/paths/outcodes@{outcode}.yaml b/openapi/paths/outcodes@{outcode}.yaml
@@ -4,9 +4,9 @@ get:
   summary: "Outcode Lookup"
   description:
     $ref: ../md/outcode.md
-  operationId: FindPlace
+  operationId: FindOutcode
   parameters:
-    - name: Outcode
+    - name: outcode
       in: path
       description: Specifies the outward code you wish to query.
       required: true

diff --git a/openapi/paths/places@{code}.yaml b/openapi/paths/places@{code}.yaml
@@ -6,11 +6,11 @@ get:
     $ref: ../md/places.md
   operationId: FindPlace
   parameters:
-    - name: query
-      in: query
+    - name: code
+      in: path
       description: Specifies the place you wish to query
       required: true
-      style: form
+      style: simple
       explode: false
       schema:
         type: string

diff --git a/openapi/paths/postcodes.yaml b/openapi/paths/postcodes.yaml
@@ -47,18 +47,6 @@ get:
         example: 51.50354
         maximum: 90
         minimum: -90
-    - name: limit
-      in: query
-      style: form
-      explode: false
-      schema:
-        title: Limit
-        type: integer
-        description: Limits number of postcodes matches to return. Defaults to 10. Needs to be less than 100.
-        example: 20
-        maximum: 100
-        default: 10
-        minimum: 1
     - name: radius
       in: query
       style: form

diff --git a/openapi/paths/scotland@postcodes@{postcode}.yaml b/openapi/paths/scotland@postcodes@{postcode}.yaml
@@ -6,7 +6,7 @@ get:
     $ref: ../md/scottish-postcodes.md
   operationId: Scottish Postcodes
   parameters:
-    - name: Scottish Postcode
+    - name: postcode
       in: path
       description: Specifies the postcode you wish to query
       required: true

diff --git a/openapi/paths/terminated_postcodes@{postcode}.yaml b/openapi/paths/terminated_postcodes@{postcode}.yaml
@@ -6,7 +6,7 @@ get:
     $ref: ../md/terminated-postcodes.md
   operationId: TerminatedPostcodes
   parameters:
-    - name: Terminated Postcode
+    - name: postcode
       in: path
       description: Postcode to query
       required: true