redfish-core/include/error_messages.hpp

18 #include <nlohmann/json.hpp>
31  * @brief Formats Success message into JSON
35  * @returns Message Success formatted to JSON */
36 nlohmann::json::object_t success();
41  * @brief Formats GeneralError message into JSON
47  * @returns Message GeneralError formatted to JSON */
48 nlohmann::json::object_t generalError();
53  * @brief Formats Created message into JSON
57  * @returns Message Created formatted to JSON */
58 nlohmann::json::object_t created();
63  * @brief Formats NoOperation message into JSON
68  * @returns Message NoOperation formatted to JSON */
69 nlohmann::json::object_t noOperation();
74  * @brief Formats PropertyDuplicate message into JSON
79  * @returns Message PropertyDuplicate formatted to JSON */
80 nlohmann::json::object_t propertyDuplicate(std::string_view arg1);
85  * @brief Formats PropertyUnknown message into JSON
91  * @returns Message PropertyUnknown formatted to JSON */
92 nlohmann::json::object_t propertyUnknown(std::string_view arg1);
97  * @brief Formats PropertyValueTypeError message into JSON
104  * @returns Message PropertyValueTypeError formatted to JSON */
105 nlohmann::json::object_t propertyValueTypeError(const nlohmann::json& arg1,
108 void propertyValueTypeError(crow::Response& res, const nlohmann::json& arg1,
112  * @brief Formats PropertyValueFormatError message into JSON
119  * @returns Message PropertyValueFormatError formatted to JSON */
120 nlohmann::json::object_t propertyValueFormatError(const nlohmann::json& arg1,
123 void propertyValueFormatError(crow::Response& res, const nlohmann::json& arg1,
127  * @brief Formats PropertyValueNotInList message into JSON
134  * @returns Message PropertyValueNotInList formatted to JSON */
135 nlohmann::json::object_t propertyValueNotInList(const nlohmann::json& arg1,
138 void propertyValueNotInList(crow::Response& res, const nlohmann::json& arg1,
142  * @brief Formats PropertyValueOutOfRange message into JSON
149  * @returns Message PropertyValueOutOfRange formatted to JSON */
150 nlohmann::json::object_t propertyValueOutOfRange(const nlohmann::json& arg1,
153 void propertyValueOutOfRange(crow::Response& res, const nlohmann::json& arg1,
157  * @brief Formats PropertyValueError message into JSON
162  * @returns Message PropertyValueError formatted to JSON */
163 nlohmann::json::object_t propertyValueError(std::string_view arg1);
168  * @brief Formats PropertyNotWritable message into JSON
174  * @returns Message PropertyNotWritable formatted to JSON */
175 nlohmann::json::object_t propertyNotWritable(std::string_view arg1);
180  * @brief Formats PropertyNotUpdated message into JSON
186  * @returns Message PropertyNotUpdated formatted to JSON */
187 nlohmann::json::object_t propertyNotUpdated(std::string_view arg1);
192  * @brief Formats PropertyMissing message into JSON
198  * @returns Message PropertyMissing formatted to JSON */
199 nlohmann::json::object_t propertyMissing(std::string_view arg1);
204  * @brief Formats MalformedJSON message into JSON
205  * Message body: "The request body submitted was malformed JSON and could not be
209  * @returns Message MalformedJSON formatted to JSON */
210 nlohmann::json::object_t malformedJSON();
215  * @brief Formats InvalidJSON message into JSON
216  * Message body: "The request body submitted is invalid JSON starting at line
221  * @returns Message InvalidJSON formatted to JSON */
222 nlohmann::json::object_t invalidJSON(std::string_view arg1);
227  * @brief Formats EmptyJSON message into JSON
228  * Message body: "The request body submitted contained an empty JSON object and
232  * @returns Message EmptyJSON formatted to JSON */
233 nlohmann::json::object_t emptyJSON();
238  * @brief Formats ActionNotSupported message into JSON
243  * @returns Message ActionNotSupported formatted to JSON */
244 nlohmann::json::object_t actionNotSupported(std::string_view arg1);
249  * @brief Formats ActionParameterMissing message into JSON
256  * @returns Message ActionParameterMissing formatted to JSON */
257 nlohmann::json::object_t actionParameterMissing(std::string_view arg1,
264  * @brief Formats ActionParameterDuplicate message into JSON
271  * @returns Message ActionParameterDuplicate formatted to JSON */
272 nlohmann::json::object_t actionParameterDuplicate(std::string_view arg1,
279  * @brief Formats ActionParameterUnknown message into JSON
286  * @returns Message ActionParameterUnknown formatted to JSON */
287 nlohmann::json::object_t actionParameterUnknown(std::string_view arg1,
294  * @brief Formats ActionParameterValueTypeError message into JSON
302  * @returns Message ActionParameterValueTypeError formatted to JSON */
303 nlohmann::json::object_t actionParameterValueTypeError(
304     const nlohmann::json& arg1, std::string_view arg2, std::string_view arg3);
307     crow::Response& res, const nlohmann::json& arg1, std::string_view arg2,
311  * @brief Formats ActionParameterValueFormatError message into JSON
319  * @returns Message ActionParameterValueFormatError formatted to JSON */
320 nlohmann::json::object_t actionParameterValueFormatError(
321     const nlohmann::json& arg1, std::string_view arg2, std::string_view arg3);
324     crow::Response& res, const nlohmann::json& arg1, std::string_view arg2,
328  * @brief Formats ActionParameterValueNotInList message into JSON
336  * @returns Message ActionParameterValueNotInList formatted to JSON */
337 nlohmann::json::object_t actionParameterValueNotInList(
345  * @brief Formats ActionParameterValueOutOfRange message into JSON
353  * @returns Message ActionParameterValueOutOfRange formatted to JSON */
354 nlohmann::json::object_t actionParameterValueOutOfRange(
362  * @brief Formats ActionParameterValueError message into JSON
369  * @returns Message ActionParameterValueError formatted to JSON */
370 nlohmann::json::object_t actionParameterValueError(const nlohmann::json& arg1,
373 void actionParameterValueError(crow::Response& res, const nlohmann::json& arg1,
377  * @brief Formats ActionParameterNotSupported message into JSON
384  * @returns Message ActionParameterNotSupported formatted to JSON */
385 nlohmann::json::object_t actionParameterNotSupported(std::string_view arg1,
392  * @brief Formats ArraySizeTooLong message into JSON
399  * @returns Message ArraySizeTooLong formatted to JSON */
400 nlohmann::json::object_t arraySizeTooLong(std::string_view arg1, uint64_t arg2);
406  * @brief Formats ArraySizeTooShort message into JSON
413  * @returns Message ArraySizeTooShort formatted to JSON */
414 nlohmann::json::object_t arraySizeTooShort(std::string_view arg1,
421  * @brief Formats QueryParameterValueTypeError message into JSON
428  * @returns Message QueryParameterValueTypeError formatted to JSON */
429 nlohmann::json::object_t queryParameterValueTypeError(
430     const nlohmann::json& arg1, std::string_view arg2);
433     crow::Response& res, const nlohmann::json& arg1, std::string_view arg2);
436  * @brief Formats QueryParameterValueFormatError message into JSON
443  * @returns Message QueryParameterValueFormatError formatted to JSON */
444 nlohmann::json::object_t queryParameterValueFormatError(
445     const nlohmann::json& arg1, std::string_view arg2);
448     crow::Response& res, const nlohmann::json& arg1, std::string_view arg2);
451  * @brief Formats QueryParameterValueError message into JSON
456  * @returns Message QueryParameterValueError formatted to JSON */
457 nlohmann::json::object_t queryParameterValueError(std::string_view arg1);
462  * @brief Formats QueryParameterOutOfRange message into JSON
470  * @returns Message QueryParameterOutOfRange formatted to JSON */
471 nlohmann::json::object_t queryParameterOutOfRange(
478  * @brief Formats QueryNotSupportedOnResource message into JSON
482  * @returns Message QueryNotSupportedOnResource formatted to JSON */
483 nlohmann::json::object_t queryNotSupportedOnResource();
488  * @brief Formats QueryNotSupportedOnOperation message into JSON
492  * @returns Message QueryNotSupportedOnOperation formatted to JSON */
493 nlohmann::json::object_t queryNotSupportedOnOperation();
498  * @brief Formats QueryNotSupported message into JSON
502  * @returns Message QueryNotSupported formatted to JSON */
503 nlohmann::json::object_t queryNotSupported();
508  * @brief Formats QueryCombinationInvalid message into JSON
513  * @returns Message QueryCombinationInvalid formatted to JSON */
514 nlohmann::json::object_t queryCombinationInvalid();
519  * @brief Formats QueryParameterUnsupported message into JSON
524  * @returns Message QueryParameterUnsupported formatted to JSON */
525 nlohmann::json::object_t queryParameterUnsupported(std::string_view arg1);
530  * @brief Formats SessionLimitExceeded message into JSON
535  * @returns Message SessionLimitExceeded formatted to JSON */
536 nlohmann::json::object_t sessionLimitExceeded();
541  * @brief Formats EventSubscriptionLimitExceeded message into JSON
546  * @returns Message EventSubscriptionLimitExceeded formatted to JSON */
547 nlohmann::json::object_t eventSubscriptionLimitExceeded();
552  * @brief Formats ResourceCannotBeDeleted message into JSON
557  * @returns Message ResourceCannotBeDeleted formatted to JSON */
558 nlohmann::json::object_t resourceCannotBeDeleted();
563  * @brief Formats ResourceInUse message into JSON
568  * @returns Message ResourceInUse formatted to JSON */
569 nlohmann::json::object_t resourceInUse();
574  * @brief Formats ResourceAlreadyExists message into JSON
582  * @returns Message ResourceAlreadyExists formatted to JSON */
583 nlohmann::json::object_t resourceAlreadyExists(
590  * @brief Formats ResourceNotFound message into JSON
597  * @returns Message ResourceNotFound formatted to JSON */
598 nlohmann::json::object_t resourceNotFound(std::string_view arg1,
605  * @brief Formats PayloadTooLarge message into JSON
610  * @returns Message PayloadTooLarge formatted to JSON */
611 nlohmann::json::object_t payloadTooLarge();
616  * @brief Formats InsufficientStorage message into JSON
621  * @returns Message InsufficientStorage formatted to JSON */
622 nlohmann::json::object_t insufficientStorage();
627  * @brief Formats MissingOrMalformedPart message into JSON
632  * @returns Message MissingOrMalformedPart formatted to JSON */
633 nlohmann::json::object_t missingOrMalformedPart();
638  * @brief Formats InvalidURI message into JSON
643  * @returns Message InvalidURI formatted to JSON */
644 nlohmann::json::object_t invalidURI(std::string_view arg1);
649  * @brief Formats CreateFailedMissingReqProperties message into JSON
655  * @returns Message CreateFailedMissingReqProperties formatted to JSON */
656 nlohmann::json::object_t createFailedMissingReqProperties(
663  * @brief Formats CreateLimitReachedForResource message into JSON
668  * @returns Message CreateLimitReachedForResource formatted to JSON */
669 nlohmann::json::object_t createLimitReachedForResource();
674  * @brief Formats ServiceShuttingDown message into JSON
679  * @returns Message ServiceShuttingDown formatted to JSON */
680 nlohmann::json::object_t serviceShuttingDown();
685  * @brief Formats ServiceInUnknownState message into JSON
690  * @returns Message ServiceInUnknownState formatted to JSON */
691 nlohmann::json::object_t serviceInUnknownState();
696  * @brief Formats NoValidSession message into JSON
701  * @returns Message NoValidSession formatted to JSON */
702 nlohmann::json::object_t noValidSession();
707  * @brief Formats InsufficientPrivilege message into JSON
713  * @returns Message InsufficientPrivilege formatted to JSON */
714 nlohmann::json::object_t insufficientPrivilege();
719  * @brief Formats AccountModified message into JSON
723  * @returns Message AccountModified formatted to JSON */
724 nlohmann::json::object_t accountModified();
729  * @brief Formats AccountNotModified message into JSON
733  * @returns Message AccountNotModified formatted to JSON */
734 nlohmann::json::object_t accountNotModified();
739  * @brief Formats AccountRemoved message into JSON
743  * @returns Message AccountRemoved formatted to JSON */
744 nlohmann::json::object_t accountRemoved();
749  * @brief Formats AccountForSessionNoLongerExists message into JSON
754  * @returns Message AccountForSessionNoLongerExists formatted to JSON */
755 nlohmann::json::object_t accountForSessionNoLongerExists();
760  * @brief Formats InvalidObject message into JSON
765  * @returns Message InvalidObject formatted to JSON */
766 nlohmann::json::object_t invalidObject(const boost::urls::url_view_base& arg1);
771  * @brief Formats InternalError message into JSON
776  * @returns Message InternalError formatted to JSON */
777 nlohmann::json::object_t internalError();
783  * @brief Formats UnrecognizedRequestBody message into JSON
788  * @returns Message UnrecognizedRequestBody formatted to JSON */
789 nlohmann::json::object_t unrecognizedRequestBody();
794  * @brief Formats ResourceMissingAtURI message into JSON
799  * @returns Message ResourceMissingAtURI formatted to JSON */
800 nlohmann::json::object_t resourceMissingAtURI(
807  * @brief Formats ResourceAtUriInUnknownFormat message into JSON
813  * @returns Message ResourceAtUriInUnknownFormat formatted to JSON */
814 nlohmann::json::object_t resourceAtUriInUnknownFormat(
821  * @brief Formats ResourceAtUriUnauthorized message into JSON
828  * @returns Message ResourceAtUriUnauthorized formatted to JSON */
829 nlohmann::json::object_t resourceAtUriUnauthorized(
837  * @brief Formats CouldNotEstablishConnection message into JSON
843  * @returns Message CouldNotEstablishConnection formatted to JSON */
844 nlohmann::json::object_t couldNotEstablishConnection(
851  * @brief Formats SourceDoesNotSupportProtocol message into JSON
858  * @returns Message SourceDoesNotSupportProtocol formatted to JSON */
859 nlohmann::json::object_t sourceDoesNotSupportProtocol(
867  * @brief Formats AccessDenied message into JSON
873  * @returns Message AccessDenied formatted to JSON */
874 nlohmann::json::object_t accessDenied(const boost::urls::url_view_base& arg1);
879  * @brief Formats ServiceTemporarilyUnavailable message into JSON
885  * @returns Message ServiceTemporarilyUnavailable formatted to JSON */
886 nlohmann::json::object_t serviceTemporarilyUnavailable(std::string_view arg1);
891  * @brief Formats InvalidIndex message into JSON
896  * @returns Message InvalidIndex formatted to JSON */
897 nlohmann::json::object_t invalidIndex(uint64_t arg1);
902  * @brief Formats PropertyValueModified message into JSON
909  * @returns Message PropertyValueModified formatted to JSON */
910 nlohmann::json::object_t propertyValueModified(std::string_view arg1,
911                                                const nlohmann::json& arg2);
914                            const nlohmann::json& arg2);
917  * @brief Formats ResourceInStandby message into JSON
922  * @returns Message ResourceInStandby formatted to JSON */
923 nlohmann::json::object_t resourceInStandby();
928  * @brief Formats ResourceExhaustion message into JSON
934  * @returns Message ResourceExhaustion formatted to JSON */
935 nlohmann::json::object_t resourceExhaustion(std::string_view arg1);
940  * @brief Formats StringValueTooLong message into JSON
946  * @returns Message StringValueTooLong formatted to JSON */
947 nlohmann::json::object_t stringValueTooLong(std::string_view arg1,
954  * @brief Formats StringValueTooShort message into JSON
961  * @returns Message StringValueTooShort formatted to JSON */
962 nlohmann::json::object_t stringValueTooShort(std::string_view arg1,
969  * @brief Formats SessionTerminated message into JSON
973  * @returns Message SessionTerminated formatted to JSON */
974 nlohmann::json::object_t sessionTerminated();
979  * @brief Formats SubscriptionTerminated message into JSON
983  * @returns Message SubscriptionTerminated formatted to JSON */
984 nlohmann::json::object_t subscriptionTerminated();
989  * @brief Formats ResourceTypeIncompatible message into JSON
996  * @returns Message ResourceTypeIncompatible formatted to JSON */
997 nlohmann::json::object_t resourceTypeIncompatible(std::string_view arg1,
1004  * @brief Formats PasswordChangeRequired message into JSON
1011  * @returns Message PasswordChangeRequired formatted to JSON */
1012 nlohmann::json::object_t passwordChangeRequired(
1019  * @brief Formats ResetRequired message into JSON
1027  * @returns Message ResetRequired formatted to JSON */
1028 nlohmann::json::object_t resetRequired(const boost::urls::url_view_base& arg1,
1035  * @brief Formats ResetRecommended message into JSON
1042  * @returns Message ResetRecommended formatted to JSON */
1043 nlohmann::json::object_t resetRecommended(std::string_view arg1,
1050  * @brief Formats ChassisPowerStateOnRequired message into JSON
1056  * @returns Message ChassisPowerStateOnRequired formatted to JSON */
1057 nlohmann::json::object_t chassisPowerStateOnRequired(std::string_view arg1);
1062  * @brief Formats ChassisPowerStateOffRequired message into JSON
1068  * @returns Message ChassisPowerStateOffRequired formatted to JSON */
1069 nlohmann::json::object_t chassisPowerStateOffRequired(std::string_view arg1);
1074  * @brief Formats PropertyValueConflict message into JSON
1081  * @returns Message PropertyValueConflict formatted to JSON */
1082 nlohmann::json::object_t propertyValueConflict(std::string_view arg1,
1089  * @brief Formats PropertyValueResourceConflict message into JSON
1098  * @returns Message PropertyValueResourceConflict formatted to JSON */
1099 nlohmann::json::object_t propertyValueResourceConflict(
1100     std::string_view arg1, const nlohmann::json& arg2,
1104                                    const nlohmann::json& arg2,
1108  * @brief Formats PropertyValueExternalConflict message into JSON
1116  * @returns Message PropertyValueExternalConflict formatted to JSON */
1117 nlohmann::json::object_t propertyValueExternalConflict(
1118     std::string_view arg1, const nlohmann::json& arg2);
1121                                    const nlohmann::json& arg2);
1124  * @brief Formats PropertyValueIncorrect message into JSON
1132  * @returns Message PropertyValueIncorrect formatted to JSON */
1133 nlohmann::json::object_t propertyValueIncorrect(std::string_view arg1,
1134                                                 const nlohmann::json& arg2);
1137                             const nlohmann::json& arg2);
1140  * @brief Formats ResourceCreationConflict message into JSON
1146  * @returns Message ResourceCreationConflict formatted to JSON */
1147 nlohmann::json::object_t resourceCreationConflict(
1154  * @brief Formats ActionParameterValueConflict message into JSON
1161  * @returns Message ActionParameterValueConflict formatted to JSON */
1162 nlohmann::json::object_t actionParameterValueConflict(std::string_view arg1,
1169  * @brief Formats MaximumErrorsExceeded message into JSON
1173  * @returns Message MaximumErrorsExceeded formatted to JSON */
1174 nlohmann::json::object_t maximumErrorsExceeded();
1179  * @brief Formats PreconditionFailed message into JSON
1184  * @returns Message PreconditionFailed formatted to JSON */
1185 nlohmann::json::object_t preconditionFailed();
1190  * @brief Formats PreconditionRequired message into JSON
1195  * @returns Message PreconditionRequired formatted to JSON */
1196 nlohmann::json::object_t preconditionRequired();
1201  * @brief Formats HeaderMissing message into JSON
1206  * @returns Message HeaderMissing formatted to JSON */
1207 nlohmann::json::object_t headerMissing(std::string_view arg1);
1212  * @brief Formats HeaderInvalid message into JSON
1217  * @returns Message HeaderInvalid formatted to JSON */
1218 nlohmann::json::object_t headerInvalid(std::string_view arg1);
1223  * @brief Formats OperationFailed message into JSON
1228  * @returns Message OperationFailed formatted to JSON */
1229 nlohmann::json::object_t operationFailed();
1234  * @brief Formats OperationTimeout message into JSON
1239  * @returns Message OperationTimeout formatted to JSON */
1240 nlohmann::json::object_t operationTimeout();
1245  * @brief Formats OperationNotAllowed message into JSON
1249  * @returns Message OperationNotAllowed formatted to JSON */
1250 nlohmann::json::object_t operationNotAllowed();
1255  * @brief Formats UndeterminedFault message into JSON
1260  * @returns Message UndeterminedFault formatted to JSON */
1261 nlohmann::json::object_t undeterminedFault(std::string_view arg1);
1266  * @brief Formats ConditionInRelatedResource message into JSON
1271  * @returns Message ConditionInRelatedResource formatted to JSON */
1272 nlohmann::json::object_t conditionInRelatedResource();
1277  * @brief Formats RestrictedRole message into JSON
1283  * @returns Message RestrictedRole formatted to JSON */
1284 nlohmann::json::object_t restrictedRole(std::string_view arg1);
1289  * @brief Formats RestrictedPrivilege message into JSON
1295  * @returns Message RestrictedPrivilege formatted to JSON */
1296 nlohmann::json::object_t restrictedPrivilege(std::string_view arg1);
1301  * @brief Formats StrictAccountTypes message into JSON
1308  * @returns Message StrictAccountTypes formatted to JSON */
1309 nlohmann::json::object_t strictAccountTypes(std::string_view arg1);
1314  * @brief Formats PropertyDeprecated message into JSON
1320  * @returns Message PropertyDeprecated formatted to JSON */
1321 nlohmann::json::object_t propertyDeprecated(std::string_view arg1);
1326  * @brief Formats ResourceDeprecated message into JSON
1331  * @returns Message ResourceDeprecated formatted to JSON */
1332 nlohmann::json::object_t resourceDeprecated(std::string_view arg1);
1337  * @brief Formats PropertyValueDeprecated message into JSON
1343  * @returns Message PropertyValueDeprecated formatted to JSON */
1344 nlohmann::json::object_t propertyValueDeprecated(std::string_view arg1,
1351  * @brief Formats ActionDeprecated message into JSON
1356  * @returns Message ActionDeprecated formatted to JSON */
1357 nlohmann::json::object_t actionDeprecated(std::string_view arg1);
1362  * @brief Formats NetworkNameResolutionNotConfigured message into JSON
1366  * @returns Message NetworkNameResolutionNotConfigured formatted to JSON */
1367 nlohmann::json::object_t networkNameResolutionNotConfigured();
1372  * @brief Formats NetworkNameResolutionNotSupported message into JSON
1377  * @returns Message NetworkNameResolutionNotSupported formatted to JSON */
1378 nlohmann::json::object_t networkNameResolutionNotSupported();
1383  * @brief Formats ServiceDisabled message into JSON
1389  * @returns Message ServiceDisabled formatted to JSON */
1390 nlohmann::json::object_t serviceDisabled(std::string_view arg1);
1395  * @brief Formats EventBufferExceeded message into JSON
1400  * @returns Message EventBufferExceeded formatted to JSON */
1401 nlohmann::json::object_t eventBufferExceeded();
1406  * @brief Formats AuthenticationTokenRequired message into JSON
1411  * @returns Message AuthenticationTokenRequired formatted to JSON */
1412 nlohmann::json::object_t authenticationTokenRequired();
1417  * @brief Formats OneTimePasscodeSent message into JSON
1423  * @returns Message OneTimePasscodeSent formatted to JSON */
1424 nlohmann::json::object_t oneTimePasscodeSent(std::string_view arg1);
1429  * @brief Formats LicenseRequired message into JSON
1434  * @returns Message LicenseRequired formatted to JSON */
1435 nlohmann::json::object_t licenseRequired(std::string_view arg1);
1440  * @brief Formats PropertyModified message into JSON
1444  * @returns Message PropertyModified formatted to JSON */
1445 nlohmann::json::object_t propertyModified();
1450  * @brief Formats GenerateSecretKeyRequired message into JSON
1458  * @returns Message GenerateSecretKeyRequired formatted to JSON */
1459 nlohmann::json::object_t generateSecretKeyRequired(