1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
From 2b865ad20ce0616b79a453d1571976bb2303050c Mon Sep 17 00:00:00 2001
From: Krzysztof Grobelny <krzysztof.grobelny@intel.com>
Date: Wed, 14 Jul 2021 13:55:27 +0000
Subject: [PATCH] Add generic message - PropertySizeExceeded
Adding a generic error message "PropertySizeExceeded"
to address properties which exceed there defined size limit.
Tested:
No functional change. Build passed.
Verified by explicitly sending this message as a response.
Change-Id: I0e9f85f82a69c598e169fc8e9a68c3f66c0084d8
Signed-off-by: Nitin Wankhade <nitinx.arunrao.wankhade@intel.com>
---
redfish-core/include/error_messages.hpp | 12 +++++++++
.../registries/base_message_registry.hpp | 17 +++++++++++-
redfish-core/src/error_messages.cpp | 27 +++++++++++++++++++
3 files changed, 55 insertions(+), 1 deletion(-)
diff --git a/redfish-core/include/error_messages.hpp b/redfish-core/include/error_messages.hpp
index 922dae9..f29e326 100644
--- a/redfish-core/include/error_messages.hpp
+++ b/redfish-core/include/error_messages.hpp
@@ -222,6 +222,18 @@ nlohmann::json propertyValueFormatError(const std::string& arg1,
void propertyValueFormatError(crow::Response& res, const std::string& arg1,
const std::string& arg2);
+/**
+ * @brief Formats PropertySizeExceeded message into JSON
+ * Message body: "The property <arg1> is too long. The value exceeds its size
+ * limit."
+ *
+ * @param[in] arg1 Parameter of message that will replace %1 in its body.
+ *
+ * @returns Message PropertySizeExceeded formatted to JSON */
+nlohmann::json propertySizeExceeded(const std::string& arg1);
+
+void propertySizeExceeded(crow::Response& res, const std::string& arg1);
+
/**
* @brief Formats PropertyValueNotInList message into JSON
* Message body: "The value <arg1> for the property <arg2> is not in the list of
diff --git a/redfish-core/include/registries/base_message_registry.hpp b/redfish-core/include/registries/base_message_registry.hpp
index 58156c8..ab9b046 100644
--- a/redfish-core/include/registries/base_message_registry.hpp
+++ b/redfish-core/include/registries/base_message_registry.hpp
@@ -36,7 +36,7 @@ const Header header = {
constexpr const char* url =
"https://redfish.dmtf.org/registries/Base.1.10.0.json";
-constexpr std::array<MessageEntry, 87> registry = {
+constexpr std::array<MessageEntry, 88> registry = {
MessageEntry{
"AccessDenied",
{
@@ -664,6 +664,21 @@ constexpr std::array<MessageEntry, 87> registry = {
"Remove the property from the request body and resubmit "
"the request if the operation failed.",
}},
+ MessageEntry{"PropertySizeExceeded",
+ {
+ "Indicates that a given property exceeds the size "
+ "limit imposed.",
+ "The property %1 is too long. The value exceeds "
+ "its size limit.",
+ "Warning",
+ "Warning",
+ 1,
+ {
+ "string",
+ },
+ "Correct the value for the property in the request body "
+ "and resubmit the request if the operation failed.",
+ }},
MessageEntry{"PropertyUnknown",
{
"Indicates that an unknown property was included in the "
diff --git a/redfish-core/src/error_messages.cpp b/redfish-core/src/error_messages.cpp
index 409adb1..bebb6d8 100644
--- a/redfish-core/src/error_messages.cpp
+++ b/redfish-core/src/error_messages.cpp
@@ -514,6 +514,33 @@ void propertyValueFormatError(crow::Response& res, const std::string& arg1,
addMessageToJson(res.jsonValue, propertyValueFormatError(arg1, arg2), arg2);
}
+/**
+ * @internal
+ * @brief Formats PropertySizeExceeded message into JSON for the specified
+ * property
+ *
+ * See header file for more information
+ * @endinternal
+ */
+nlohmann::json propertySizeExceeded(const std::string& arg1)
+{
+ return nlohmann::json{
+ {"@odata.type", "#Message.v1_1_1.Message"},
+ {"MessageId", "Base.1.8.1.PropertySizeExceeded"},
+ {"Message", "The property " + arg1 +
+ " is too long. The value exceeds its size limit."},
+ {"MessageArgs", {arg1}},
+ {"MessageSeverity", "Warning"},
+ {"Resolution", "Correct the value for the property in the request body "
+ "and resubmit the request if the operation failed."}};
+}
+
+void propertySizeExceeded(crow::Response& res, const std::string& arg1)
+{
+ res.result(boost::beast::http::status::bad_request);
+ addMessageToJson(res.jsonValue, propertySizeExceeded(arg1), arg1);
+}
+
/**
* @internal
* @brief Formats PropertyValueNotInList message into JSON for the specified
--
2.25.1
|
