BMC/OpenBmc/bmcweb.git/redfish-core/include/registries, branch master

Generate update registry

2025-08-18T17:32:35+00:00

Generate the update registry, needed to return correct error messages from update service. Change-Id: Ifaa699cad8531070aea47d2476c1834df7c61e08 Signed-off-by: Alexander Hansen

Add SubordinateOverrides & Fix Log_services privileges

2025-07-11T15:34:56+00:00

SubordinateOverrides: This commit automates the creation of SubordinateOverrides privileges structures from the redfish privilege registry. In addition, it enhances the function of parse_registries.py. It reads SubordinateOverrides privilege registry from DMTF and generates const defines SubordinateOverrides for all the privilege registry entries in the same format that the Privileges struct accepts. Moreover, it generates unique const defines for all SubordinateOverrides target levels. Ex: EthernetInterface SubordinateOverrides has two "Targets": ["Manager", "EthernetInterfaceCollection"]. So parse_registries.py generates two unique const 1) Subordinate override for Manager -> EthernetInterface 2) Subordinate override for Manager -> EthernetInterfaceCollection -> EthernetInterface Note: if SubordinateOverrides privilege gets changed, then it automatically updates that route privilege, but if SubordinateOverrides target gets changed, then the user needs to update that manually. Fix Log_services privileges: In Log_services, some of the privileges not following the Redfish_1.1.0_PrivilegeRegistry registry. This commit contains the following LogServices privileges. 1) POST method ``` ComputerSystem -> LogServiceCollection -> LogService - POST /redfish/v1/Systems//LogServices/EventLog/Actions/LogService.ClearLog/ - POST /redfish/v1/Systems//LogServices/Dump/Actions/LogService.CollectDiagnosticData/ - POST /redfish/v1/Systems//LogServices/Dump/Actions/LogService.ClearLog/ - POST /LogServices/PostCodes/Actions/LogService.ClearLog/ ``` 2) DELETE method ``` ComputerSystem -> LogServiceCollection -> LogService -> LogEntryCollection -> LogEntry - DELETE /redfish/v1/Systems//LogServices/EventLog/Entries// ``` This commit also changes the current privilege 1) ConfigureManager to ConfigureComponents. ``` DELETE /redfish/v1/Systems//LogServices/EventLog/Entries/ ``` 2) ConfigureCompnents -> ConfigureManager ``` POST /redfish/v1/Systems//LogServices/Dump/Actions/LogService.ClearLog/ POST /redfish/v1/Systems//LogServices/EventLog/Actions/LogService.ClearLog/ POST /redfish/v1/Systems//LogServices/Dump/Actions/LogService.CollectDiagnosticData/ ``` Tested: manually tested on Witherspoon system, there is no change in output. Run Redfish validator, with all different Privileges; Error Get: UUID: String '' does not match pattern '' this commit doesn't affect UUID Email sent to openbmc list: https://lists.ozlabs.org/pipermail/openbmc/2021-August/027232.html Change-Id: I37d8a2882f1cfaa59a482083f180fdd0805e2e7d Signed-off-by: Abhishek Patel Signed-off-by: Myung Bae

registries: make registration dynamic

2025-05-20T15:39:45+00:00

Rather than having to manually hook code for registries, add a small registration function to the registry header and use this registration results throughout the registry interactions. Tested: Confirmed registries have same behavior. ``` $ curl -s -k https://localhost:18080/redfish/v1/Registries/ | jq '.Members | map(."@odata.id")' [ "/redfish/v1/Registries/Base", "/redfish/v1/Registries/HeartbeatEvent", "/redfish/v1/Registries/OpenBMC", "/redfish/v1/Registries/ResourceEvent", "/redfish/v1/Registries/TaskEvent", "/redfish/v1/Registries/Telemetry" ] ``` ``` $ curl -s -k https://localhost:18080/redfish/v1/Registries/TaskEvent/TaskEvent | jq ".Messages | keys" [ "TaskAborted", "TaskCancelled", "TaskCompletedOK", "TaskCompletedWarning", "TaskPaused", "TaskProgressChanged", "TaskRemoved", "TaskResumed", "TaskStarted" ] ``` Signed-off-by: Patrick Williams Change-Id: Iaa355420736a2587d9da4e995208d579443ca9b8

