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 RE

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>

show more ...

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

Change-Id: I35ec9c19ae581e4dd00b515c1bba3a9c1862eeb1
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...

Move code-update directory to architecture

It makes sense to have the code-update documents under
architecture instead of at the top directory.

Change-Id: Ie850a12adf0507307ca29edddaaff67756c35029

Move code-update directory to architecture

It makes sense to have the code-update documents under
architecture instead of at the top directory.

Change-Id: Ie850a12adf0507307ca29edddaaff67756c35029
Signed-off-by: Adriana Kobylak <anoo@us.ibm.com>

show more ...

Optimize REDFISH and REST documents

Optimized several documents about REST and REDFISH.
Add new command and fix out-of-date commands.
Tested on fp5280g2 that all commands are working on openbmc vers

Optimize REDFISH and REST documents

Optimized several documents about REST and REDFISH.
Add new command and fix out-of-date commands.
Tested on fp5280g2 that all commands are working on openbmc version
2.8.0-dev-434-g48f8ce5a5-dirty.

Signed-off-by: Xiaochao Ma <maxiaochao@inspur.com>
Change-Id: Ibbf1857cef327e57cceb5ac9f206ddf10601cb42

show more ...

Update rest-api.md for bmcweb

Point at REST-cheatsheet.md for details on how to authenticate.
Remove the now unecessary cjar and ContentType arguments.

Change-Id: I0b6024e98719dd610e0d85d6d05067c0a

Update rest-api.md for bmcweb

Point at REST-cheatsheet.md for details on how to authenticate.
Remove the now unecessary cjar and ContentType arguments.

Change-Id: I0b6024e98719dd610e0d85d6d05067c0aa0c21ec
Signed-off-by: Matt Spinler <spinler@us.ibm.com>

show more ...

rest-api.md: Add upload return codes

With change https://gerrit.openbmc-project.xyz/#/c/9594/
the upload method now returns the version id
of the uploaded file or error. Update the documentation wit

rest-api.md: Add upload return codes

With change https://gerrit.openbmc-project.xyz/#/c/9594/
the upload method now returns the version id
of the uploaded file or error. Update the documentation with the
possible return information.

Change-Id: I76429bac378b58fd08e4fe5030b89e57f743fb1a
Signed-off-by: Adriana Kobylak <anoo@us.ibm.com>

show more ...

Event notification doc : key name fixups

Change-Id: Icc0773101ac12b9ac33331fa16d11fe7e786526a
Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>

Change //bmc/ to //${bmc}/ in examples

Changed the example calls from //bmc/ to //${bmc}/.
This is more obvious and users can set bmc to their bmc ip
and just copy/paste these example calls.

Change

Change //bmc/ to //${bmc}/ in examples

Changed the example calls from //bmc/ to //${bmc}/.
This is more obvious and users can set bmc to their bmc ip
and just copy/paste these example calls.

Change-Id: I5bb2794fc80121ca793acf2d8cdd2fa27f56596b
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Fix POST curl examples in rest-api.md

The POST curl example calls in rest-api.md used the old
/org/openbmc, update to /xyz/openbmc_project/.

Change-Id: Ib67827e94b1b47a5ab6bd0ed4107e78e73f88b48
Sig

Fix POST curl examples in rest-api.md

The POST curl example calls in rest-api.md used the old
/org/openbmc, update to /xyz/openbmc_project/.

Change-Id: Ib67827e94b1b47a5ab6bd0ed4107e78e73f88b48
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Fix PUT curl examples in rest-api.md

The PUT curl example calls in rest-api.md used the old
/org/openbmc, update to /xyz/openbmc_project/.

Change-Id: I7b09aba752608fe9d43b55349ddffb0db8df6526
Signe

Fix PUT curl examples in rest-api.md

The PUT curl example calls in rest-api.md used the old
/org/openbmc, update to /xyz/openbmc_project/.

