#pragma once /**************************************************************** * READ THIS WARNING FIRST * This is an auto-generated header which contains definitions * for Redfish DMTF defined messages. * DO NOT modify this registry outside of running the * parse_registries.py script. The definitions contained within * this file are owned by DMTF. Any modifications to these files * should be first pushed to the relevant registry in the DMTF * github organization. ***************************************************************/ #include "http_response.hpp" #include #include #include #include #include #include // IWYU pragma: no_forward_declare crow::Response namespace redfish { namespace messages { constexpr const char* messageVersionPrefix = "Base.1.19.0."; constexpr const char* messageAnnotation = "@Message.ExtendedInfo"; /** * @brief Moves all error messages from the |source| JSON to |target| */ void moveErrorsToErrorJson(nlohmann::json& target, nlohmann::json& source); /** * @brief Formats Success message into JSON * Message body: "The request completed successfully." * * * @returns Message Success formatted to JSON */ nlohmann::json success(); void success(crow::Response& res); /** * @brief Formats GeneralError message into JSON * Message body: "A general error has occurred. See Resolution for information * on how to resolve the error, or @Message.ExtendedInfo if Resolution is not * provided." * * * @returns Message GeneralError formatted to JSON */ nlohmann::json generalError(); void generalError(crow::Response& res); /** * @brief Formats Created message into JSON * Message body: "The resource was created successfully." * * * @returns Message Created formatted to JSON */ nlohmann::json created(); void created(crow::Response& res); /** * @brief Formats NoOperation message into JSON * Message body: "The request body submitted contain no data to act upon and no * changes to the resource took place." * * * @returns Message NoOperation formatted to JSON */ nlohmann::json noOperation(); void noOperation(crow::Response& res); /** * @brief Formats PropertyDuplicate message into JSON * Message body: "The property was duplicated in the request." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message PropertyDuplicate formatted to JSON */ nlohmann::json propertyDuplicate(std::string_view arg1); void propertyDuplicate(crow::Response& res, std::string_view arg1); /** * @brief Formats PropertyUnknown message into JSON * Message body: "The property is not in the list of valid properties for * the resource." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message PropertyUnknown formatted to JSON */ nlohmann::json propertyUnknown(std::string_view arg1); void propertyUnknown(crow::Response& res, std::string_view arg1); /** * @brief Formats PropertyValueTypeError message into JSON * Message body: "The value for the property is not a type that * the property can accept." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message PropertyValueTypeError formatted to JSON */ nlohmann::json propertyValueTypeError(const nlohmann::json& arg1, std::string_view arg2); void propertyValueTypeError(crow::Response& res, const nlohmann::json& arg1, std::string_view arg2); /** * @brief Formats PropertyValueFormatError message into JSON * Message body: "The value for the property is not a format that * the property can accept." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message PropertyValueFormatError formatted to JSON */ nlohmann::json propertyValueFormatError(const nlohmann::json& arg1, std::string_view arg2); void propertyValueFormatError(crow::Response& res, const nlohmann::json& arg1, std::string_view arg2); /** * @brief Formats PropertyValueNotInList message into JSON * Message body: "The value for the property is not in the list of * acceptable values." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message PropertyValueNotInList formatted to JSON */ nlohmann::json propertyValueNotInList(const nlohmann::json& arg1, std::string_view arg2); void propertyValueNotInList(crow::Response& res, const nlohmann::json& arg1, std::string_view arg2); /** * @brief Formats PropertyValueOutOfRange message into JSON * Message body: "The value for the property is not in the * supported range of acceptable values." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message PropertyValueOutOfRange formatted to JSON */ nlohmann::json propertyValueOutOfRange(const nlohmann::json& arg1, std::string_view arg2); void propertyValueOutOfRange(crow::Response& res, const nlohmann::json& arg1, std::string_view arg2); /** * @brief Formats PropertyValueError message into JSON * Message body: "The value provided for the property is not valid." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message PropertyValueError formatted to JSON */ nlohmann::json propertyValueError(std::string_view arg1); void propertyValueError(crow::Response& res, std::string_view arg1); /** * @brief Formats PropertyNotWritable message into JSON * Message body: "The property is a read-only property and cannot be * assigned a value." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message PropertyNotWritable formatted to JSON */ nlohmann::json propertyNotWritable(std::string_view arg1); void propertyNotWritable(crow::Response& res, std::string_view arg1); /** * @brief Formats PropertyNotUpdated message into JSON * Message body: "The property was not updated due to an internal service * error. The service is still operational." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message PropertyNotUpdated formatted to JSON */ nlohmann::json propertyNotUpdated(std::string_view arg1); void propertyNotUpdated(crow::Response& res, std::string_view arg1); /** * @brief Formats PropertyMissing message into JSON * Message body: "The property is a required property and must be * included in the request." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message PropertyMissing formatted to JSON */ nlohmann::json propertyMissing(std::string_view arg1); void propertyMissing(crow::Response& res, std::string_view arg1); /** * @brief Formats MalformedJSON message into JSON * Message body: "The request body submitted was malformed JSON and could not be * parsed by the receiving service." * * * @returns Message MalformedJSON formatted to JSON */ nlohmann::json malformedJSON(); void malformedJSON(crow::Response& res); /** * @brief Formats InvalidJSON message into JSON * Message body: "The request body submitted is invalid JSON starting at line * and could not be parsed by the receiving service." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message InvalidJSON formatted to JSON */ nlohmann::json invalidJSON(std::string_view arg1); void invalidJSON(crow::Response& res, std::string_view arg1); /** * @brief Formats EmptyJSON message into JSON * Message body: "The request body submitted contained an empty JSON object and * the service is unable to process it." * * * @returns Message EmptyJSON formatted to JSON */ nlohmann::json emptyJSON(); void emptyJSON(crow::Response& res); /** * @brief Formats ActionNotSupported message into JSON * Message body: "The action is not supported by the resource." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ActionNotSupported formatted to JSON */ nlohmann::json actionNotSupported(std::string_view arg1); void actionNotSupported(crow::Response& res, std::string_view arg1); /** * @brief Formats ActionParameterMissing message into JSON * Message body: "The action requires the parameter to be present * in the request body." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ActionParameterMissing formatted to JSON */ nlohmann::json actionParameterMissing(std::string_view arg1, std::string_view arg2); void actionParameterMissing(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats ActionParameterDuplicate message into JSON * Message body: "The action was submitted with more than one value for * the parameter ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ActionParameterDuplicate formatted to JSON */ nlohmann::json actionParameterDuplicate(std::string_view arg1, std::string_view arg2); void actionParameterDuplicate(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats ActionParameterUnknown message into JSON * Message body: "The action was submitted with the invalid parameter * ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ActionParameterUnknown formatted to JSON */ nlohmann::json actionParameterUnknown(std::string_view arg1, std::string_view arg2); void actionParameterUnknown(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats ActionParameterValueTypeError message into JSON * Message body: "The value for the parameter in the action * is not a type that the parameter can accept." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * @param[in] arg3 Parameter of message that will replace %3 in its body. * * @returns Message ActionParameterValueTypeError formatted to JSON */ nlohmann::json actionParameterValueTypeError( const nlohmann::json& arg1, std::string_view arg2, std::string_view arg3); void actionParameterValueTypeError( crow::Response& res, const nlohmann::json& arg1, std::string_view arg2, std::string_view arg3); /** * @brief Formats ActionParameterValueFormatError message into JSON * Message body: "The value for the parameter in the action * is not a format that the parameter can accept." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * @param[in] arg3 Parameter of message that will replace %3 in its body. * * @returns Message ActionParameterValueFormatError formatted to JSON */ nlohmann::json actionParameterValueFormatError( const nlohmann::json& arg1, std::string_view arg2, std::string_view arg3); void actionParameterValueFormatError( crow::Response& res, const nlohmann::json& arg1, std::string_view arg2, std::string_view arg3); /** * @brief Formats ActionParameterValueNotInList message into JSON * Message body: "The value for the parameter in the action * is not in the list of acceptable values." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * @param[in] arg3 Parameter of message that will replace %3 in its body. * * @returns Message ActionParameterValueNotInList formatted to JSON */ nlohmann::json actionParameterValueNotInList( std::string_view arg1, std::string_view arg2, std::string_view arg3); void actionParameterValueNotInList(crow::Response& res, std::string_view arg1, std::string_view arg2, std::string_view arg3); /** * @brief Formats ActionParameterValueOutOfRange message into JSON * Message body: "The value for the parameter in the action * is not in the supported range of acceptable values." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * @param[in] arg3 Parameter of message that will replace %3 in its body. * * @returns Message ActionParameterValueOutOfRange formatted to JSON */ nlohmann::json actionParameterValueOutOfRange( std::string_view arg1, std::string_view arg2, std::string_view arg3); void actionParameterValueOutOfRange(crow::Response& res, std::string_view arg1, std::string_view arg2, std::string_view arg3); /** * @brief Formats ActionParameterValueError message into JSON * Message body: "The value for the parameter in the action is * invalid." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ActionParameterValueError formatted to JSON */ nlohmann::json actionParameterValueError(const nlohmann::json& arg1, std::string_view arg2); void actionParameterValueError(crow::Response& res, const nlohmann::json& arg1, std::string_view arg2); /** * @brief Formats ActionParameterNotSupported message into JSON * Message body: "The parameter for the action is not supported on * the target resource." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ActionParameterNotSupported formatted to JSON */ nlohmann::json actionParameterNotSupported(std::string_view arg1, std::string_view arg2); void actionParameterNotSupported(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats ArraySizeTooLong message into JSON * Message body: "The array provided for property exceeds the size limit * ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ArraySizeTooLong formatted to JSON */ nlohmann::json arraySizeTooLong(std::string_view arg1, uint64_t arg2); void arraySizeTooLong(crow::Response& res, std::string_view arg1, uint64_t arg2); /** * @brief Formats ArraySizeTooShort message into JSON * Message body: "The array provided for property is under the minimum * size limit ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ArraySizeTooShort formatted to JSON */ nlohmann::json arraySizeTooShort(std::string_view arg1, std::string_view arg2); void arraySizeTooShort(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats QueryParameterValueTypeError message into JSON * Message body: "The value for the query parameter is not a type * that the parameter can accept." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message QueryParameterValueTypeError formatted to JSON */ nlohmann::json queryParameterValueTypeError(const nlohmann::json& arg1, std::string_view arg2); void queryParameterValueTypeError( crow::Response& res, const nlohmann::json& arg1, std::string_view arg2); /** * @brief Formats QueryParameterValueFormatError message into JSON * Message body: "The value for the parameter is not a format that * the parameter can accept." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message QueryParameterValueFormatError formatted to JSON */ nlohmann::json queryParameterValueFormatError(const nlohmann::json& arg1, std::string_view arg2); void queryParameterValueFormatError( crow::Response& res, const nlohmann::json& arg1, std::string_view arg2); /** * @brief Formats QueryParameterValueError message into JSON * Message body: "The value for the parameter is invalid." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message QueryParameterValueError formatted to JSON */ nlohmann::json queryParameterValueError(std::string_view arg1); void queryParameterValueError(crow::Response& res, std::string_view arg1); /** * @brief Formats QueryParameterOutOfRange message into JSON * Message body: "The value for the query parameter is out of * range ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * @param[in] arg3 Parameter of message that will replace %3 in its body. * * @returns Message QueryParameterOutOfRange formatted to JSON */ nlohmann::json queryParameterOutOfRange( std::string_view arg1, std::string_view arg2, std::string_view arg3); void queryParameterOutOfRange(crow::Response& res, std::string_view arg1, std::string_view arg2, std::string_view arg3); /** * @brief Formats QueryNotSupportedOnResource message into JSON * Message body: "Querying is not supported on the requested resource." * * * @returns Message QueryNotSupportedOnResource formatted to JSON */ nlohmann::json queryNotSupportedOnResource(); void queryNotSupportedOnResource(crow::Response& res); /** * @brief Formats QueryNotSupportedOnOperation message into JSON * Message body: "Querying is not supported with the requested operation." * * * @returns Message QueryNotSupportedOnOperation formatted to JSON */ nlohmann::json queryNotSupportedOnOperation(); void queryNotSupportedOnOperation(crow::Response& res); /** * @brief Formats QueryNotSupported message into JSON * Message body: "Querying is not supported by the implementation." * * * @returns Message QueryNotSupported formatted to JSON */ nlohmann::json queryNotSupported(); void queryNotSupported(crow::Response& res); /** * @brief Formats QueryCombinationInvalid message into JSON * Message body: "Two or more query parameters in the request cannot be used * together." * * * @returns Message QueryCombinationInvalid formatted to JSON */ nlohmann::json queryCombinationInvalid(); void queryCombinationInvalid(crow::Response& res); /** * @brief Formats QueryParameterUnsupported message into JSON * Message body: "Query parameter is not supported." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message QueryParameterUnsupported formatted to JSON */ nlohmann::json queryParameterUnsupported(std::string_view arg1); void queryParameterUnsupported(crow::Response& res, std::string_view arg1); /** * @brief Formats SessionLimitExceeded message into JSON * Message body: "The session establishment failed due to the number of * simultaneous sessions exceeding the limit of the implementation." * * * @returns Message SessionLimitExceeded formatted to JSON */ nlohmann::json sessionLimitExceeded(); void sessionLimitExceeded(crow::Response& res); /** * @brief Formats EventSubscriptionLimitExceeded message into JSON * Message body: "The event subscription failed due to the number of * simultaneous subscriptions exceeding the limit of the implementation." * * * @returns Message EventSubscriptionLimitExceeded formatted to JSON */ nlohmann::json eventSubscriptionLimitExceeded(); void eventSubscriptionLimitExceeded(crow::Response& res); /** * @brief Formats ResourceCannotBeDeleted message into JSON * Message body: "The delete request failed because the resource requested * cannot be deleted." * * * @returns Message ResourceCannotBeDeleted formatted to JSON */ nlohmann::json resourceCannotBeDeleted(); void resourceCannotBeDeleted(crow::Response& res); /** * @brief Formats ResourceInUse message into JSON * Message body: "The change to the requested resource failed because the * resource is in use or in transition." * * * @returns Message ResourceInUse formatted to JSON */ nlohmann::json resourceInUse(); void resourceInUse(crow::Response& res); /** * @brief Formats ResourceAlreadyExists message into JSON * Message body: "The requested resource of type with the property * with the value already exists." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * @param[in] arg3 Parameter of message that will replace %3 in its body. * * @returns Message ResourceAlreadyExists formatted to JSON */ nlohmann::json resourceAlreadyExists( std::string_view arg1, std::string_view arg2, std::string_view arg3); void resourceAlreadyExists(crow::Response& res, std::string_view arg1, std::string_view arg2, std::string_view arg3); /** * @brief Formats ResourceNotFound message into JSON * Message body: "The requested resource of type named was not * found." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ResourceNotFound formatted to JSON */ nlohmann::json resourceNotFound(std::string_view arg1, std::string_view arg2); void resourceNotFound(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats PayloadTooLarge message into JSON * Message body: "The supplied payload exceeds the maximum size supported by the * service." * * * @returns Message PayloadTooLarge formatted to JSON */ nlohmann::json payloadTooLarge(); void payloadTooLarge(crow::Response& res); /** * @brief Formats InsufficientStorage message into JSON * Message body: "Insufficient storage or memory available to complete the * request." * * * @returns Message InsufficientStorage formatted to JSON */ nlohmann::json insufficientStorage(); void insufficientStorage(crow::Response& res); /** * @brief Formats MissingOrMalformedPart message into JSON * Message body: "The multipart request contains malformed parts or is missing * required parts." * * * @returns Message MissingOrMalformedPart formatted to JSON */ nlohmann::json missingOrMalformedPart(); void missingOrMalformedPart(crow::Response& res); /** * @brief Formats InvalidURI message into JSON * Message body: "The URI was not found." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message InvalidURI formatted to JSON */ nlohmann::json invalidURI(std::string_view arg1); void invalidURI(crow::Response& res, std::string_view arg1); /** * @brief Formats CreateFailedMissingReqProperties message into JSON * Message body: "The create operation failed because the required property * was missing from the request." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message CreateFailedMissingReqProperties formatted to JSON */ nlohmann::json createFailedMissingReqProperties(std::string_view arg1); void createFailedMissingReqProperties(crow::Response& res, std::string_view arg1); /** * @brief Formats CreateLimitReachedForResource message into JSON * Message body: "The create operation failed because the resource has reached * the limit of possible resources." * * * @returns Message CreateLimitReachedForResource formatted to JSON */ nlohmann::json createLimitReachedForResource(); void createLimitReachedForResource(crow::Response& res); /** * @brief Formats ServiceShuttingDown message into JSON * Message body: "The operation failed because the service is shutting down and * can no longer take incoming requests." * * * @returns Message ServiceShuttingDown formatted to JSON */ nlohmann::json serviceShuttingDown(); void serviceShuttingDown(crow::Response& res); /** * @brief Formats ServiceInUnknownState message into JSON * Message body: "The operation failed because the service is in an unknown * state and can no longer take incoming requests." * * * @returns Message ServiceInUnknownState formatted to JSON */ nlohmann::json serviceInUnknownState(); void serviceInUnknownState(crow::Response& res); /** * @brief Formats NoValidSession message into JSON * Message body: "There is no valid session established with the * implementation." * * * @returns Message NoValidSession formatted to JSON */ nlohmann::json noValidSession(); void noValidSession(crow::Response& res); /** * @brief Formats InsufficientPrivilege message into JSON * Message body: "There are insufficient privileges for the account or * credentials associated with the current session to perform the requested * operation." * * * @returns Message InsufficientPrivilege formatted to JSON */ nlohmann::json insufficientPrivilege(); void insufficientPrivilege(crow::Response& res); /** * @brief Formats AccountModified message into JSON * Message body: "The account was successfully modified." * * * @returns Message AccountModified formatted to JSON */ nlohmann::json accountModified(); void accountModified(crow::Response& res); /** * @brief Formats AccountNotModified message into JSON * Message body: "The account modification request failed." * * * @returns Message AccountNotModified formatted to JSON */ nlohmann::json accountNotModified(); void accountNotModified(crow::Response& res); /** * @brief Formats AccountRemoved message into JSON * Message body: "The account was successfully removed." * * * @returns Message AccountRemoved formatted to JSON */ nlohmann::json accountRemoved(); void accountRemoved(crow::Response& res); /** * @brief Formats AccountForSessionNoLongerExists message into JSON * Message body: "The account for the current session was removed, and so the * current session was removed as well." * * * @returns Message AccountForSessionNoLongerExists formatted to JSON */ nlohmann::json accountForSessionNoLongerExists(); void accountForSessionNoLongerExists(crow::Response& res); /** * @brief Formats InvalidObject message into JSON * Message body: "The object at is invalid." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message InvalidObject formatted to JSON */ nlohmann::json invalidObject(const boost::urls::url_view_base& arg1); void invalidObject(crow::Response& res, const boost::urls::url_view_base& arg1); /** * @brief Formats InternalError message into JSON * Message body: "The request failed due to an internal service error. The * service is still operational." * * * @returns Message InternalError formatted to JSON */ nlohmann::json internalError(); void internalError(crow::Response& res, std::source_location location = std::source_location::current()); /** * @brief Formats UnrecognizedRequestBody message into JSON * Message body: "The service detected a malformed request body that it was * unable to interpret." * * * @returns Message UnrecognizedRequestBody formatted to JSON */ nlohmann::json unrecognizedRequestBody(); void unrecognizedRequestBody(crow::Response& res); /** * @brief Formats ResourceMissingAtURI message into JSON * Message body: "The resource at the URI was not found." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ResourceMissingAtURI formatted to JSON */ nlohmann::json resourceMissingAtURI(const boost::urls::url_view_base& arg1); void resourceMissingAtURI(crow::Response& res, const boost::urls::url_view_base& arg1); /** * @brief Formats ResourceAtUriInUnknownFormat message into JSON * Message body: "The resource at is in a format not recognized by the * service." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ResourceAtUriInUnknownFormat formatted to JSON */ nlohmann::json resourceAtUriInUnknownFormat(const boost::urls::url_view_base& arg1); void resourceAtUriInUnknownFormat(crow::Response& res, const boost::urls::url_view_base& arg1); /** * @brief Formats ResourceAtUriUnauthorized message into JSON * Message body: "While accessing the resource at , the service received * an authorization error ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ResourceAtUriUnauthorized formatted to JSON */ nlohmann::json resourceAtUriUnauthorized(const boost::urls::url_view_base& arg1, std::string_view arg2); void resourceAtUriUnauthorized(crow::Response& res, const boost::urls::url_view_base& arg1, std::string_view arg2); /** * @brief Formats CouldNotEstablishConnection message into JSON * Message body: "The service failed to establish a connection with the URI * ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message CouldNotEstablishConnection formatted to JSON */ nlohmann::json couldNotEstablishConnection(const boost::urls::url_view_base& arg1); void couldNotEstablishConnection(crow::Response& res, const boost::urls::url_view_base& arg1); /** * @brief Formats SourceDoesNotSupportProtocol message into JSON * Message body: "The other end of the connection at does not support the * specified protocol ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message SourceDoesNotSupportProtocol formatted to JSON */ nlohmann::json sourceDoesNotSupportProtocol( const boost::urls::url_view_base& arg1, std::string_view arg2); void sourceDoesNotSupportProtocol(crow::Response& res, const boost::urls::url_view_base& arg1, std::string_view arg2); /** * @brief Formats AccessDenied message into JSON * Message body: "While attempting to establish a connection to , the * service denied access." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message AccessDenied formatted to JSON */ nlohmann::json accessDenied(const boost::urls::url_view_base& arg1); void accessDenied(crow::Response& res, const boost::urls::url_view_base& arg1); /** * @brief Formats ServiceTemporarilyUnavailable message into JSON * Message body: "The service is temporarily unavailable. Retry in * seconds." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ServiceTemporarilyUnavailable formatted to JSON */ nlohmann::json serviceTemporarilyUnavailable(std::string_view arg1); void serviceTemporarilyUnavailable(crow::Response& res, std::string_view arg1); /** * @brief Formats InvalidIndex message into JSON * Message body: "The index is not a valid offset into the array." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message InvalidIndex formatted to JSON */ nlohmann::json invalidIndex(uint64_t arg1); void invalidIndex(crow::Response& res, uint64_t arg1); /** * @brief Formats PropertyValueModified message into JSON * Message body: "The property was assigned the value due to * modification by the service." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message PropertyValueModified formatted to JSON */ nlohmann::json propertyValueModified(std::string_view arg1, const nlohmann::json& arg2); void propertyValueModified(crow::Response& res, std::string_view arg1, const nlohmann::json& arg2); /** * @brief Formats ResourceInStandby message into JSON * Message body: "The request could not be performed because the resource is in * standby." * * * @returns Message ResourceInStandby formatted to JSON */ nlohmann::json resourceInStandby(); void resourceInStandby(crow::Response& res); /** * @brief Formats ResourceExhaustion message into JSON * Message body: "The resource was unable to satisfy the request due to * unavailability of resources." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ResourceExhaustion formatted to JSON */ nlohmann::json resourceExhaustion(std::string_view arg1); void resourceExhaustion(crow::Response& res, std::string_view arg1); /** * @brief Formats StringValueTooLong message into JSON * Message body: "The string exceeds the length limit ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message StringValueTooLong formatted to JSON */ nlohmann::json stringValueTooLong(std::string_view arg1, uint64_t arg2); void stringValueTooLong(crow::Response& res, std::string_view arg1, uint64_t arg2); /** * @brief Formats StringValueTooShort message into JSON * Message body: "The string was under the minimum required length * ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message StringValueTooShort formatted to JSON */ nlohmann::json stringValueTooShort(std::string_view arg1, std::string_view arg2); void stringValueTooShort(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats SessionTerminated message into JSON * Message body: "The session was successfully terminated." * * * @returns Message SessionTerminated formatted to JSON */ nlohmann::json sessionTerminated(); void sessionTerminated(crow::Response& res); /** * @brief Formats SubscriptionTerminated message into JSON * Message body: "The event subscription was terminated." * * * @returns Message SubscriptionTerminated formatted to JSON */ nlohmann::json subscriptionTerminated(); void subscriptionTerminated(crow::Response& res); /** * @brief Formats ResourceTypeIncompatible message into JSON * Message body: "The @odata.type of the request body is incompatible * with the @odata.type of the resource, which is ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ResourceTypeIncompatible formatted to JSON */ nlohmann::json resourceTypeIncompatible(std::string_view arg1, std::string_view arg2); void resourceTypeIncompatible(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats PasswordChangeRequired message into JSON * Message body: "The password provided for this account must be changed before * access is granted. PATCH the Password property for this account located at * the target URI to complete this process." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message PasswordChangeRequired formatted to JSON */ nlohmann::json passwordChangeRequired(const boost::urls::url_view_base& arg1); void passwordChangeRequired(crow::Response& res, const boost::urls::url_view_base& arg1); /** * @brief Formats ResetRequired message into JSON * Message body: "In order to apply changes, recover from errors, or complete * the operation, a component reset is required with the Reset action URI * and ResetType ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ResetRequired formatted to JSON */ nlohmann::json resetRequired(const boost::urls::url_view_base& arg1, std::string_view arg2); void resetRequired(crow::Response& res, const boost::urls::url_view_base& arg1, std::string_view arg2); /** * @brief Formats ResetRecommended message into JSON * Message body: "In order to recover from errors, a component reset is * recommended with the Reset action URI and ResetType ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ResetRecommended formatted to JSON */ nlohmann::json resetRecommended(std::string_view arg1, std::string_view arg2); void resetRecommended(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats ChassisPowerStateOnRequired message into JSON * Message body: "The chassis with Id is required to be powered on to * perform this request." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ChassisPowerStateOnRequired formatted to JSON */ nlohmann::json chassisPowerStateOnRequired(std::string_view arg1); void chassisPowerStateOnRequired(crow::Response& res, std::string_view arg1); /** * @brief Formats ChassisPowerStateOffRequired message into JSON * Message body: "The chassis with Id is required to be powered off to * perform this request." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ChassisPowerStateOffRequired formatted to JSON */ nlohmann::json chassisPowerStateOffRequired(std::string_view arg1); void chassisPowerStateOffRequired(crow::Response& res, std::string_view arg1); /** * @brief Formats PropertyValueConflict message into JSON * Message body: "The property could not be written because its value * would conflict with the value of the property." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message PropertyValueConflict formatted to JSON */ nlohmann::json propertyValueConflict(std::string_view arg1, std::string_view arg2); void propertyValueConflict(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats PropertyValueResourceConflict message into JSON * Message body: "The property with the requested value of could * not be written because the value conflicts with the state or configuration of * the resource at ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * @param[in] arg3 Parameter of message that will replace %3 in its body. * * @returns Message PropertyValueResourceConflict formatted to JSON */ nlohmann::json propertyValueResourceConflict( std::string_view arg1, const nlohmann::json& arg2, const boost::urls::url_view_base& arg3); void propertyValueResourceConflict(crow::Response& res, std::string_view arg1, const nlohmann::json& arg2, const boost::urls::url_view_base& arg3); /** * @brief Formats PropertyValueExternalConflict message into JSON * Message body: "The property with the requested value of could * not be written because the value is not available due to a configuration * conflict." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message PropertyValueExternalConflict formatted to JSON */ nlohmann::json propertyValueExternalConflict(std::string_view arg1, const nlohmann::json& arg2); void propertyValueExternalConflict(crow::Response& res, std::string_view arg1, const nlohmann::json& arg2); /** * @brief Formats PropertyValueIncorrect message into JSON * Message body: "The property with the requested value of could * not be written because the value does not meet the constraints of the * implementation." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message PropertyValueIncorrect formatted to JSON */ nlohmann::json propertyValueIncorrect(std::string_view arg1, const nlohmann::json& arg2); void propertyValueIncorrect(crow::Response& res, std::string_view arg1, const nlohmann::json& arg2); /** * @brief Formats ResourceCreationConflict message into JSON * Message body: "The resource could not be created. The service has a resource * at URI that conflicts with the creation request." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ResourceCreationConflict formatted to JSON */ nlohmann::json resourceCreationConflict(const boost::urls::url_view_base& arg1); void resourceCreationConflict(crow::Response& res, const boost::urls::url_view_base& arg1); /** * @brief Formats ActionParameterValueConflict message into JSON * Message body: "The parameter with the requested value of does * not meet the constraints of the implementation." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message ActionParameterValueConflict formatted to JSON */ nlohmann::json actionParameterValueConflict(std::string_view arg1, std::string_view arg2); void actionParameterValueConflict(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats MaximumErrorsExceeded message into JSON * Message body: "Too many errors have occurred to report them all." * * * @returns Message MaximumErrorsExceeded formatted to JSON */ nlohmann::json maximumErrorsExceeded(); void maximumErrorsExceeded(crow::Response& res); /** * @brief Formats PreconditionFailed message into JSON * Message body: "The ETag supplied did not match the ETag required to change * this resource." * * * @returns Message PreconditionFailed formatted to JSON */ nlohmann::json preconditionFailed(); void preconditionFailed(crow::Response& res); /** * @brief Formats PreconditionRequired message into JSON * Message body: "A precondition header or annotation is required to change this * resource." * * * @returns Message PreconditionRequired formatted to JSON */ nlohmann::json preconditionRequired(); void preconditionRequired(crow::Response& res); /** * @brief Formats HeaderMissing message into JSON * Message body: "Required header is missing in the request." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message HeaderMissing formatted to JSON */ nlohmann::json headerMissing(std::string_view arg1); void headerMissing(crow::Response& res, std::string_view arg1); /** * @brief Formats HeaderInvalid message into JSON * Message body: "Header is invalid." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message HeaderInvalid formatted to JSON */ nlohmann::json headerInvalid(std::string_view arg1); void headerInvalid(crow::Response& res, std::string_view arg1); /** * @brief Formats OperationFailed message into JSON * Message body: "An error occurred internal to the service as part of the * overall request. Partial results may have been returned." * * * @returns Message OperationFailed formatted to JSON */ nlohmann::json operationFailed(); void operationFailed(crow::Response& res); /** * @brief Formats OperationTimeout message into JSON * Message body: "A timeout internal to the service occurred as part of the * request. Partial results may have been returned." * * * @returns Message OperationTimeout formatted to JSON */ nlohmann::json operationTimeout(); void operationTimeout(crow::Response& res); /** * @brief Formats OperationNotAllowed message into JSON * Message body: "The HTTP method is not allowed on this resource." * * * @returns Message OperationNotAllowed formatted to JSON */ nlohmann::json operationNotAllowed(); void operationNotAllowed(crow::Response& res); /** * @brief Formats UndeterminedFault message into JSON * Message body: "An undetermined fault condition was reported by ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message UndeterminedFault formatted to JSON */ nlohmann::json undeterminedFault(std::string_view arg1); void undeterminedFault(crow::Response& res, std::string_view arg1); /** * @brief Formats ConditionInRelatedResource message into JSON * Message body: "One or more conditions exist in a related resource. See the * OriginOfCondition property." * * * @returns Message ConditionInRelatedResource formatted to JSON */ nlohmann::json conditionInRelatedResource(); void conditionInRelatedResource(crow::Response& res); /** * @brief Formats RestrictedRole message into JSON * Message body: "The operation was not successful because the role is * restricted." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message RestrictedRole formatted to JSON */ nlohmann::json restrictedRole(std::string_view arg1); void restrictedRole(crow::Response& res, std::string_view arg1); /** * @brief Formats RestrictedPrivilege message into JSON * Message body: "The operation was not successful because the privilege * is restricted." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message RestrictedPrivilege formatted to JSON */ nlohmann::json restrictedPrivilege(std::string_view arg1); void restrictedPrivilege(crow::Response& res, std::string_view arg1); /** * @brief Formats StrictAccountTypes message into JSON * Message body: "The request could not be fulfilled with the account types * included in property because the property StrictAccountTypes is set to * true." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message StrictAccountTypes formatted to JSON */ nlohmann::json strictAccountTypes(std::string_view arg1); void strictAccountTypes(crow::Response& res, std::string_view arg1); /** * @brief Formats PropertyDeprecated message into JSON * Message body: "The deprecated property was included in the request * body." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message PropertyDeprecated formatted to JSON */ nlohmann::json propertyDeprecated(std::string_view arg1); void propertyDeprecated(crow::Response& res, std::string_view arg1); /** * @brief Formats ResourceDeprecated message into JSON * Message body: "The operation was performed on a deprecated resource ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ResourceDeprecated formatted to JSON */ nlohmann::json resourceDeprecated(std::string_view arg1); void resourceDeprecated(crow::Response& res, std::string_view arg1); /** * @brief Formats PropertyValueDeprecated message into JSON * Message body: "The value for the property is deprecated." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * @param[in] arg2 Parameter of message that will replace %2 in its body. * * @returns Message PropertyValueDeprecated formatted to JSON */ nlohmann::json propertyValueDeprecated(std::string_view arg1, std::string_view arg2); void propertyValueDeprecated(crow::Response& res, std::string_view arg1, std::string_view arg2); /** * @brief Formats ActionDeprecated message into JSON * Message body: "The action is deprecated." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ActionDeprecated formatted to JSON */ nlohmann::json actionDeprecated(std::string_view arg1); void actionDeprecated(crow::Response& res, std::string_view arg1); /** * @brief Formats NetworkNameResolutionNotConfigured message into JSON * Message body: "Network name resolution is not configured on this service." * * * @returns Message NetworkNameResolutionNotConfigured formatted to JSON */ nlohmann::json networkNameResolutionNotConfigured(); void networkNameResolutionNotConfigured(crow::Response& res); /** * @brief Formats NetworkNameResolutionNotSupported message into JSON * Message body: "Resolution of network-based names is not supported by this * service." * * * @returns Message NetworkNameResolutionNotSupported formatted to JSON */ nlohmann::json networkNameResolutionNotSupported(); void networkNameResolutionNotSupported(crow::Response& res); /** * @brief Formats ServiceDisabled message into JSON * Message body: "The operation failed because the service at is disabled * and cannot accept requests." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message ServiceDisabled formatted to JSON */ nlohmann::json serviceDisabled(std::string_view arg1); void serviceDisabled(crow::Response& res, std::string_view arg1); /** * @brief Formats EventBufferExceeded message into JSON * Message body: "Undelivered events may have been lost due to exceeding the * event buffer." * * * @returns Message EventBufferExceeded formatted to JSON */ nlohmann::json eventBufferExceeded(); void eventBufferExceeded(crow::Response& res); /** * @brief Formats AuthenticationTokenRequired message into JSON * Message body: "The request could not be performed because an authentication * token was not provided." * * * @returns Message AuthenticationTokenRequired formatted to JSON */ nlohmann::json authenticationTokenRequired(); void authenticationTokenRequired(crow::Response& res); /** * @brief Formats OneTimePasscodeSent message into JSON * Message body: "A one-time passcode was sent to: . Supply the passcode * as the `Token` property in the request to create a session." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message OneTimePasscodeSent formatted to JSON */ nlohmann::json oneTimePasscodeSent(std::string_view arg1); void oneTimePasscodeSent(crow::Response& res, std::string_view arg1); /** * @brief Formats LicenseRequired message into JSON * Message body: "A license is required for this operation: ." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message LicenseRequired formatted to JSON */ nlohmann::json licenseRequired(std::string_view arg1); void licenseRequired(crow::Response& res, std::string_view arg1); /** * @brief Formats PropertyModified message into JSON * Message body: "One or more properties were successfully modified." * * * @returns Message PropertyModified formatted to JSON */ nlohmann::json propertyModified(); void propertyModified(crow::Response& res); /** * @brief Formats GenerateSecretKeyRequired message into JSON * Message body: "The Time-based One-Time Password (TOTP) secret key for this * account must be generated before access is granted. Perform the * GenerateSecretKey action at URI and retain the secret key from the * response." * * @param[in] arg1 Parameter of message that will replace %1 in its body. * * @returns Message GenerateSecretKeyRequired formatted to JSON */ nlohmann::json generateSecretKeyRequired(const boost::urls::url_view_base& arg1); void generateSecretKeyRequired(crow::Response& res, const boost::urls::url_view_base& arg1); } // namespace messages } // namespace redfish