From 51163935a18feb54a4450596fbc6ad8512781c11 Mon Sep 17 00:00:00 2001 From: Kolja Huell Date: Mon, 19 Oct 2026 10:03:10 +0200 Subject: [PATCH 1/2] Add description text for error codes --- schemas.yaml | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/schemas.yaml b/schemas.yaml index d4b4e11..4a29532 100644 --- a/schemas.yaml +++ b/schemas.yaml @@ -2273,6 +2273,7 @@ schemas: errorObject_101: allOf: - $ref: "#/schemas/errorObject" + - description: An unexpected internal error occurred on the gateway/master. - type: object properties: code: @@ -2282,6 +2283,7 @@ schemas: errorObject_102: allOf: - $ref: "#/schemas/errorObject" + - description: An error occurred during internal communication between gateway/master components. - type: object properties: code: @@ -2291,6 +2293,7 @@ schemas: errorObject_103: allOf: - $ref: "#/schemas/errorObject" + - description: The requested operation is not supported by the gateway/master. - type: object properties: code: @@ -2300,6 +2303,7 @@ schemas: errorObject_104: allOf: - $ref: "#/schemas/errorObject" + - description: The requested action cannot be performed because it is currently locked by another client. - type: object properties: code: @@ -2309,6 +2313,7 @@ schemas: errorObject_105: allOf: - $ref: "#/schemas/errorObject" + - description: The requested IODD related feature is not supported by the gateway/master. - type: object properties: code: @@ -2318,6 +2323,7 @@ schemas: errorObject_106: allOf: - $ref: "#/schemas/errorObject" + - description: The requested MQTT related feature is not supported by the gateway/master. - type: object properties: code: @@ -2327,6 +2333,7 @@ schemas: errorObject_107: allOf: - $ref: "#/schemas/errorObject" + - description: An error occurred while performing the device firmware update. - type: object properties: code: @@ -2336,6 +2343,7 @@ schemas: errorObject_150: allOf: - $ref: "#/schemas/errorObject" + - description: The client does not have the permission to perform the requested operation. - type: object properties: code: @@ -2345,6 +2353,7 @@ schemas: errorObject_151: allOf: - $ref: "#/schemas/errorObject" + - description: The request does not contain valid authentication information. - type: object properties: code: @@ -2354,6 +2363,7 @@ schemas: errorObject_201: allOf: - $ref: "#/schemas/errorObject" + - description: The request body could not be parsed as valid JSON. - type: object properties: code: @@ -2363,6 +2373,7 @@ schemas: errorObject_202: allOf: - $ref: "#/schemas/errorObject" + - description: This occurs when a value in the JSON payload does not meet the expected criteria (e.g. invalid UTF-8 characters) - type: object properties: code: @@ -2372,6 +2383,7 @@ schemas: errorObject_203: allOf: - $ref: "#/schemas/errorObject" + - description: A value in the JSON payload does not match the expected data type. This could occur, for example, if a string is provided where a number is expected. - type: object properties: code: @@ -2381,6 +2393,7 @@ schemas: errorObject_204: allOf: - $ref: "#/schemas/errorObject" + - description: A value in the JSON payload does not match any of the allowed enumeration values. - type: object properties: code: @@ -2390,6 +2403,7 @@ schemas: errorObject_205: allOf: - $ref: "#/schemas/errorObject" + - description: A numeric value in the JSON payload is outside the allowed minimum/maximum range. - type: object properties: code: @@ -2399,6 +2413,7 @@ schemas: errorObject_206: allOf: - $ref: "#/schemas/errorObject" + - description: A value in the JSON payload exceeds the allowed length or size bounds (e.g. string or array length). - type: object properties: code: @@ -2408,6 +2423,7 @@ schemas: errorObject_207: allOf: - $ref: "#/schemas/errorObject" + - description: The given deviceAlias is already assigned to another device. - type: object properties: code: @@ -2417,6 +2433,7 @@ schemas: errorObject_208: allOf: - $ref: "#/schemas/errorObject" + - description: The POST request requires a body, but none was provided. - type: object properties: code: @@ -2426,6 +2443,7 @@ schemas: errorObject_301: allOf: - $ref: "#/schemas/errorObject" + - description: The requested resource could not be found (e.g. the specified URL does not exist). - type: object properties: code: @@ -2435,6 +2453,7 @@ schemas: errorObject_302: allOf: - $ref: "#/schemas/errorObject" + - description: The given masterNumber does not exist on the gateway. - type: object properties: code: @@ -2444,6 +2463,7 @@ schemas: errorObject_303: allOf: - $ref: "#/schemas/errorObject" + - description: The given portNumber does not exist on the addressed master. - type: object properties: code: @@ -2453,6 +2473,7 @@ schemas: errorObject_304: allOf: - $ref: "#/schemas/errorObject" + - description: The given deviceAlias does not exist on the gateway. - type: object properties: code: @@ -2462,6 +2483,7 @@ schemas: errorObject_305: allOf: - $ref: "#/schemas/errorObject" + - description: The request contains an unknown or unsupported query parameter name. - type: object properties: code: @@ -2471,6 +2493,7 @@ schemas: errorObject_306: allOf: - $ref: "#/schemas/errorObject" + - description: The value provided for a query parameter is invalid. - type: object properties: code: @@ -2480,6 +2503,7 @@ schemas: errorObject_307: allOf: - $ref: "#/schemas/errorObject" + - description: The addressed port is not configured for IO-Link mode. - type: object properties: code: @@ -2489,6 +2513,7 @@ schemas: errorObject_308: allOf: - $ref: "#/schemas/errorObject" + - description: The IO-Link Device cannot currently be reached, e.g. because communication is lost. - type: object properties: code: @@ -2498,6 +2523,7 @@ schemas: errorObject_309: allOf: - $ref: "#/schemas/errorObject" + - description: The requested IO-Link parameter does not exist on the device. - type: object properties: code: @@ -2507,6 +2533,7 @@ schemas: errorObject_310: allOf: - $ref: "#/schemas/errorObject" + - description: The device does not support accessing the requested IO-Link parameter in the requested way. - type: object properties: code: @@ -2516,6 +2543,7 @@ schemas: errorObject_311: allOf: - $ref: "#/schemas/errorObject" + - description: The IO-Link Device returned an error while accessing the parameter. See iolinkError for details. - type: object properties: code: @@ -2529,6 +2557,7 @@ schemas: errorObject_312: allOf: - $ref: "#/schemas/errorObject" + - description: The given parameterName is ambiguous and matches more than one parameter on the device. - type: object properties: code: @@ -2538,6 +2567,7 @@ schemas: errorObject_401: allOf: - $ref: "#/schemas/errorObject" + - description: The Data Storage content does not match between the master and the device. - type: object properties: code: @@ -2547,6 +2577,7 @@ schemas: errorObject_501: allOf: - $ref: "#/schemas/errorObject" + - description: The I/Q pin (pin2) of the port is not configured as DIGITAL_OUTPUT. - type: object properties: code: @@ -2556,6 +2587,7 @@ schemas: errorObject_502: allOf: - $ref: "#/schemas/errorObject" + - description: The C/Q pin (pin4) of the port is not configured as DIGITAL_OUTPUT. - type: object properties: code: @@ -2565,6 +2597,7 @@ schemas: errorObject_503: allOf: - $ref: "#/schemas/errorObject" + - description: The IO-Link Device does not provide output process data, so setData cannot be used. - type: object properties: code: @@ -2574,6 +2607,7 @@ schemas: errorObject_601: allOf: - $ref: "#/schemas/errorObject" + - description: No IODD (representation) is available for this IO-Link device on the gateway. - type: object properties: code: @@ -2584,6 +2618,7 @@ schemas: errorObject_602: allOf: - $ref: "#/schemas/errorObject" + - description: The IODD upload failed because there is not enough memory available on the gateway. - type: object properties: code: @@ -2593,6 +2628,7 @@ schemas: errorObject_603: allOf: - $ref: "#/schemas/errorObject" + - description: The IODD upload failed because the IODD XML file is invalid. - type: object properties: code: @@ -2602,6 +2638,7 @@ schemas: errorObject_604: allOf: - $ref: "#/schemas/errorObject" + - description: The IODD upload failed because the CRC check of the uploaded archive failed. - type: object properties: code: @@ -2611,6 +2648,7 @@ schemas: errorObject_605: allOf: - $ref: "#/schemas/errorObject" + - description: The IODD upload failed because the IODD could not be parsed. - type: object properties: code: @@ -2620,6 +2658,7 @@ schemas: errorObject_701: allOf: - $ref: "#/schemas/errorObject" + - description: The provided data set is incomplete. - type: object properties: code: @@ -2629,6 +2668,7 @@ schemas: errorObject_702: allOf: - $ref: "#/schemas/errorObject" + - description: The provided data set does not apply to the addressed port or device. - type: object properties: code: @@ -2638,6 +2678,7 @@ schemas: errorObject_703: allOf: - $ref: "#/schemas/errorObject" + - description: The combination of provided data set values is incompatible. - type: object properties: code: @@ -2647,6 +2688,7 @@ schemas: errorObject_704: allOf: - $ref: "#/schemas/errorObject" + - description: The provided file exceeds the maximum size that can be processed. - type: object properties: code: From f23a71994ff54b30f9b0d828a32bc01702876a4a Mon Sep 17 00:00:00 2001 From: Kolja Huell Date: Mon, 19 Oct 2026 10:38:24 +0200 Subject: [PATCH 2/2] Remove obsolete error codes --- JSON_for_IO-Link_unmerged.yaml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/JSON_for_IO-Link_unmerged.yaml b/JSON_for_IO-Link_unmerged.yaml index b90a89c..ddeb135 100644 --- a/JSON_for_IO-Link_unmerged.yaml +++ b/JSON_for_IO-Link_unmerged.yaml @@ -2581,8 +2581,6 @@ paths: - $ref: "./schemas.yaml#/schemas/errorObject_201" - $ref: "./schemas.yaml#/schemas/errorObject_202" - $ref: "./schemas.yaml#/schemas/errorObject_203" - - $ref: "./schemas.yaml#/schemas/errorObject_204" - - $ref: "./schemas.yaml#/schemas/errorObject_205" - $ref: "./schemas.yaml#/schemas/errorObject_206" - $ref: "./schemas.yaml#/schemas/errorObject_208" - $ref: "./schemas.yaml#/schemas/errorObject_401" @@ -3143,12 +3141,10 @@ paths: - $ref: "./schemas.yaml#/schemas/errorObject_201" - $ref: "./schemas.yaml#/schemas/errorObject_202" - $ref: "./schemas.yaml#/schemas/errorObject_203" - - $ref: "./schemas.yaml#/schemas/errorObject_204" - $ref: "./schemas.yaml#/schemas/errorObject_205" - $ref: "./schemas.yaml#/schemas/errorObject_206" - $ref: "./schemas.yaml#/schemas/errorObject_208" - $ref: "./schemas.yaml#/schemas/errorObject_305" - - $ref: "./schemas.yaml#/schemas/errorObject_306" - $ref: "./schemas.yaml#/schemas/errorObject_307" - $ref: "./schemas.yaml#/schemas/errorObject_501" - $ref: "./schemas.yaml#/schemas/errorObject_502" @@ -3512,12 +3508,10 @@ paths: - $ref: "./schemas.yaml#/schemas/errorObject_201" - $ref: "./schemas.yaml#/schemas/errorObject_202" - $ref: "./schemas.yaml#/schemas/errorObject_203" - - $ref: "./schemas.yaml#/schemas/errorObject_204" - $ref: "./schemas.yaml#/schemas/errorObject_205" - $ref: "./schemas.yaml#/schemas/errorObject_206" - $ref: "./schemas.yaml#/schemas/errorObject_208" - $ref: "./schemas.yaml#/schemas/errorObject_305" - - $ref: "./schemas.yaml#/schemas/errorObject_306" - $ref: "./schemas.yaml#/schemas/errorObject_307" - $ref: "./schemas.yaml#/schemas/errorObject_311" - $ref: "./schemas.yaml#/schemas/errorObject_601" @@ -3721,7 +3715,6 @@ paths: - $ref: "./schemas.yaml#/schemas/errorObject_201" - $ref: "./schemas.yaml#/schemas/errorObject_202" - $ref: "./schemas.yaml#/schemas/errorObject_203" - - $ref: "./schemas.yaml#/schemas/errorObject_204" - $ref: "./schemas.yaml#/schemas/errorObject_205" - $ref: "./schemas.yaml#/schemas/errorObject_206" - $ref: "./schemas.yaml#/schemas/errorObject_208"