refactor: Add example to ScriptReferencedError, ScriptSanitationFailureError

Author: caoccao

ext/hivemq-edge-openapi-2025.9.yaml

@@ -5807,21 +5807,25 @@ components:
             id:
               type: string
               description: The script ID.
-            message:
-              type: string
-              description: The error message.
+              example: abc
           required:
             - id
+      example:
+        general:
+          status: 400
+          title: Script Referenced
+          detail: Script with ID 'abc' is referenced.
+          id: abc
+          type: https://hivemq.com/edge/api/model/ScriptReferencedError
     ScriptSanitationFailureError:
       allOf:
         - $ref: '#/components/schemas/ApiError'
-        - type: object
-          properties:
-            reason:
-              type: string
-              description: The actual reason.
-          required:
-            - reason
+      example:
+        general:
+          status: 400
+          title: Script Sanitation Failure
+          detail: The given script could not be sanitized.
+          type: https://hivemq.com/edge/api/model/ScriptSanitationFailureError
     TopicFilterMismatchError:
       allOf:
         - $ref: '#/components/schemas/ApiError'

ext/openAPI/components/schemas/errors/datahub/ScriptReferencedError.yaml

@@ -5,8 +5,13 @@ allOf:
       id:
         type: string
         description: The script ID.
-      message:
-        type: string
-        description: The error message.
+        example: "abc"
     required:
       - id
+example:
+  general:
+    status: 400
+    title: "Script Referenced"
+    detail: "Script with ID 'abc' is referenced."
+    id: "abc"
+    type: "https://hivemq.com/edge/api/model/ScriptReferencedError"

ext/openAPI/components/schemas/errors/datahub/ScriptSanitationFailureError.yaml

@@ -1,9 +1,8 @@
 allOf:
   - $ref: "../ApiError.yaml"
-  - type: object
-    properties:
-      reason:
-        type: string
-        description: The actual reason.
-    required:
-      - reason
+example:
+  general:
+    status: 400
+    title: "Script Sanitation Failure"
+    detail: "The given script could not be sanitized."
+    type: "https://hivemq.com/edge/api/model/ScriptSanitationFailureError"