Skip to content

Commit 81eff97

Browse files
committed
refactor: Add example to ScriptNotFoundError, ScriptParsingFailureError
1 parent f6582ac commit 81eff97

File tree

3 files changed

+28
-20
lines changed

3 files changed

+28
-20
lines changed

ext/hivemq-edge-openapi-2025.9.yaml

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5780,21 +5780,25 @@ components:
57805780
id:
57815781
type: string
57825782
description: The script ID.
5783-
message:
5784-
type: string
5785-
description: The error message.
5783+
example: abc
57865784
required:
57875785
- id
5786+
example:
5787+
general:
5788+
status: 404
5789+
title: Script Not Found
5790+
detail: Script with ID 'abc' is not found.
5791+
id: abc
5792+
type: https://hivemq.com/edge/api/model/ScriptNotFoundError
57885793
ScriptParsingFailureError:
57895794
allOf:
57905795
- $ref: '#/components/schemas/ApiError'
5791-
- type: object
5792-
properties:
5793-
reason:
5794-
type: string
5795-
description: The actual reason.
5796-
required:
5797-
- reason
5796+
example:
5797+
general:
5798+
status: 400
5799+
title: Script Parsing Failure
5800+
detail: The given script 'abc' could not be parsed.
5801+
type: https://hivemq.com/edge/api/model/ScriptParsingFailureError
57985802
ScriptReferencedError:
57995803
allOf:
58005804
- $ref: '#/components/schemas/ApiError'

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,13 @@ allOf:
55
id:
66
type: string
77
description: The script ID.
8-
message:
9-
type: string
10-
description: The error message.
8+
example: "abc"
119
required:
1210
- id
11+
example:
12+
general:
13+
status: 404
14+
title: "Script Not Found"
15+
detail: "Script with ID 'abc' is not found."
16+
id: "abc"
17+
type: "https://hivemq.com/edge/api/model/ScriptNotFoundError"
Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
allOf:
22
- $ref: "../ApiError.yaml"
3-
- type: object
4-
properties:
5-
reason:
6-
type: string
7-
description: The actual reason.
8-
required:
9-
- reason
3+
example:
4+
general:
5+
status: 400
6+
title: "Script Parsing Failure"
7+
detail: "The given script 'abc' could not be parsed."
8+
type: "https://hivemq.com/edge/api/model/ScriptParsingFailureError"

0 commit comments

Comments
 (0)