Merge pull request #5 from bunq/add_4xx_response

Added generic error definition to base.json.
bunq · Apr 23, 2018 · 4a31a81 · 4a31a81
2 parents 3170c7f + 41a8e6b
commit 4a31a81
Showing 1 changed file with 46 additions and 0 deletions.
diff --git a/base.json b/base.json
@@ -133,6 +133,52 @@
                     "type": "string"
                 }
             }
+        },
+        "responses": {
+            "GenericError": {
+                "description": "This is how the error response looks like for 4XX response codes",
+                "headers": {
+                    "X-Bunq-Server-Response-Id": {
+                        "$ref": "#/components/headers/X-Bunq-Server-Response-Id"
+                    },
+                    "X-Bunq-Client-Request-Id": {
+                        "$ref": "#/components/headers/X-Bunq-Client-Request-Id"
+                    },
+                    "X-Bunq-Server-Signature": {
+                        "$ref": "#/components/headers/X-Bunq-Server-Signature"
+                    }
+                },
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "Error": {
+                                    "$ref": "#/components/schemas/Error"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "schemas": {
+            "Error": {
+                "type": "array",
+                "items": {
+                    "type": "object",
+                    "properties": {
+                        "error_description": {
+                            "type": "string",
+                            "description": "The error description in English."
+                        },
+                        "error_description_translated": {
+                            "type": "string",
+                            "description": "The error description tranlsated to the user's lenguage."
+                        }
+                    }
+                }
+            }
         }
     }
 }