refactor: Rename ApiError to ApiProblemDetails

caoccao · caoccao · commit f657015a55de · 2025-08-13T16:02:39.000+02:00
diff --git a/ext/hivemq-edge-openapi-2025.13.yaml b/ext/hivemq-edge-openapi-2025.13.yaml
diff --git a/ext/openAPI/components/schemas/errors/ApiProblemDetails.yaml b/ext/openAPI/components/schemas/errors/ApiProblemDetails.yaml
diff --git a/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyAlreadyPresentError.yaml b/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyAlreadyPresentError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyCreationFailureError.yaml b/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyCreationFailureError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 400
diff --git a/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyInvalidErrors.yaml b/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyInvalidErrors.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       childErrors:
diff --git a/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyNotFoundError.yaml b/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyNotFoundError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyRejectedError.yaml b/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyRejectedError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 400
diff --git a/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyUpdateFailureError.yaml b/ext/openAPI/components/schemas/errors/datahub/BehaviorPolicyUpdateFailureError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/ClientDisconnectedError.yaml b/ext/openAPI/components/schemas/errors/datahub/ClientDisconnectedError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/ClientNotFoundError.yaml b/ext/openAPI/components/schemas/errors/datahub/ClientNotFoundError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/DataPolicyAlreadyPresentError.yaml b/ext/openAPI/components/schemas/errors/datahub/DataPolicyAlreadyPresentError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/DataPolicyCreationFailureError.yaml b/ext/openAPI/components/schemas/errors/datahub/DataPolicyCreationFailureError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 400
diff --git a/ext/openAPI/components/schemas/errors/datahub/DataPolicyInvalidErrors.yaml b/ext/openAPI/components/schemas/errors/datahub/DataPolicyInvalidErrors.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       childErrors:
diff --git a/ext/openAPI/components/schemas/errors/datahub/DataPolicyNotFoundError.yaml b/ext/openAPI/components/schemas/errors/datahub/DataPolicyNotFoundError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/DataPolicyRejectedError.yaml b/ext/openAPI/components/schemas/errors/datahub/DataPolicyRejectedError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 400
diff --git a/ext/openAPI/components/schemas/errors/datahub/DataPolicyUpdateFailureError.yaml b/ext/openAPI/components/schemas/errors/datahub/DataPolicyUpdateFailureError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/PolicyIdMismatchError.yaml b/ext/openAPI/components/schemas/errors/datahub/PolicyIdMismatchError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       actualId:
diff --git a/ext/openAPI/components/schemas/errors/datahub/PolicyInsufficientStorageError.yaml b/ext/openAPI/components/schemas/errors/datahub/PolicyInsufficientStorageError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/PolicyNotFoundError.yaml b/ext/openAPI/components/schemas/errors/datahub/PolicyNotFoundError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/SchemaAlreadyPresentError.yaml b/ext/openAPI/components/schemas/errors/datahub/SchemaAlreadyPresentError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/SchemaEtagMismatchError.yaml b/ext/openAPI/components/schemas/errors/datahub/SchemaEtagMismatchError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/SchemaInsufficientStorageError.yaml b/ext/openAPI/components/schemas/errors/datahub/SchemaInsufficientStorageError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/SchemaInvalidErrors.yaml b/ext/openAPI/components/schemas/errors/datahub/SchemaInvalidErrors.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       childErrors:
diff --git a/ext/openAPI/components/schemas/errors/datahub/SchemaNotFoundError.yaml b/ext/openAPI/components/schemas/errors/datahub/SchemaNotFoundError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/SchemaParsingFailureError.yaml b/ext/openAPI/components/schemas/errors/datahub/SchemaParsingFailureError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       alias:
diff --git a/ext/openAPI/components/schemas/errors/datahub/SchemaReferencedError.yaml b/ext/openAPI/components/schemas/errors/datahub/SchemaReferencedError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/ScriptAlreadyPresentError.yaml b/ext/openAPI/components/schemas/errors/datahub/ScriptAlreadyPresentError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/ScriptCreationFailureError.yaml b/ext/openAPI/components/schemas/errors/datahub/ScriptCreationFailureError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 400
diff --git a/ext/openAPI/components/schemas/errors/datahub/ScriptEtagMismatchError.yaml b/ext/openAPI/components/schemas/errors/datahub/ScriptEtagMismatchError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/ScriptInsufficientStorageError.yaml b/ext/openAPI/components/schemas/errors/datahub/ScriptInsufficientStorageError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/ScriptInvalidErrors.yaml b/ext/openAPI/components/schemas/errors/datahub/ScriptInvalidErrors.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       childErrors:
diff --git a/ext/openAPI/components/schemas/errors/datahub/ScriptNotFoundError.yaml b/ext/openAPI/components/schemas/errors/datahub/ScriptNotFoundError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/ScriptParsingFailureError.yaml b/ext/openAPI/components/schemas/errors/datahub/ScriptParsingFailureError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 400
diff --git a/ext/openAPI/components/schemas/errors/datahub/ScriptReferencedError.yaml b/ext/openAPI/components/schemas/errors/datahub/ScriptReferencedError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       id:
diff --git a/ext/openAPI/components/schemas/errors/datahub/ScriptSanitationFailureError.yaml b/ext/openAPI/components/schemas/errors/datahub/ScriptSanitationFailureError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 400
diff --git a/ext/openAPI/components/schemas/errors/datahub/TopicFilterMismatchError.yaml b/ext/openAPI/components/schemas/errors/datahub/TopicFilterMismatchError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       path:
diff --git a/ext/openAPI/components/schemas/errors/http/InsufficientStorageError.yaml b/ext/openAPI/components/schemas/errors/http/InsufficientStorageError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 507
diff --git a/ext/openAPI/components/schemas/errors/http/InternalServerError.yaml b/ext/openAPI/components/schemas/errors/http/InternalServerError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 500
diff --git a/ext/openAPI/components/schemas/errors/http/InvalidQueryParameterError.yaml b/ext/openAPI/components/schemas/errors/http/InvalidQueryParameterError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       parameter:
diff --git a/ext/openAPI/components/schemas/errors/http/PreconditionFailedError.yaml b/ext/openAPI/components/schemas/errors/http/PreconditionFailedError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 412
diff --git a/ext/openAPI/components/schemas/errors/http/RequestBodyMissingError.yaml b/ext/openAPI/components/schemas/errors/http/RequestBodyMissingError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 400
diff --git a/ext/openAPI/components/schemas/errors/http/RequestBodyParameterMissingError.yaml b/ext/openAPI/components/schemas/errors/http/RequestBodyParameterMissingError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       parameter:
diff --git a/ext/openAPI/components/schemas/errors/http/TemporaryNotAvailableError.yaml b/ext/openAPI/components/schemas/errors/http/TemporaryNotAvailableError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
 example:
   general:
     status: 503
