1 #pragma once 2 /**************************************************************** 3 * READ THIS WARNING FIRST 4 * This is an auto-generated header which contains definitions 5 * for Redfish DMTF defined messages. 6 * DO NOT modify this registry outside of running the 7 * parse_registries.py script. The definitions contained within 8 * this file are owned by DMTF. Any modifications to these files 9 * should be first pushed to the relevant registry in the DMTF 10 * github organization. 11 ***************************************************************/ 12 // These generated headers are a superset of what is needed. 13 // clang sees them as an error, so ignore 14 // NOLINTBEGIN(misc-include-cleaner) 15 #include "http_response.hpp" 16 17 #include <boost/url/url_view_base.hpp> 18 #include <nlohmann/json.hpp> 19 20 #include <cstdint> 21 #include <source_location> 22 #include <string_view> 23 // NOLINTEND(misc-include-cleaner) 24 25 namespace redfish 26 { 27 28 namespace messages 29 { 30 /** 31 * @brief Formats Success message into JSON 32 * Message body: "The request completed successfully." 33 * 34 * 35 * @returns Message Success formatted to JSON */ 36 nlohmann::json::object_t success(); 37 38 void success(crow::Response& res); 39 40 /** 41 * @brief Formats GeneralError message into JSON 42 * Message body: "A general error has occurred. See Resolution for information 43 * on how to resolve the error, or @Message.ExtendedInfo if Resolution is not 44 * provided." 45 * 46 * 47 * @returns Message GeneralError formatted to JSON */ 48 nlohmann::json::object_t generalError(); 49 50 void generalError(crow::Response& res); 51 52 /** 53 * @brief Formats Created message into JSON 54 * Message body: "The resource was created successfully." 55 * 56 * 57 * @returns Message Created formatted to JSON */ 58 nlohmann::json::object_t created(); 59 60 void created(crow::Response& res); 61 62 /** 63 * @brief Formats NoOperation message into JSON 64 * Message body: "The request body submitted contain no data to act upon and no 65 * changes to the resource took place." 66 * 67 * 68 * @returns Message NoOperation formatted to JSON */ 69 nlohmann::json::object_t noOperation(); 70 71 void noOperation(crow::Response& res); 72 73 /** 74 * @brief Formats PropertyDuplicate message into JSON 75 * Message body: "The property <arg1> was duplicated in the request." 76 * 77 * @param[in] arg1 Parameter of message that will replace %1 in its body. 78 * 79 * @returns Message PropertyDuplicate formatted to JSON */ 80 nlohmann::json::object_t propertyDuplicate(std::string_view arg1); 81 82 void propertyDuplicate(crow::Response& res, std::string_view arg1); 83 84 /** 85 * @brief Formats PropertyUnknown message into JSON 86 * Message body: "The property <arg1> is not in the list of valid properties for 87 * the resource." 88 * 89 * @param[in] arg1 Parameter of message that will replace %1 in its body. 90 * 91 * @returns Message PropertyUnknown formatted to JSON */ 92 nlohmann::json::object_t propertyUnknown(std::string_view arg1); 93 94 void propertyUnknown(crow::Response& res, std::string_view arg1); 95 96 /** 97 * @brief Formats PropertyValueTypeError message into JSON 98 * Message body: "The value <arg1> for the property <arg2> is not a type that 99 * the property can accept." 100 * 101 * @param[in] arg1 Parameter of message that will replace %1 in its body. 102 * @param[in] arg2 Parameter of message that will replace %2 in its body. 103 * 104 * @returns Message PropertyValueTypeError formatted to JSON */ 105 nlohmann::json::object_t propertyValueTypeError(const nlohmann::json& arg1, 106 std::string_view arg2); 107 108 void propertyValueTypeError(crow::Response& res, const nlohmann::json& arg1, 109 std::string_view arg2); 110 111 /** 112 * @brief Formats PropertyValueFormatError message into JSON 113 * Message body: "The value <arg1> for the property <arg2> is not a format that 114 * the property can accept." 115 * 116 * @param[in] arg1 Parameter of message that will replace %1 in its body. 117 * @param[in] arg2 Parameter of message that will replace %2 in its body. 118 * 119 * @returns Message PropertyValueFormatError formatted to JSON */ 120 nlohmann::json::object_t propertyValueFormatError(const nlohmann::json& arg1, 121 std::string_view arg2); 122 123 void propertyValueFormatError(crow::Response& res, const nlohmann::json& arg1, 124 std::string_view arg2); 125 126 /** 127 * @brief Formats PropertyValueNotInList message into JSON 128 * Message body: "The value <arg1> for the property <arg2> is not in the list of 129 * acceptable values." 130 * 131 * @param[in] arg1 Parameter of message that will replace %1 in its body. 132 * @param[in] arg2 Parameter of message that will replace %2 in its body. 133 * 134 * @returns Message PropertyValueNotInList formatted to JSON */ 135 nlohmann::json::object_t propertyValueNotInList(const nlohmann::json& arg1, 136 std::string_view arg2); 137 138 void propertyValueNotInList(crow::Response& res, const nlohmann::json& arg1, 139 std::string_view arg2); 140 141 /** 142 * @brief Formats PropertyValueOutOfRange message into JSON 143 * Message body: "The value <arg1> for the property <arg2> is not in the 144 * supported range of acceptable values." 145 * 146 * @param[in] arg1 Parameter of message that will replace %1 in its body. 147 * @param[in] arg2 Parameter of message that will replace %2 in its body. 148 * 149 * @returns Message PropertyValueOutOfRange formatted to JSON */ 150 nlohmann::json::object_t propertyValueOutOfRange(const nlohmann::json& arg1, 151 std::string_view arg2); 152 153 void propertyValueOutOfRange(crow::Response& res, const nlohmann::json& arg1, 154 std::string_view arg2); 155 156 /** 157 * @brief Formats PropertyValueError message into JSON 158 * Message body: "The value provided for the property <arg1> is not valid." 159 * 160 * @param[in] arg1 Parameter of message that will replace %1 in its body. 161 * 162 * @returns Message PropertyValueError formatted to JSON */ 163 nlohmann::json::object_t propertyValueError(std::string_view arg1); 164 165 void propertyValueError(crow::Response& res, std::string_view arg1); 166 167 /** 168 * @brief Formats PropertyNotWritable message into JSON 169 * Message body: "The property <arg1> is a read-only property and cannot be 170 * assigned a value." 171 * 172 * @param[in] arg1 Parameter of message that will replace %1 in its body. 173 * 174 * @returns Message PropertyNotWritable formatted to JSON */ 175 nlohmann::json::object_t propertyNotWritable(std::string_view arg1); 176 177 void propertyNotWritable(crow::Response& res, std::string_view arg1); 178 179 /** 180 * @brief Formats PropertyNotUpdated message into JSON 181 * Message body: "The property <arg1> was not updated due to an internal service 182 * error. The service is still operational." 183 * 184 * @param[in] arg1 Parameter of message that will replace %1 in its body. 185 * 186 * @returns Message PropertyNotUpdated formatted to JSON */ 187 nlohmann::json::object_t propertyNotUpdated(std::string_view arg1); 188 189 void propertyNotUpdated(crow::Response& res, std::string_view arg1); 190 191 /** 192 * @brief Formats PropertyMissing message into JSON 193 * Message body: "The property <arg1> is a required property and must be 194 * included in the request." 195 * 196 * @param[in] arg1 Parameter of message that will replace %1 in its body. 197 * 198 * @returns Message PropertyMissing formatted to JSON */ 199 nlohmann::json::object_t propertyMissing(std::string_view arg1); 200 201 void propertyMissing(crow::Response& res, std::string_view arg1); 202 203 /** 204 * @brief Formats MalformedJSON message into JSON 205 * Message body: "The request body submitted was malformed JSON and could not be 206 * parsed by the receiving service." 207 * 208 * 209 * @returns Message MalformedJSON formatted to JSON */ 210 nlohmann::json::object_t malformedJSON(); 211 212 void malformedJSON(crow::Response& res); 213 214 /** 215 * @brief Formats InvalidJSON message into JSON 216 * Message body: "The request body submitted is invalid JSON starting at line 217 * <arg1> and could not be parsed by the receiving service." 218 * 219 * @param[in] arg1 Parameter of message that will replace %1 in its body. 220 * 221 * @returns Message InvalidJSON formatted to JSON */ 222 nlohmann::json::object_t invalidJSON(std::string_view arg1); 223 224 void invalidJSON(crow::Response& res, std::string_view arg1); 225 226 /** 227 * @brief Formats EmptyJSON message into JSON 228 * Message body: "The request body submitted contained an empty JSON object and 229 * the service is unable to process it." 230 * 231 * 232 * @returns Message EmptyJSON formatted to JSON */ 233 nlohmann::json::object_t emptyJSON(); 234 235 void emptyJSON(crow::Response& res); 236 237 /** 238 * @brief Formats ActionNotSupported message into JSON 239 * Message body: "The action <arg1> is not supported by the resource." 240 * 241 * @param[in] arg1 Parameter of message that will replace %1 in its body. 242 * 243 * @returns Message ActionNotSupported formatted to JSON */ 244 nlohmann::json::object_t actionNotSupported(std::string_view arg1); 245 246 void actionNotSupported(crow::Response& res, std::string_view arg1); 247 248 /** 249 * @brief Formats ActionParameterMissing message into JSON 250 * Message body: "The action <arg1> requires the parameter <arg2> to be present 251 * in the request body." 252 * 253 * @param[in] arg1 Parameter of message that will replace %1 in its body. 254 * @param[in] arg2 Parameter of message that will replace %2 in its body. 255 * 256 * @returns Message ActionParameterMissing formatted to JSON */ 257 nlohmann::json::object_t actionParameterMissing(std::string_view arg1, 258 std::string_view arg2); 259 260 void actionParameterMissing(crow::Response& res, std::string_view arg1, 261 std::string_view arg2); 262 263 /** 264 * @brief Formats ActionParameterDuplicate message into JSON 265 * Message body: "The action <arg1> was submitted with more than one value for 266 * the parameter <arg2>." 267 * 268 * @param[in] arg1 Parameter of message that will replace %1 in its body. 269 * @param[in] arg2 Parameter of message that will replace %2 in its body. 270 * 271 * @returns Message ActionParameterDuplicate formatted to JSON */ 272 nlohmann::json::object_t actionParameterDuplicate(std::string_view arg1, 273 std::string_view arg2); 274 275 void actionParameterDuplicate(crow::Response& res, std::string_view arg1, 276 std::string_view arg2); 277 278 /** 279 * @brief Formats ActionParameterUnknown message into JSON 280 * Message body: "The action <arg1> was submitted with the invalid parameter 281 * <arg2>." 282 * 283 * @param[in] arg1 Parameter of message that will replace %1 in its body. 284 * @param[in] arg2 Parameter of message that will replace %2 in its body. 285 * 286 * @returns Message ActionParameterUnknown formatted to JSON */ 287 nlohmann::json::object_t actionParameterUnknown(std::string_view arg1, 288 std::string_view arg2); 289 290 void actionParameterUnknown(crow::Response& res, std::string_view arg1, 291 std::string_view arg2); 292 293 /** 294 * @brief Formats ActionParameterValueTypeError message into JSON 295 * Message body: "The value <arg1> for the parameter <arg2> in the action <arg3> 296 * is not a type that the parameter can accept." 297 * 298 * @param[in] arg1 Parameter of message that will replace %1 in its body. 299 * @param[in] arg2 Parameter of message that will replace %2 in its body. 300 * @param[in] arg3 Parameter of message that will replace %3 in its body. 301 * 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); 305 306 void actionParameterValueTypeError( 307 crow::Response& res, const nlohmann::json& arg1, std::string_view arg2, 308 std::string_view arg3); 309 310 /** 311 * @brief Formats ActionParameterValueFormatError message into JSON 312 * Message body: "The value <arg1> for the parameter <arg2> in the action <arg3> 313 * is not a format that the parameter can accept." 314 * 315 * @param[in] arg1 Parameter of message that will replace %1 in its body. 316 * @param[in] arg2 Parameter of message that will replace %2 in its body. 317 * @param[in] arg3 Parameter of message that will replace %3 in its body. 318 * 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); 322 323 void actionParameterValueFormatError( 324 crow::Response& res, const nlohmann::json& arg1, std::string_view arg2, 325 std::string_view arg3); 326 327 /** 328 * @brief Formats ActionParameterValueNotInList message into JSON 329 * Message body: "The value <arg1> for the parameter <arg2> in the action <arg3> 330 * is not in the list of acceptable values." 331 * 332 * @param[in] arg1 Parameter of message that will replace %1 in its body. 333 * @param[in] arg2 Parameter of message that will replace %2 in its body. 334 * @param[in] arg3 Parameter of message that will replace %3 in its body. 335 * 336 * @returns Message ActionParameterValueNotInList formatted to JSON */ 337 nlohmann::json::object_t actionParameterValueNotInList( 338 std::string_view arg1, std::string_view arg2, std::string_view arg3); 339 340 void actionParameterValueNotInList(crow::Response& res, std::string_view arg1, 341 std::string_view arg2, 342 std::string_view arg3); 343 344 /** 345 * @brief Formats ActionParameterValueOutOfRange message into JSON 346 * Message body: "The value <arg1> for the parameter <arg2> in the action <arg3> 347 * is not in the supported range of acceptable values." 348 * 349 * @param[in] arg1 Parameter of message that will replace %1 in its body. 350 * @param[in] arg2 Parameter of message that will replace %2 in its body. 351 * @param[in] arg3 Parameter of message that will replace %3 in its body. 352 * 353 * @returns Message ActionParameterValueOutOfRange formatted to JSON */ 354 nlohmann::json::object_t actionParameterValueOutOfRange( 355 std::string_view arg1, std::string_view arg2, std::string_view arg3); 356 357 void actionParameterValueOutOfRange(crow::Response& res, std::string_view arg1, 358 std::string_view arg2, 359 std::string_view arg3); 360 361 /** 362 * @brief Formats ActionParameterValueError message into JSON 363 * Message body: "The value for the parameter <arg1> in the action <arg2> is 364 * invalid." 365 * 366 * @param[in] arg1 Parameter of message that will replace %1 in its body. 367 * @param[in] arg2 Parameter of message that will replace %2 in its body. 368 * 369 * @returns Message ActionParameterValueError formatted to JSON */ 370 nlohmann::json::object_t actionParameterValueError(const nlohmann::json& arg1, 371 std::string_view arg2); 372 373 void actionParameterValueError(crow::Response& res, const nlohmann::json& arg1, 374 std::string_view arg2); 375 376 /** 377 * @brief Formats ActionParameterNotSupported message into JSON 378 * Message body: "The parameter <arg1> for the action <arg2> is not supported on 379 * the target resource." 380 * 381 * @param[in] arg1 Parameter of message that will replace %1 in its body. 382 * @param[in] arg2 Parameter of message that will replace %2 in its body. 383 * 384 * @returns Message ActionParameterNotSupported formatted to JSON */ 385 nlohmann::json::object_t actionParameterNotSupported(std::string_view arg1, 386 std::string_view arg2); 387 388 void actionParameterNotSupported(crow::Response& res, std::string_view arg1, 389 std::string_view arg2); 390 391 /** 392 * @brief Formats ArraySizeTooLong message into JSON 393 * Message body: "The array provided for property <arg1> exceeds the size limit 394 * <arg2>." 395 * 396 * @param[in] arg1 Parameter of message that will replace %1 in its body. 397 * @param[in] arg2 Parameter of message that will replace %2 in its body. 398 * 399 * @returns Message ArraySizeTooLong formatted to JSON */ 400 nlohmann::json::object_t arraySizeTooLong(std::string_view arg1, uint64_t arg2); 401 402 void arraySizeTooLong(crow::Response& res, std::string_view arg1, 403 uint64_t arg2); 404 405 /** 406 * @brief Formats ArraySizeTooShort message into JSON 407 * Message body: "The array provided for property <arg1> is under the minimum 408 * size limit <arg2>." 409 * 410 * @param[in] arg1 Parameter of message that will replace %1 in its body. 411 * @param[in] arg2 Parameter of message that will replace %2 in its body. 412 * 413 * @returns Message ArraySizeTooShort formatted to JSON */ 414 nlohmann::json::object_t arraySizeTooShort(std::string_view arg1, 415 std::string_view arg2); 416 417 void arraySizeTooShort(crow::Response& res, std::string_view arg1, 418 std::string_view arg2); 419 420 /** 421 * @brief Formats QueryParameterValueTypeError message into JSON 422 * Message body: "The value <arg1> for the query parameter <arg2> is not a type 423 * that the parameter can accept." 424 * 425 * @param[in] arg1 Parameter of message that will replace %1 in its body. 426 * @param[in] arg2 Parameter of message that will replace %2 in its body. 427 * 428 * @returns Message QueryParameterValueTypeError formatted to JSON */ 429 nlohmann::json::object_t queryParameterValueTypeError( 430 const nlohmann::json& arg1, std::string_view arg2); 431 432 void queryParameterValueTypeError( 433 crow::Response& res, const nlohmann::json& arg1, std::string_view arg2); 434 435 /** 436 * @brief Formats QueryParameterValueFormatError message into JSON 437 * Message body: "The value <arg1> for the parameter <arg2> is not a format that 438 * the parameter can accept." 439 * 440 * @param[in] arg1 Parameter of message that will replace %1 in its body. 441 * @param[in] arg2 Parameter of message that will replace %2 in its body. 442 * 443 * @returns Message QueryParameterValueFormatError formatted to JSON */ 444 nlohmann::json::object_t queryParameterValueFormatError( 445 const nlohmann::json& arg1, std::string_view arg2); 446 447 void queryParameterValueFormatError( 448 crow::Response& res, const nlohmann::json& arg1, std::string_view arg2); 449 450 /** 451 * @brief Formats QueryParameterValueError message into JSON 452 * Message body: "The value for the parameter <arg1> is invalid." 453 * 454 * @param[in] arg1 Parameter of message that will replace %1 in its body. 455 * 456 * @returns Message QueryParameterValueError formatted to JSON */ 457 nlohmann::json::object_t queryParameterValueError(std::string_view arg1); 458 459 void queryParameterValueError(crow::Response& res, std::string_view arg1); 460 461 /** 462 * @brief Formats QueryParameterOutOfRange message into JSON 463 * Message body: "The value <arg1> for the query parameter <arg2> is out of 464 * range <arg3>." 465 * 466 * @param[in] arg1 Parameter of message that will replace %1 in its body. 467 * @param[in] arg2 Parameter of message that will replace %2 in its body. 468 * @param[in] arg3 Parameter of message that will replace %3 in its body. 469 * 470 * @returns Message QueryParameterOutOfRange formatted to JSON */ 471 nlohmann::json::object_t queryParameterOutOfRange( 472 std::string_view arg1, std::string_view arg2, std::string_view arg3); 473 474 void queryParameterOutOfRange(crow::Response& res, std::string_view arg1, 475 std::string_view arg2, std::string_view arg3); 476 477 /** 478 * @brief Formats QueryNotSupportedOnResource message into JSON 479 * Message body: "Querying is not supported on the requested resource." 480 * 481 * 482 * @returns Message QueryNotSupportedOnResource formatted to JSON */ 483 nlohmann::json::object_t queryNotSupportedOnResource(); 484 485 void queryNotSupportedOnResource(crow::Response& res); 486 487 /** 488 * @brief Formats QueryNotSupportedOnOperation message into JSON 489 * Message body: "Querying is not supported with the requested operation." 490 * 491 * 492 * @returns Message QueryNotSupportedOnOperation formatted to JSON */ 493 nlohmann::json::object_t queryNotSupportedOnOperation(); 494 495 void queryNotSupportedOnOperation(crow::Response& res); 496 497 /** 498 * @brief Formats QueryNotSupported message into JSON 499 * Message body: "Querying is not supported by the implementation." 500 * 501 * 502 * @returns Message QueryNotSupported formatted to JSON */ 503 nlohmann::json::object_t queryNotSupported(); 504 505 void queryNotSupported(crow::Response& res); 506 507 /** 508 * @brief Formats QueryCombinationInvalid message into JSON 509 * Message body: "Two or more query parameters in the request cannot be used 510 * together." 511 * 512 * 513 * @returns Message QueryCombinationInvalid formatted to JSON */ 514 nlohmann::json::object_t queryCombinationInvalid(); 515 516 void queryCombinationInvalid(crow::Response& res); 517 518 /** 519 * @brief Formats QueryParameterUnsupported message into JSON 520 * Message body: "Query parameter <arg1> is not supported." 521 * 522 * @param[in] arg1 Parameter of message that will replace %1 in its body. 523 * 524 * @returns Message QueryParameterUnsupported formatted to JSON */ 525 nlohmann::json::object_t queryParameterUnsupported(std::string_view arg1); 526 527 void queryParameterUnsupported(crow::Response& res, std::string_view arg1); 528 529 /** 530 * @brief Formats SessionLimitExceeded message into JSON 531 * Message body: "The session establishment failed due to the number of 532 * simultaneous sessions exceeding the limit of the implementation." 533 * 534 * 535 * @returns Message SessionLimitExceeded formatted to JSON */ 536 nlohmann::json::object_t sessionLimitExceeded(); 537 538 void sessionLimitExceeded(crow::Response& res); 539 540 /** 541 * @brief Formats EventSubscriptionLimitExceeded message into JSON 542 * Message body: "The event subscription failed due to the number of 543 * simultaneous subscriptions exceeding the limit of the implementation." 544 * 545 * 546 * @returns Message EventSubscriptionLimitExceeded formatted to JSON */ 547 nlohmann::json::object_t eventSubscriptionLimitExceeded(); 548 549 void eventSubscriptionLimitExceeded(crow::Response& res); 550 551 /** 552 * @brief Formats ResourceCannotBeDeleted message into JSON 553 * Message body: "The delete request failed because the resource requested 554 * cannot be deleted." 555 * 556 * 557 * @returns Message ResourceCannotBeDeleted formatted to JSON */ 558 nlohmann::json::object_t resourceCannotBeDeleted(); 559 560 void resourceCannotBeDeleted(crow::Response& res); 561 562 /** 563 * @brief Formats ResourceInUse message into JSON 564 * Message body: "The change to the requested resource failed because the 565 * resource is in use or in transition." 566 * 567 * 568 * @returns Message ResourceInUse formatted to JSON */ 569 nlohmann::json::object_t resourceInUse(); 570 571 void resourceInUse(crow::Response& res); 572 573 /** 574 * @brief Formats ResourceAlreadyExists message into JSON 575 * Message body: "The requested resource of type <arg1> with the property <arg2> 576 * with the value <arg3> already exists." 577 * 578 * @param[in] arg1 Parameter of message that will replace %1 in its body. 579 * @param[in] arg2 Parameter of message that will replace %2 in its body. 580 * @param[in] arg3 Parameter of message that will replace %3 in its body. 581 * 582 * @returns Message ResourceAlreadyExists formatted to JSON */ 583 nlohmann::json::object_t resourceAlreadyExists( 584 std::string_view arg1, std::string_view arg2, std::string_view arg3); 585 586 void resourceAlreadyExists(crow::Response& res, std::string_view arg1, 587 std::string_view arg2, std::string_view arg3); 588 589 /** 590 * @brief Formats ResourceNotFound message into JSON 591 * Message body: "The requested resource of type <arg1> named <arg2> was not 592 * found." 593 * 594 * @param[in] arg1 Parameter of message that will replace %1 in its body. 595 * @param[in] arg2 Parameter of message that will replace %2 in its body. 596 * 597 * @returns Message ResourceNotFound formatted to JSON */ 598 nlohmann::json::object_t resourceNotFound(std::string_view arg1, 599 std::string_view arg2); 600 601 void resourceNotFound(crow::Response& res, std::string_view arg1, 602 std::string_view arg2); 603 604 /** 605 * @brief Formats PayloadTooLarge message into JSON 606 * Message body: "The supplied payload exceeds the maximum size supported by the 607 * service." 608 * 609 * 610 * @returns Message PayloadTooLarge formatted to JSON */ 611 nlohmann::json::object_t payloadTooLarge(); 612 613 void payloadTooLarge(crow::Response& res); 614 615 /** 616 * @brief Formats InsufficientStorage message into JSON 617 * Message body: "Insufficient storage or memory available to complete the 618 * request." 619 * 620 * 621 * @returns Message InsufficientStorage formatted to JSON */ 622 nlohmann::json::object_t insufficientStorage(); 623 624 void insufficientStorage(crow::Response& res); 625 626 /** 627 * @brief Formats MissingOrMalformedPart message into JSON 628 * Message body: "The multipart request contains malformed parts or is missing 629 * required parts." 630 * 631 * 632 * @returns Message MissingOrMalformedPart formatted to JSON */ 633 nlohmann::json::object_t missingOrMalformedPart(); 634 635 void missingOrMalformedPart(crow::Response& res); 636 637 /** 638 * @brief Formats InvalidURI message into JSON 639 * Message body: "The URI <arg1> was not found." 640 * 641 * @param[in] arg1 Parameter of message that will replace %1 in its body. 642 * 643 * @returns Message InvalidURI formatted to JSON */ 644 nlohmann::json::object_t invalidURI(std::string_view arg1); 645 646 void invalidURI(crow::Response& res, std::string_view arg1); 647 648 /** 649 * @brief Formats CreateFailedMissingReqProperties message into JSON 650 * Message body: "The create operation failed because the required property 651 * <arg1> was missing from the request." 652 * 653 * @param[in] arg1 Parameter of message that will replace %1 in its body. 654 * 655 * @returns Message CreateFailedMissingReqProperties formatted to JSON */ 656 nlohmann::json::object_t createFailedMissingReqProperties( 657 std::string_view arg1); 658 659 void createFailedMissingReqProperties(crow::Response& res, 660 std::string_view arg1); 661 662 /** 663 * @brief Formats CreateLimitReachedForResource message into JSON 664 * Message body: "The create operation failed because the resource has reached 665 * the limit of possible resources." 666 * 667 * 668 * @returns Message CreateLimitReachedForResource formatted to JSON */ 669 nlohmann::json::object_t createLimitReachedForResource(); 670 671 void createLimitReachedForResource(crow::Response& res); 672 673 /** 674 * @brief Formats ServiceShuttingDown message into JSON 675 * Message body: "The operation failed because the service is shutting down and 676 * can no longer take incoming requests." 677 * 678 * 679 * @returns Message ServiceShuttingDown formatted to JSON */ 680 nlohmann::json::object_t serviceShuttingDown(); 681 682 void serviceShuttingDown(crow::Response& res); 683 684 /** 685 * @brief Formats ServiceInUnknownState message into JSON 686 * Message body: "The operation failed because the service is in an unknown 687 * state and can no longer take incoming requests." 688 * 689 * 690 * @returns Message ServiceInUnknownState formatted to JSON */ 691 nlohmann::json::object_t serviceInUnknownState(); 692 693 void serviceInUnknownState(crow::Response& res); 694 695 /** 696 * @brief Formats NoValidSession message into JSON 697 * Message body: "There is no valid session established with the 698 * implementation." 699 * 700 * 701 * @returns Message NoValidSession formatted to JSON */ 702 nlohmann::json::object_t noValidSession(); 703 704 void noValidSession(crow::Response& res); 705 706 /** 707 * @brief Formats InsufficientPrivilege message into JSON 708 * Message body: "There are insufficient privileges for the account or 709 * credentials associated with the current session to perform the requested 710 * operation." 711 * 712 * 713 * @returns Message InsufficientPrivilege formatted to JSON */ 714 nlohmann::json::object_t insufficientPrivilege(); 715 716 void insufficientPrivilege(crow::Response& res); 717 718 /** 719 * @brief Formats AccountModified message into JSON 720 * Message body: "The account was successfully modified." 721 * 722 * 723 * @returns Message AccountModified formatted to JSON */ 724 nlohmann::json::object_t accountModified(); 725 726 void accountModified(crow::Response& res); 727 728 /** 729 * @brief Formats AccountNotModified message into JSON 730 * Message body: "The account modification request failed." 731 * 732 * 733 * @returns Message AccountNotModified formatted to JSON */ 734 nlohmann::json::object_t accountNotModified(); 735 736 void accountNotModified(crow::Response& res); 737 738 /** 739 * @brief Formats AccountRemoved message into JSON 740 * Message body: "The account was successfully removed." 741 * 742 * 743 * @returns Message AccountRemoved formatted to JSON */ 744 nlohmann::json::object_t accountRemoved(); 745 746 void accountRemoved(crow::Response& res); 747 748 /** 749 * @brief Formats AccountForSessionNoLongerExists message into JSON 750 * Message body: "The account for the current session was removed, and so the 751 * current session was removed as well." 752 * 753 * 754 * @returns Message AccountForSessionNoLongerExists formatted to JSON */ 755 nlohmann::json::object_t accountForSessionNoLongerExists(); 756 757 void accountForSessionNoLongerExists(crow::Response& res); 758 759 /** 760 * @brief Formats InvalidObject message into JSON 761 * Message body: "The object at <arg1> is invalid." 762 * 763 * @param[in] arg1 Parameter of message that will replace %1 in its body. 764 * 765 * @returns Message InvalidObject formatted to JSON */ 766 nlohmann::json::object_t invalidObject(const boost::urls::url_view_base& arg1); 767 768 void invalidObject(crow::Response& res, const boost::urls::url_view_base& arg1); 769 770 /** 771 * @brief Formats InternalError message into JSON 772 * Message body: "The request failed due to an internal service error. The 773 * service is still operational." 774 * 775 * 776 * @returns Message InternalError formatted to JSON */ 777 nlohmann::json::object_t internalError(); 778 779 void internalError(crow::Response& res, std::source_location location = 780 std::source_location::current()); 781 782 /** 783 * @brief Formats UnrecognizedRequestBody message into JSON 784 * Message body: "The service detected a malformed request body that it was 785 * unable to interpret." 786 * 787 * 788 * @returns Message UnrecognizedRequestBody formatted to JSON */ 789 nlohmann::json::object_t unrecognizedRequestBody(); 790 791 void unrecognizedRequestBody(crow::Response& res); 792 793 /** 794 * @brief Formats ResourceMissingAtURI message into JSON 795 * Message body: "The resource at the URI <arg1> was not found." 796 * 797 * @param[in] arg1 Parameter of message that will replace %1 in its body. 798 * 799 * @returns Message ResourceMissingAtURI formatted to JSON */ 800 nlohmann::json::object_t resourceMissingAtURI( 801 const boost::urls::url_view_base& arg1); 802 803 void resourceMissingAtURI(crow::Response& res, 804 const boost::urls::url_view_base& arg1); 805 806 /** 807 * @brief Formats ResourceAtUriInUnknownFormat message into JSON 808 * Message body: "The resource at <arg1> is in a format not recognized by the 809 * service." 810 * 811 * @param[in] arg1 Parameter of message that will replace %1 in its body. 812 * 813 * @returns Message ResourceAtUriInUnknownFormat formatted to JSON */ 814 nlohmann::json::object_t resourceAtUriInUnknownFormat( 815 const boost::urls::url_view_base& arg1); 816 817 void resourceAtUriInUnknownFormat(crow::Response& res, 818 const boost::urls::url_view_base& arg1); 819 820 /** 821 * @brief Formats ResourceAtUriUnauthorized message into JSON 822 * Message body: "While accessing the resource at <arg1>, the service received 823 * an authorization error <arg2>." 824 * 825 * @param[in] arg1 Parameter of message that will replace %1 in its body. 826 * @param[in] arg2 Parameter of message that will replace %2 in its body. 827 * 828 * @returns Message ResourceAtUriUnauthorized formatted to JSON */ 829 nlohmann::json::object_t resourceAtUriUnauthorized( 830 const boost::urls::url_view_base& arg1, std::string_view arg2); 831 832 void resourceAtUriUnauthorized(crow::Response& res, 833 const boost::urls::url_view_base& arg1, 834 std::string_view arg2); 835 836 /** 837 * @brief Formats CouldNotEstablishConnection message into JSON 838 * Message body: "The service failed to establish a connection with the URI 839 * <arg1>." 840 * 841 * @param[in] arg1 Parameter of message that will replace %1 in its body. 842 * 843 * @returns Message CouldNotEstablishConnection formatted to JSON */ 844 nlohmann::json::object_t couldNotEstablishConnection( 845 const boost::urls::url_view_base& arg1); 846 847 void couldNotEstablishConnection(crow::Response& res, 848 const boost::urls::url_view_base& arg1); 849 850 /** 851 * @brief Formats SourceDoesNotSupportProtocol message into JSON 852 * Message body: "The other end of the connection at <arg1> does not support the 853 * specified protocol <arg2>." 854 * 855 * @param[in] arg1 Parameter of message that will replace %1 in its body. 856 * @param[in] arg2 Parameter of message that will replace %2 in its body. 857 * 858 * @returns Message SourceDoesNotSupportProtocol formatted to JSON */ 859 nlohmann::json::object_t sourceDoesNotSupportProtocol( 860 const boost::urls::url_view_base& arg1, std::string_view arg2); 861 862 void sourceDoesNotSupportProtocol(crow::Response& res, 863 const boost::urls::url_view_base& arg1, 864 std::string_view arg2); 865 866 /** 867 * @brief Formats AccessDenied message into JSON 868 * Message body: "While attempting to establish a connection to <arg1>, the 869 * service denied access." 870 * 871 * @param[in] arg1 Parameter of message that will replace %1 in its body. 872 * 873 * @returns Message AccessDenied formatted to JSON */ 874 nlohmann::json::object_t accessDenied(const boost::urls::url_view_base& arg1); 875 876 void accessDenied(crow::Response& res, const boost::urls::url_view_base& arg1); 877 878 /** 879 * @brief Formats ServiceTemporarilyUnavailable message into JSON 880 * Message body: "The service is temporarily unavailable. Retry in <arg1> 881 * seconds." 882 * 883 * @param[in] arg1 Parameter of message that will replace %1 in its body. 884 * 885 * @returns Message ServiceTemporarilyUnavailable formatted to JSON */ 886 nlohmann::json::object_t serviceTemporarilyUnavailable(std::string_view arg1); 887 888 void serviceTemporarilyUnavailable(crow::Response& res, std::string_view arg1); 889 890 /** 891 * @brief Formats InvalidIndex message into JSON 892 * Message body: "The index <arg1> is not a valid offset into the array." 893 * 894 * @param[in] arg1 Parameter of message that will replace %1 in its body. 895 * 896 * @returns Message InvalidIndex formatted to JSON */ 897 nlohmann::json::object_t invalidIndex(uint64_t arg1); 898 899 void invalidIndex(crow::Response& res, uint64_t arg1); 900 901 /** 902 * @brief Formats PropertyValueModified message into JSON 903 * Message body: "The property <arg1> was assigned the value <arg2> due to 904 * modification by the service." 905 * 906 * @param[in] arg1 Parameter of message that will replace %1 in its body. 907 * @param[in] arg2 Parameter of message that will replace %2 in its body. 908 * 909 * @returns Message PropertyValueModified formatted to JSON */ 910 nlohmann::json::object_t propertyValueModified(std::string_view arg1, 911 const nlohmann::json& arg2); 912 913 void propertyValueModified(crow::Response& res, std::string_view arg1, 914 const nlohmann::json& arg2); 915 916 /** 917 * @brief Formats ResourceInStandby message into JSON 918 * Message body: "The request could not be performed because the resource is in 919 * standby." 920 * 921 * 922 * @returns Message ResourceInStandby formatted to JSON */ 923 nlohmann::json::object_t resourceInStandby(); 924 925 void resourceInStandby(crow::Response& res); 926 927 /** 928 * @brief Formats ResourceExhaustion message into JSON 929 * Message body: "The resource <arg1> was unable to satisfy the request due to 930 * unavailability of resources." 931 * 932 * @param[in] arg1 Parameter of message that will replace %1 in its body. 933 * 934 * @returns Message ResourceExhaustion formatted to JSON */ 935 nlohmann::json::object_t resourceExhaustion(std::string_view arg1); 936 937 void resourceExhaustion(crow::Response& res, std::string_view arg1); 938 939 /** 940 * @brief Formats StringValueTooLong message into JSON 941 * Message body: "The string <arg1> exceeds the length limit <arg2>." 942 * 943 * @param[in] arg1 Parameter of message that will replace %1 in its body. 944 * @param[in] arg2 Parameter of message that will replace %2 in its body. 945 * 946 * @returns Message StringValueTooLong formatted to JSON */ 947 nlohmann::json::object_t stringValueTooLong(std::string_view arg1, 948 uint64_t arg2); 949 950 void stringValueTooLong(crow::Response& res, std::string_view arg1, 951 uint64_t arg2); 952 953 /** 954 * @brief Formats StringValueTooShort message into JSON 955 * Message body: "The string <arg1> was under the minimum required length 956 * <arg2>." 957 * 958 * @param[in] arg1 Parameter of message that will replace %1 in its body. 959 * @param[in] arg2 Parameter of message that will replace %2 in its body. 960 * 961 * @returns Message StringValueTooShort formatted to JSON */ 962 nlohmann::json::object_t stringValueTooShort(std::string_view arg1, 963 std::string_view arg2); 964 965 void stringValueTooShort(crow::Response& res, std::string_view arg1, 966 std::string_view arg2); 967 968 /** 969 * @brief Formats SessionTerminated message into JSON 970 * Message body: "The session was successfully terminated." 971 * 972 * 973 * @returns Message SessionTerminated formatted to JSON */ 974 nlohmann::json::object_t sessionTerminated(); 975 976 void sessionTerminated(crow::Response& res); 977 978 /** 979 * @brief Formats SubscriptionTerminated message into JSON 980 * Message body: "The event subscription was terminated." 981 * 982 * 983 * @returns Message SubscriptionTerminated formatted to JSON */ 984 nlohmann::json::object_t subscriptionTerminated(); 985 986 void subscriptionTerminated(crow::Response& res); 987 988 /** 989 * @brief Formats ResourceTypeIncompatible message into JSON 990 * Message body: "The @odata.type of the request body <arg1> is incompatible 991 * with the @odata.type of the resource, which is <arg2>." 992 * 993 * @param[in] arg1 Parameter of message that will replace %1 in its body. 994 * @param[in] arg2 Parameter of message that will replace %2 in its body. 995 * 996 * @returns Message ResourceTypeIncompatible formatted to JSON */ 997 nlohmann::json::object_t resourceTypeIncompatible(std::string_view arg1, 998 std::string_view arg2); 999 1000 void resourceTypeIncompatible(crow::Response& res, std::string_view arg1, 1001 std::string_view arg2); 1002 1003 /** 1004 * @brief Formats PasswordChangeRequired message into JSON 1005 * Message body: "The password provided for this account must be changed before 1006 * access is granted. PATCH the Password property for this account located at 1007 * the target URI <arg1> to complete this process." 1008 * 1009 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1010 * 1011 * @returns Message PasswordChangeRequired formatted to JSON */ 1012 nlohmann::json::object_t passwordChangeRequired( 1013 const boost::urls::url_view_base& arg1); 1014 1015 void passwordChangeRequired(crow::Response& res, 1016 const boost::urls::url_view_base& arg1); 1017 1018 /** 1019 * @brief Formats ResetRequired message into JSON 1020 * Message body: "In order to apply changes, recover from errors, or complete 1021 * the operation, a component reset is required with the Reset action URI <arg1> 1022 * and ResetType <arg2>." 1023 * 1024 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1025 * @param[in] arg2 Parameter of message that will replace %2 in its body. 1026 * 1027 * @returns Message ResetRequired formatted to JSON */ 1028 nlohmann::json::object_t resetRequired(const boost::urls::url_view_base& arg1, 1029 std::string_view arg2); 1030 1031 void resetRequired(crow::Response& res, const boost::urls::url_view_base& arg1, 1032 std::string_view arg2); 1033 1034 /** 1035 * @brief Formats ResetRecommended message into JSON 1036 * Message body: "In order to recover from errors, a component reset is 1037 * recommended with the Reset action URI <arg1> and ResetType <arg2>." 1038 * 1039 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1040 * @param[in] arg2 Parameter of message that will replace %2 in its body. 1041 * 1042 * @returns Message ResetRecommended formatted to JSON */ 1043 nlohmann::json::object_t resetRecommended(std::string_view arg1, 1044 std::string_view arg2); 1045 1046 void resetRecommended(crow::Response& res, std::string_view arg1, 1047 std::string_view arg2); 1048 1049 /** 1050 * @brief Formats ChassisPowerStateOnRequired message into JSON 1051 * Message body: "The chassis with Id <arg1> is required to be powered on to 1052 * perform this request." 1053 * 1054 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1055 * 1056 * @returns Message ChassisPowerStateOnRequired formatted to JSON */ 1057 nlohmann::json::object_t chassisPowerStateOnRequired(std::string_view arg1); 1058 1059 void chassisPowerStateOnRequired(crow::Response& res, std::string_view arg1); 1060 1061 /** 1062 * @brief Formats ChassisPowerStateOffRequired message into JSON 1063 * Message body: "The chassis with Id <arg1> is required to be powered off to 1064 * perform this request." 1065 * 1066 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1067 * 1068 * @returns Message ChassisPowerStateOffRequired formatted to JSON */ 1069 nlohmann::json::object_t chassisPowerStateOffRequired(std::string_view arg1); 1070 1071 void chassisPowerStateOffRequired(crow::Response& res, std::string_view arg1); 1072 1073 /** 1074 * @brief Formats PropertyValueConflict message into JSON 1075 * Message body: "The property <arg1> could not be written because its value 1076 * would conflict with the value of the <arg2> property." 1077 * 1078 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1079 * @param[in] arg2 Parameter of message that will replace %2 in its body. 1080 * 1081 * @returns Message PropertyValueConflict formatted to JSON */ 1082 nlohmann::json::object_t propertyValueConflict(std::string_view arg1, 1083 std::string_view arg2); 1084 1085 void propertyValueConflict(crow::Response& res, std::string_view arg1, 1086 std::string_view arg2); 1087 1088 /** 1089 * @brief Formats PropertyValueResourceConflict message into JSON 1090 * Message body: "The property <arg1> with the requested value of <arg2> could 1091 * not be written because the value conflicts with the state or configuration of 1092 * the resource at <arg3>." 1093 * 1094 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1095 * @param[in] arg2 Parameter of message that will replace %2 in its body. 1096 * @param[in] arg3 Parameter of message that will replace %3 in its body. 1097 * 1098 * @returns Message PropertyValueResourceConflict formatted to JSON */ 1099 nlohmann::json::object_t propertyValueResourceConflict( 1100 std::string_view arg1, const nlohmann::json& arg2, 1101 const boost::urls::url_view_base& arg3); 1102 1103 void propertyValueResourceConflict(crow::Response& res, std::string_view arg1, 1104 const nlohmann::json& arg2, 1105 const boost::urls::url_view_base& arg3); 1106 1107 /** 1108 * @brief Formats PropertyValueExternalConflict message into JSON 1109 * Message body: "The property <arg1> with the requested value of <arg2> could 1110 * not be written because the value is not available due to a configuration 1111 * conflict." 1112 * 1113 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1114 * @param[in] arg2 Parameter of message that will replace %2 in its body. 1115 * 1116 * @returns Message PropertyValueExternalConflict formatted to JSON */ 1117 nlohmann::json::object_t propertyValueExternalConflict( 1118 std::string_view arg1, const nlohmann::json& arg2); 1119 1120 void propertyValueExternalConflict(crow::Response& res, std::string_view arg1, 1121 const nlohmann::json& arg2); 1122 1123 /** 1124 * @brief Formats PropertyValueIncorrect message into JSON 1125 * Message body: "The property <arg1> with the requested value of <arg2> could 1126 * not be written because the value does not meet the constraints of the 1127 * implementation." 1128 * 1129 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1130 * @param[in] arg2 Parameter of message that will replace %2 in its body. 1131 * 1132 * @returns Message PropertyValueIncorrect formatted to JSON */ 1133 nlohmann::json::object_t propertyValueIncorrect(std::string_view arg1, 1134 const nlohmann::json& arg2); 1135 1136 void propertyValueIncorrect(crow::Response& res, std::string_view arg1, 1137 const nlohmann::json& arg2); 1138 1139 /** 1140 * @brief Formats ResourceCreationConflict message into JSON 1141 * Message body: "The resource could not be created. The service has a resource 1142 * at URI <arg1> that conflicts with the creation request." 1143 * 1144 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1145 * 1146 * @returns Message ResourceCreationConflict formatted to JSON */ 1147 nlohmann::json::object_t resourceCreationConflict( 1148 const boost::urls::url_view_base& arg1); 1149 1150 void resourceCreationConflict(crow::Response& res, 1151 const boost::urls::url_view_base& arg1); 1152 1153 /** 1154 * @brief Formats ActionParameterValueConflict message into JSON 1155 * Message body: "The parameter <arg1> with the requested value of <arg2> does 1156 * not meet the constraints of the implementation." 1157 * 1158 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1159 * @param[in] arg2 Parameter of message that will replace %2 in its body. 1160 * 1161 * @returns Message ActionParameterValueConflict formatted to JSON */ 1162 nlohmann::json::object_t actionParameterValueConflict(std::string_view arg1, 1163 std::string_view arg2); 1164 1165 void actionParameterValueConflict(crow::Response& res, std::string_view arg1, 1166 std::string_view arg2); 1167 1168 /** 1169 * @brief Formats MaximumErrorsExceeded message into JSON 1170 * Message body: "Too many errors have occurred to report them all." 1171 * 1172 * 1173 * @returns Message MaximumErrorsExceeded formatted to JSON */ 1174 nlohmann::json::object_t maximumErrorsExceeded(); 1175 1176 void maximumErrorsExceeded(crow::Response& res); 1177 1178 /** 1179 * @brief Formats PreconditionFailed message into JSON 1180 * Message body: "The ETag supplied did not match the ETag required to change 1181 * this resource." 1182 * 1183 * 1184 * @returns Message PreconditionFailed formatted to JSON */ 1185 nlohmann::json::object_t preconditionFailed(); 1186 1187 void preconditionFailed(crow::Response& res); 1188 1189 /** 1190 * @brief Formats PreconditionRequired message into JSON 1191 * Message body: "A precondition header or annotation is required to change this 1192 * resource." 1193 * 1194 * 1195 * @returns Message PreconditionRequired formatted to JSON */ 1196 nlohmann::json::object_t preconditionRequired(); 1197 1198 void preconditionRequired(crow::Response& res); 1199 1200 /** 1201 * @brief Formats HeaderMissing message into JSON 1202 * Message body: "Required header <arg1> is missing in the request." 1203 * 1204 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1205 * 1206 * @returns Message HeaderMissing formatted to JSON */ 1207 nlohmann::json::object_t headerMissing(std::string_view arg1); 1208 1209 void headerMissing(crow::Response& res, std::string_view arg1); 1210 1211 /** 1212 * @brief Formats HeaderInvalid message into JSON 1213 * Message body: "Header <arg1> is invalid." 1214 * 1215 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1216 * 1217 * @returns Message HeaderInvalid formatted to JSON */ 1218 nlohmann::json::object_t headerInvalid(std::string_view arg1); 1219 1220 void headerInvalid(crow::Response& res, std::string_view arg1); 1221 1222 /** 1223 * @brief Formats OperationFailed message into JSON 1224 * Message body: "An error occurred internal to the service as part of the 1225 * overall request. Partial results may have been returned." 1226 * 1227 * 1228 * @returns Message OperationFailed formatted to JSON */ 1229 nlohmann::json::object_t operationFailed(); 1230 1231 void operationFailed(crow::Response& res); 1232 1233 /** 1234 * @brief Formats OperationTimeout message into JSON 1235 * Message body: "A timeout internal to the service occurred as part of the 1236 * request. Partial results may have been returned." 1237 * 1238 * 1239 * @returns Message OperationTimeout formatted to JSON */ 1240 nlohmann::json::object_t operationTimeout(); 1241 1242 void operationTimeout(crow::Response& res); 1243 1244 /** 1245 * @brief Formats OperationNotAllowed message into JSON 1246 * Message body: "The HTTP method is not allowed on this resource." 1247 * 1248 * 1249 * @returns Message OperationNotAllowed formatted to JSON */ 1250 nlohmann::json::object_t operationNotAllowed(); 1251 1252 void operationNotAllowed(crow::Response& res); 1253 1254 /** 1255 * @brief Formats UndeterminedFault message into JSON 1256 * Message body: "An undetermined fault condition was reported by <arg1>." 1257 * 1258 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1259 * 1260 * @returns Message UndeterminedFault formatted to JSON */ 1261 nlohmann::json::object_t undeterminedFault(std::string_view arg1); 1262 1263 void undeterminedFault(crow::Response& res, std::string_view arg1); 1264 1265 /** 1266 * @brief Formats ConditionInRelatedResource message into JSON 1267 * Message body: "One or more conditions exist in a related resource. See the 1268 * OriginOfCondition property." 1269 * 1270 * 1271 * @returns Message ConditionInRelatedResource formatted to JSON */ 1272 nlohmann::json::object_t conditionInRelatedResource(); 1273 1274 void conditionInRelatedResource(crow::Response& res); 1275 1276 /** 1277 * @brief Formats RestrictedRole message into JSON 1278 * Message body: "The operation was not successful because the role <arg1> is 1279 * restricted." 1280 * 1281 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1282 * 1283 * @returns Message RestrictedRole formatted to JSON */ 1284 nlohmann::json::object_t restrictedRole(std::string_view arg1); 1285 1286 void restrictedRole(crow::Response& res, std::string_view arg1); 1287 1288 /** 1289 * @brief Formats RestrictedPrivilege message into JSON 1290 * Message body: "The operation was not successful because the privilege <arg1> 1291 * is restricted." 1292 * 1293 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1294 * 1295 * @returns Message RestrictedPrivilege formatted to JSON */ 1296 nlohmann::json::object_t restrictedPrivilege(std::string_view arg1); 1297 1298 void restrictedPrivilege(crow::Response& res, std::string_view arg1); 1299 1300 /** 1301 * @brief Formats StrictAccountTypes message into JSON 1302 * Message body: "The request could not be fulfilled with the account types 1303 * included in property <arg1> because the property StrictAccountTypes is set to 1304 * true." 1305 * 1306 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1307 * 1308 * @returns Message StrictAccountTypes formatted to JSON */ 1309 nlohmann::json::object_t strictAccountTypes(std::string_view arg1); 1310 1311 void strictAccountTypes(crow::Response& res, std::string_view arg1); 1312 1313 /** 1314 * @brief Formats PropertyDeprecated message into JSON 1315 * Message body: "The deprecated property <arg1> was included in the request 1316 * body." 1317 * 1318 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1319 * 1320 * @returns Message PropertyDeprecated formatted to JSON */ 1321 nlohmann::json::object_t propertyDeprecated(std::string_view arg1); 1322 1323 void propertyDeprecated(crow::Response& res, std::string_view arg1); 1324 1325 /** 1326 * @brief Formats ResourceDeprecated message into JSON 1327 * Message body: "The operation was performed on a deprecated resource <arg1>." 1328 * 1329 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1330 * 1331 * @returns Message ResourceDeprecated formatted to JSON */ 1332 nlohmann::json::object_t resourceDeprecated(std::string_view arg1); 1333 1334 void resourceDeprecated(crow::Response& res, std::string_view arg1); 1335 1336 /** 1337 * @brief Formats PropertyValueDeprecated message into JSON 1338 * Message body: "The value <arg1> for the property <arg2> is deprecated." 1339 * 1340 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1341 * @param[in] arg2 Parameter of message that will replace %2 in its body. 1342 * 1343 * @returns Message PropertyValueDeprecated formatted to JSON */ 1344 nlohmann::json::object_t propertyValueDeprecated(std::string_view arg1, 1345 std::string_view arg2); 1346 1347 void propertyValueDeprecated(crow::Response& res, std::string_view arg1, 1348 std::string_view arg2); 1349 1350 /** 1351 * @brief Formats ActionDeprecated message into JSON 1352 * Message body: "The action <arg1> is deprecated." 1353 * 1354 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1355 * 1356 * @returns Message ActionDeprecated formatted to JSON */ 1357 nlohmann::json::object_t actionDeprecated(std::string_view arg1); 1358 1359 void actionDeprecated(crow::Response& res, std::string_view arg1); 1360 1361 /** 1362 * @brief Formats NetworkNameResolutionNotConfigured message into JSON 1363 * Message body: "Network name resolution is not configured on this service." 1364 * 1365 * 1366 * @returns Message NetworkNameResolutionNotConfigured formatted to JSON */ 1367 nlohmann::json::object_t networkNameResolutionNotConfigured(); 1368 1369 void networkNameResolutionNotConfigured(crow::Response& res); 1370 1371 /** 1372 * @brief Formats NetworkNameResolutionNotSupported message into JSON 1373 * Message body: "Resolution of network-based names is not supported by this 1374 * service." 1375 * 1376 * 1377 * @returns Message NetworkNameResolutionNotSupported formatted to JSON */ 1378 nlohmann::json::object_t networkNameResolutionNotSupported(); 1379 1380 void networkNameResolutionNotSupported(crow::Response& res); 1381 1382 /** 1383 * @brief Formats ServiceDisabled message into JSON 1384 * Message body: "The operation failed because the service at <arg1> is disabled 1385 * and cannot accept requests." 1386 * 1387 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1388 * 1389 * @returns Message ServiceDisabled formatted to JSON */ 1390 nlohmann::json::object_t serviceDisabled(std::string_view arg1); 1391 1392 void serviceDisabled(crow::Response& res, std::string_view arg1); 1393 1394 /** 1395 * @brief Formats EventBufferExceeded message into JSON 1396 * Message body: "Undelivered events may have been lost due to exceeding the 1397 * event buffer." 1398 * 1399 * 1400 * @returns Message EventBufferExceeded formatted to JSON */ 1401 nlohmann::json::object_t eventBufferExceeded(); 1402 1403 void eventBufferExceeded(crow::Response& res); 1404 1405 /** 1406 * @brief Formats AuthenticationTokenRequired message into JSON 1407 * Message body: "The request could not be performed because an authentication 1408 * token was not provided." 1409 * 1410 * 1411 * @returns Message AuthenticationTokenRequired formatted to JSON */ 1412 nlohmann::json::object_t authenticationTokenRequired(); 1413 1414 void authenticationTokenRequired(crow::Response& res); 1415 1416 /** 1417 * @brief Formats OneTimePasscodeSent message into JSON 1418 * Message body: "A one-time passcode was sent to: <arg1>. Supply the passcode 1419 * as the `Token` property in the request to create a session." 1420 * 1421 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1422 * 1423 * @returns Message OneTimePasscodeSent formatted to JSON */ 1424 nlohmann::json::object_t oneTimePasscodeSent(std::string_view arg1); 1425 1426 void oneTimePasscodeSent(crow::Response& res, std::string_view arg1); 1427 1428 /** 1429 * @brief Formats LicenseRequired message into JSON 1430 * Message body: "A license is required for this operation: <arg1>." 1431 * 1432 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1433 * 1434 * @returns Message LicenseRequired formatted to JSON */ 1435 nlohmann::json::object_t licenseRequired(std::string_view arg1); 1436 1437 void licenseRequired(crow::Response& res, std::string_view arg1); 1438 1439 /** 1440 * @brief Formats PropertyModified message into JSON 1441 * Message body: "One or more properties were successfully modified." 1442 * 1443 * 1444 * @returns Message PropertyModified formatted to JSON */ 1445 nlohmann::json::object_t propertyModified(); 1446 1447 void propertyModified(crow::Response& res); 1448 1449 /** 1450 * @brief Formats GenerateSecretKeyRequired message into JSON 1451 * Message body: "The Time-based One-Time Password (TOTP) secret key for this 1452 * account must be generated before access is granted. Perform the 1453 * GenerateSecretKey action at URI <arg1> and retain the secret key from the 1454 * response." 1455 * 1456 * @param[in] arg1 Parameter of message that will replace %1 in its body. 1457 * 1458 * @returns Message GenerateSecretKeyRequired formatted to JSON */ 1459 nlohmann::json::object_t generateSecretKeyRequired( 1460 const boost::urls::url_view_base& arg1); 1461 1462 void generateSecretKeyRequired(crow::Response& res, 1463 const boost::urls::url_view_base& arg1); 1464 1465 } // namespace messages 1466 } // namespace redfish 1467