summaryrefslogtreecommitdiffstats
path: root/rest-api.md
Commit message (Collapse)AuthorAgeFilesLines
* Update rest-api.md for bmcwebMatt Spinler2019-02-011-38/+24
| | | | | | | | 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>
* rest-api.md: Add upload return codesAdriana Kobylak2018-04-111-0/+19
| | | | | | | | | | 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>
* Event notification doc : key name fixupsDeepak Kodihalli2018-03-071-3/+3
| | | | | Change-Id: Icc0773101ac12b9ac33331fa16d11fe7e786526a Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>
* Change //bmc/ to //${bmc}/ in examplesGunnar Mills2017-12-041-17/+17
| | | | | | | | | 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>
* Fix POST curl examples in rest-api.mdGunnar Mills2017-11-201-9/+8
| | | | | | | | 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>
* Fix PUT curl examples in rest-api.mdGunnar Mills2017-11-201-14/+31
| | | | | | | | 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>
* Fix DELETE curl examples in rest-api.mdGunnar Mills2017-11-201-5/+5
| | | | | | | | 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>
* Fix GET curl examples in rest-api.mdGunnar Mills2017-11-201-32/+64
| | | | | | | | 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>
* Spelling fixesGunnar Mills2017-10-251-2/+2
| | | | | | | | | 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>
* rest-api: document event subscription protocolDeepak Kodihalli2017-10-251-0/+94
| | | | | | | Resolves openbmc/openbmc#2317. Change-Id: Ic7ec575f77f5bc5ee44109fcff5b3d69a2b1982c Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>
* Use correct "D-Bus" spelling in rest-api.mdGunnar Mills2017-07-051-4/+4
| | | | | | | Change "dbus" and "DBUS" to the correct spelling "D-Bus". Change-Id: I30214d0c2e646857c21010d75f8d1a4560dd2a54 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* rest-api: document '/upload/image' route usageDeepak Kodihalli2017-04-211-0/+19
| | | | | Change-Id: I4ed9e67bf19646da4b418a3e002a4c17a4e0bd3e Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>
* Minor spelling fixesMilton Miller2016-07-111-1/+1
| | | | | | | | | | 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>
* rest-api: Fix capitalisation of 'Just'Andrew Jeffery2016-05-121-1/+1
| | | | Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* rest-api.md: Fix 'emumerate' typoAndrew Jeffery2016-05-121-1/+1
| | | | Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* rest-api: Restructure and expand, and improve example codeJeremy Kerr2016-05-051-94/+163
| | | | | | | | | | | | 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>
* Add login/logout examplesBrad Bishop2015-12-021-25/+39
|
* Rest API documentation fixesBrad Bishop2015-11-201-6/+13
| | | | | | HTTP verbs need to be upper case. -k appeared twice in some examples. Add delete description and example.
* REST API updatesBrad Bishop2015-11-091-28/+45
| | | | | | | I am working on a number of API (json format) changes. Use https:// instead of http:// Show how to set the Content-Type HTTP header. Show how to set the HTTP verb.
* Add REST API examplesBrad Bishop2015-10-291-0/+81
OpenPOWER on IntegriCloud