Merge pull request #167 from personio/task/add-error-examples-to-comm…

…on-components Task/Add error examples to common components v2
personio · Aug 2, 2023 · f598011 · f598011
2 parents f9c344e + 7aaf875
commit f598011
Showing 1 changed file with 68 additions and 1 deletion.
diff --git a/common-components-v2.json b/common-components-v2.json
@@ -103,7 +103,7 @@
         "type": "object",
         "description": "This object represents an error response.",
         "properties": {
-          "trace_id": {
+          "personio_trace_id": {
             "type": "string",
             "example": "aswo3f-a202lfso-312123sld-1230ddd",
             "description": "A unique ID that was created for this error."
@@ -245,6 +245,73 @@
         },
         "description": "The pagination cursor to navigate over to the next list of resources. If you pass a specific limit to your  request, or you rely on the default value of the number of resources to be returned, then your subsequent call has to include the cursor in order to retrieve the next list of resources. If cursor is missing,  the first page is returned."
       }
+    },
+    "examples": {
+      "ResourceNotFound": {
+        "value": {
+          "personio_trace_id": "aswo3f-a202lfso-312123sld-1230ddd",
+          "timestamp": "2021-05-28T11:17:30+00:00",
+          "errors": [
+            {
+              "title": "Resource not found",
+              "details": "The requested resource was not found. The resource could have been deleted or never existed in our system.",
+              "type": "https://developer.personio.de/reference/errors#common.requested_resource_not_found"
+            }
+          ]
+        }
+      },
+      "InternalServerError": {
+        "value": {
+          "personio_trace_id": "aswo3f-a202lfso-312123sld-1230ddd",
+          "timestamp": "2021-05-28T11:17:30+00:00",
+          "errors": [
+            {
+              "title": "Internal Server Error",
+              "details": "There was a problem while processing this request. Please try again later.",
+              "type": "https://developer.personio.de/reference/errors#common.internal_server_error"
+            }
+          ]
+        }
+      },
+      "BadGateway": {
+        "value": {
+          "personio_trace_id": "aswo3f-a202lfso-312123sld-1230ddd",
+          "timestamp": "2021-05-28T11:17:30+00:00",
+          "errors": [
+            {
+              "title": "Bad Gateway",
+              "details": "There was a problem while processing this request. Please try again later.",
+              "type": "https://developer.personio.de/reference/errors#common.bad_gateway"
+            }
+          ]
+        }
+      },
+      "ServiceUnavailable": {
+        "value": {
+          "personio_trace_id": "aswo3f-a202lfso-312123sld-1230ddd",
+          "timestamp": "2021-05-28T11:17:30+00:00",
+          "errors": [
+            {
+              "title": "Service Unavailable",
+              "details": "The server is temporarily unavailable. Please try again later.",
+              "type": "https://developer.personio.de/reference/errors#common.service_unavailable"
+            }
+          ]
+        }
+      },
+      "GatewayTimeout": {
+        "value": {
+          "personio_trace_id": "aswo3f-a202lfso-312123sld-1230ddd",
+          "timestamp": "2021-05-28T11:17:30+00:00",
+          "errors": [
+            {
+              "title": "Gateway Timeout",
+              "details": "There was a problem while processing this request. Please try again later.",
+              "type": "https://developer.personio.de/reference/errors#common.gateway_timeout"
+            }
+          ]
+        }
+      }
     }
   }
 }