Update Environmental registry version to 1.1.0

2025-02-27T02:17:39+00:00

New version includes Leak related messages we need. Testing: Redfish service validator passing Change-Id: Ieca3e5a7bb785ef7fcffb05f86b88bdbf23a3d99 Signed-off-by: Igor Kanyuka

Use SPDX identifiers

2025-01-20T18:44:54+00:00

SPDX identifiers are simpler, and reduce the amount of cruft we have in code files. They are recommended by linux foundation, and therefore we should do as they allow. This patchset does not intend to modify any intent on any existing copyrights or licenses, only to standardize their inclusion. [1] https://www.linuxfoundation.org/blog/blog/copyright-notices-in-open-source-software-projects Change-Id: I935c7c0156caa78fc368c929cebd0f068031e830 Signed-off-by: Ed Tanous

Use raw content URL

2024-12-27T18:45:29+00:00

Replace the message registry URL with the official GitHub raw download URL to give the json content not a web SCM GUI. Change-Id: I0ac800ee3803c9bef3a6a799b20887df84c3c173 Signed-off-by: Milton Miller

Fix URI warning in RSV

2024-12-16T18:04:55+00:00

Redfish service valitator warns: WARNING - PublicationUri: Empty string found - Services should omit properties if not supported This commit adds to our registry the url to the openbmc registry file. Tested: Redfish Service validator no longer returns a warning. Change-Id: Ia54be175490b4e7e00e3c0c4ab8c60dce1b96863 Signed-off-by: Ed Tanous

Make message registries use 2 digit versions

2024-12-10T19:17:16+00:00

Redfish specification, section 9.5.11.2 says: The MessageId property value shall be in the format: ... bmcweb in certain places has incorrectly used the 3 digit version instead of the 2 digit version. This commit fixes that by modifying the parse_registries script to generate 3 separate struct entries to represent the registry version, and parse them where appropriate. MessageRegistryFileCollection uses the 3 digit version. No behavior changes. Message/event log entries use the 2 digit version. This will cause a MessageId change from: Base.1.19.0.InternalError to Base.1.19.InternalError This is a breaking change, so a new option to allow the old behavior is provided. Tested: Redfish Service validator passes. Heartbeat events on EventService show 2 digit versions. Change-Id: I4165e994f73e200f13bed8ea76cb58bee2b69faa Signed-off-by: Ed Tanous

Bump base registry to 1.19.0

2024-10-01T15:22:44+00:00

Adds GenerateSecretKeyRequired registry to the Base for MFA Change-Id: Ia690639b4bebbbd265b223bd626b0eb814103f99 Signed-off-by: Jishnu CM

Add message registry for power button long press

2024-08-28T02:35:21+00:00

When the power button is pressed, it depends on how long the press takes to cause which event to happen [1]. Add a message registry for the power button long press event. [1] https://github.com/openbmc/phosphor-buttons/blob/master/README.md#power-button Tested: 1. Redfish Validator passed. 2. Verify in Redfish log. ''' GET: /redfish/v1/Systems/system/LogServices/EventLog/Entries Response: { "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries", "@odata.type": "#LogEntryCollection.LogEntryCollection", "Description": "Collection of System Event Log Entries", "Members": [ { "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/1724214823", "@odata.type": "#LogEntry.v1_9_0.LogEntry", "Created": "2024-08-21T04:33:43+00:00", "EntryType": "Event", "Id": "1724214823", "Message": "Power Button Long Pressed.", "MessageArgs": [], "MessageId": "OpenBMC.0.1.PowerButtonLongPressed.OK", "Name": "System Event Log Entry", "Severity": "OK" } ], "Members@odata.count": 1, "Name": "System Event Log Entries" } ''' Change-Id: I772c444303c784d086af69e1eab22d9446658d4b Signed-off-by: Chanh Nguyen