xref: /openbmc/bmcweb/features/redfish/include/registries/heartbeat_event_message_registry.hpp (revision 4a102cd48c588d32c0a4d6610b4a9ed616f255f3)
140e9b92eSEd Tanous // SPDX-License-Identifier: Apache-2.0
240e9b92eSEd Tanous // SPDX-FileCopyrightText: Copyright OpenBMC Authors
3665e7602SGunnar Mills #pragma once
4665e7602SGunnar Mills /****************************************************************
5665e7602SGunnar Mills  *                 READ THIS WARNING FIRST
6665e7602SGunnar Mills  * This is an auto-generated header which contains definitions
7665e7602SGunnar Mills  * for Redfish DMTF defined messages.
8665e7602SGunnar Mills  * DO NOT modify this registry outside of running the
9665e7602SGunnar Mills  * parse_registries.py script.  The definitions contained within
10665e7602SGunnar Mills  * this file are owned by DMTF.  Any modifications to these files
11665e7602SGunnar Mills  * should be first pushed to the relevant registry in the DMTF
12665e7602SGunnar Mills  * github organization.
13665e7602SGunnar Mills  ***************************************************************/
14665e7602SGunnar Mills #include "registries.hpp"
15665e7602SGunnar Mills 
16665e7602SGunnar Mills #include <array>
17665e7602SGunnar Mills 
18665e7602SGunnar Mills // clang-format off
19665e7602SGunnar Mills 
20*4a102cd4SPatrick Williams namespace redfish::registries
21665e7602SGunnar Mills {
22*4a102cd4SPatrick Williams struct HeartbeatEvent
23*4a102cd4SPatrick Williams {
24*4a102cd4SPatrick Williams static constexpr Header header = {
25665e7602SGunnar Mills     "Copyright 2021-2023 DMTF. All rights reserved.",
26665e7602SGunnar Mills     "#MessageRegistry.v1_6_2.MessageRegistry",
2756b81992SEd Tanous     1,
2856b81992SEd Tanous     0,
2956b81992SEd Tanous     1,
30665e7602SGunnar Mills     "Heartbeat Event Message Registry",
31665e7602SGunnar Mills     "en",
32665e7602SGunnar Mills     "This registry defines the messages to use for periodic heartbeat, also known as 'keep alive', events.",
33665e7602SGunnar Mills     "HeartbeatEvent",
34665e7602SGunnar Mills     "DMTF",
35665e7602SGunnar Mills };
36*4a102cd4SPatrick Williams 
37*4a102cd4SPatrick Williams static constexpr const char* url =
38665e7602SGunnar Mills     "https://redfish.dmtf.org/registries/HeartbeatEvent.1.0.1.json";
39665e7602SGunnar Mills 
40*4a102cd4SPatrick Williams static constexpr std::array registry =
41665e7602SGunnar Mills {
42665e7602SGunnar Mills     MessageEntry{
43665e7602SGunnar Mills         "RedfishServiceFunctional",
44665e7602SGunnar Mills         {
45665e7602SGunnar Mills             "An event sent periodically upon request to indicates that the Redfish service is functional.",
46665e7602SGunnar Mills             "Redfish service is functional.",
47665e7602SGunnar Mills             "OK",
48665e7602SGunnar Mills             0,
49665e7602SGunnar Mills             {},
50665e7602SGunnar Mills             "None.",
51665e7602SGunnar Mills         }},
52665e7602SGunnar Mills 
53665e7602SGunnar Mills };
54665e7602SGunnar Mills 
55665e7602SGunnar Mills enum class Index
56665e7602SGunnar Mills {
57665e7602SGunnar Mills     redfishServiceFunctional = 0,
58665e7602SGunnar Mills };
59*4a102cd4SPatrick Williams }; // struct heartbeat_event
60*4a102cd4SPatrick Williams 
61*4a102cd4SPatrick Williams [[gnu::constructor]] inline void registerHeartbeatEvent()
62*4a102cd4SPatrick Williams { registerRegistry<HeartbeatEvent>(); }
63*4a102cd4SPatrick Williams 
64*4a102cd4SPatrick Williams } // namespace redfish::registries
65