]> granicus.if.org Git - pdns/commitdiff
Swagger: fix Error object definition
authorChris Boot <bootc@bootc.net>
Sun, 16 Dec 2018 14:18:19 +0000 (14:18 +0000)
committerChris Boot <bootc@bootc.net>
Sun, 16 Dec 2018 14:18:19 +0000 (14:18 +0000)
This corrects:
- a typo of the `description` key
- misuse of the `required` key for the `error` parameter

docs/http-api/swagger/authoritative-api-swagger.yaml

index 57382c3080b154c3fd7137b20e581b0f8d79eba5..bb199f302d8b0194cf3a2eed4d59fa348e13d3a3 100644 (file)
@@ -1258,17 +1258,18 @@ definitions:
 
   Error:
     title: Error
-    descripton: 'Returned when the server encounters an error. Either in client input or internally'
+    description: 'Returned when the server encounters an error. Either in client input or internally'
     properties:
       error:
         type: string
         description: 'A human readable error message'
-        required: true
       errors:
         type: array
         items:
           type: string
         description: 'Optional array of multiple errors encountered during processing'
+    required:
+      - error
 
   CacheFlushResult:
     title: CacheFlushResult