Change-Id: I7b09aba752608fe9d43b55349ddffb0db8df6526
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Fix DELETE curl examples in rest-api.md

The DELETE curl example calls in rest-api.md used the old
/org/openbmc, update to /xyz/openbmc_project/.

Change-Id: I388598d09db4ee6c89ace1637fd3a5817b76cdce

Fix DELETE curl examples in rest-api.md

The DELETE curl example calls in rest-api.md used the old
/org/openbmc, update to /xyz/openbmc_project/.

Change-Id: I388598d09db4ee6c89ace1637fd3a5817b76cdce
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Fix GET curl examples in rest-api.md

The GET curl example calls in rest-api.md used the old
/org/openbmc, update to /xyz/openbmc_project/.

Change-Id: Ie0c6ab3fca0f72813dab7b8aa0082a90f8d94deb
Signe

Fix GET curl examples in rest-api.md

The GET curl example calls in rest-api.md used the old
/org/openbmc, update to /xyz/openbmc_project/.

Change-Id: Ie0c6ab3fca0f72813dab7b8aa0082a90f8d94deb
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

Spelling fixes

Spelling errors found using github.com/lucasdemarchi/codespell
A tool to fix common misspellings.
This tool is licensed under GNU General Public License, version 2.

Change-Id: Ia3dd3

Spelling fixes

Spelling errors found using github.com/lucasdemarchi/codespell
A tool to fix common misspellings.
This tool is licensed under GNU General Public License, version 2.

Change-Id: Ia3dd39a0f7aa9e9146c0dc9888160e77d312615c
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

rest-api: document event subscription protocol

Resolves openbmc/openbmc#2317.

Change-Id: Ic7ec575f77f5bc5ee44109fcff5b3d69a2b1982c
Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>

Use correct "D-Bus" spelling in rest-api.md

Change "dbus" and "DBUS" to the correct spelling "D-Bus".

Change-Id: I30214d0c2e646857c21010d75f8d1a4560dd2a54
Signed-off-by: Gunnar Mills <gmills@us.ibm

Use correct "D-Bus" spelling in rest-api.md

Change "dbus" and "DBUS" to the correct spelling "D-Bus".

Change-Id: I30214d0c2e646857c21010d75f8d1a4560dd2a54
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

rest-api: document '/upload/image' route usage

Change-Id: I4ed9e67bf19646da4b418a3e002a4c17a4e0bd3e
Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>

Merge pull request #32 from mdmillerii/trival-1

Small documentation fixes

Minor spelling fixes

Reviewing my recent update in gedit showed a few spelling typos
in code-update.md. I also noticed the possible auto-correct
that put a backquote before an e in rest-api.md. Af

Minor spelling fixes

Reviewing my recent update in gedit showed a few spelling typos
in code-update.md. I also noticed the possible auto-correct
that put a backquote before an e in rest-api.md. After that I
ran the remaining files through gedit looking for mis-spelled
words and found a few with missing letters.

Signed-off-by: Milton Miller <miltonm@us.ibm.com>

show more ...

rest-api: Fix capitalisation of 'Just'

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

rest-api.md: Fix 'emumerate' typo

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

rest-api: Restructure and expand, and improve example code

This change restructures the rest-api document a little, so that it's
more in a manual format.

Also, we simplify the command-line examples

rest-api: Restructure and expand, and improve example code

This change restructures the rest-api document a little, so that it's
more in a manual format.

Also, we simplify the command-line examples a little, by only providing
the cjar-specific options where required; use single-quoting to avoid
lots of shell escaping; add command output where suitable, and wrap to
prevent long lines.

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>

show more ...

Merge pull request #8 from bradbishop/master

Add login/logout examples

Add login/logout examples

Merge pull request #7 from bradbishop/master

Rest API documentation fixes

Rest API documentation fixes

HTTP verbs need to be upper case.
-k appeared twice in some examples.
Add delete description and example.