Skip to content

Commit 224266e

Browse files
committed
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 <[email protected]>
1 parent 3707174 commit 224266e

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

rest-api.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# OpenBMC REST API
22

3-
The primary management interface for OpenBMC is REST. This document provides
4-
some basic structure and usage examples for the REST interface.
3+
The OpenBMC REST API is disabled by default in bmcweb. Most of the functionality
4+
is available on Redfish. This document provides some basic structure and usage
5+
examples for the OpenBMC REST interface.
56

67
The schema for the rest interface is directly defined by the OpenBMC D-Bus
78
structure. Therefore, the objects, attributes and methods closely map to those

0 commit comments

Comments
 (0)