commit | 224266ecfd528544e9f5473cc4607d9b6b7c435f | [log] [tgz] |
---|---|---|
author | Gunnar Mills <gmills@us.ibm.com> | Wed Mar 08 13:59:58 2023 -0600 |
committer | Gunnar Mills <gmills@us.ibm.com> | Wed Mar 08 14:06:25 2023 -0600 |
tree | 8c9661f3125f38aee056778970b4db91a1d33c54 | |
parent | 3707174641c1edbdf635e1c19ccdc59ff3c89df8 [diff] |
rest-api: Add warning about default disabled https://github.com/openbmc/phosphor-rest-server has been archived which leaves bmcweb as the only actively developed webserver in OpenBMC. The OpenBMC REST API is disabled by default in bmcweb and has been for a year+. Was very soft with the wording here, could use stronger language like OPENBMC REST being deprecated or unsupported. Could also add -deprecated to the filenames and move these. Changes for the future. Tested: Pushed to my fork and looks good. Change-Id: I693064885c1ba7ea6c3ca7d3381e7c638dbc6649 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
The OpenBMC project is a Linux Foundation project whose goal is to produce a customizable, open-source firmware stack for Baseboard Management Controllers (BMCs). This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.
The features document lists the project's major features with links to more information.
These documents contain details on developing OpenBMC code itself
cheatsheet.md: Quick reference for some common development tasks
CONTRIBUTING.md: Guidelines for contributing to OpenBMC
development tutorials: Tutorials for getting up to speed on OpenBMC development
kernel-development.md: Reference for common kernel development tasks
These documents describe how to use OpenBMC, including using the programmatic interfaces to an OpenBMC system.
code-update: Updating OpenBMC and host platform firmware
console.md: Using the host console
host-management.md: Performing host management tasks with OpenBMC
rest-api.md: Introduction to using the OpenBMC REST API
REDFISH-cheatsheet.md: Quick reference for some common OpenBMC Redfish commands
REST-cheatsheet.md: Quick reference for some common OpenBMC REST API commands