diff --git a/ext/openAPI/components/schemas/errors/http/UrlParameterMissingError.yaml b/ext/openAPI/components/schemas/errors/http/UrlParameterMissingError.yaml
@@ -1,5 +1,5 @@
 allOf:
-  - $ref: "../ApiError.yaml"
+  - $ref: "../ApiProblemDetails.yaml"
   - type: object
     properties:
       parameter:
diff --git a/hivemq-edge/src/main/java/com/hivemq/util/ErrorResponseUtil.java b/hivemq-edge/src/main/java/com/hivemq/util/ErrorResponseUtil.java
@@ -17,6 +17,7 @@
 
 import com.hivemq.api.error.ApiExceptionMapper;
 import com.hivemq.edge.api.model.ApiError;
+import com.hivemq.edge.api.model.ApiProblemDetails;
 import com.hivemq.http.HttpConstants;
 import com.hivemq.http.error.ProblemDetails;
 import jakarta.ws.rs.core.Response;
@@ -26,7 +27,7 @@
  * @author Christoph Schäbel
  */
 public class ErrorResponseUtil {
-    public static @NotNull Response errorResponse(final @NotNull ApiError error) {
+    public static @NotNull Response errorResponse(final @NotNull ApiProblemDetails error) {
         return Response.status(error.getStatus())
                 .entity(error)
                 .type(HttpConstants.APPLICATION_PROBLEM_JSON_TYPE)
