Skip to contentSkip to conversation

Document about the REST interface

DISCUSSION Xiaochao Ma (马小超) 4 participants 4 messages Aug 29, 2019 – Aug 30, 2019

lore
Share & tools
lore
#0 lore raw

I wrote a document about the REST interface (contains the REDFISH section ).
It contains all the commands in REST-cheatsheet.md , REDFISH-cheatsheet.md and a REST related document. This document includes power, FW update, time settings, event log and related commands. All commands have been run on the fp5280g2 machine.
I want to upload this document to openbmc/docs because I think this document is good for the community. Can this document be accepted?
Here is the link:
https://github.com/inspur-bmc/openbmc-doc/blob/master/user's%20guide.md

#1 lore raw

Hi Ma,

Thanks for putting this together. Could you please create a pull request so that it can go through the review process ?

!! Vishwa !!

Quoted 10 lines · Xiaochao Ma (马小超)

I wrote a document about the REST interface (contains the REDFISH section ).
It contains all the commands in REST-cheatsheet.md , REDFISH-cheatsheet.md and a REST related document. This document includes power, FW update, time settings, event log and related commands. All commands have been run on the fp5280g2 machine.
I want to upload this document to openbmc/docs because I think this document is good for the community. Can this document be accepted?
Here is the link:
https://github.com/inspur-bmc/openbmc-doc/blob/master/user's%20guide.md

#2 lore raw
Quoted 4 lines · vishwa

Hi Ma,

Thanks for putting this together. Could you please create a pull request so that it can go through the review process ?

Here are the guides to submitting a patch via gerrit:

https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes-via-gerrit-server
https://github.com/openbmc/docs/blob/master/development/gerrit-setup.md

Quoted 18 lines

!! Vishwa !!

Quoted 12 lines · Xiaochao Ma (马小超)

I wrote a document about the REST interface (contains the REDFISH section ).
It contains all the commands in REST-cheatsheet.md , REDFISH-cheatsheet.md and a REST related document.
This document includes power, FW update, time settings, event log and related commands.
All commands have been run on the fp5280g2 machine.
I want to upload this document to openbmc/docs because I think this document is good for the community.
Can this document be accepted?
Here is the link:

https://github.com/inspur-bmc/openbmc-doc/blob/master/user's%20guide.md

#3 lore raw

That is a good document (although it contains some non-English characters, which could be fixed later).

I have a question that if it is meant to replace the existing REST API related document or not.
If it is sent as a new document, my concern would be that we will have too many documents with the same topic.
How about split this document into parts:
1. The REST APIs introduction to replace the current rest-api.md
2. The REST cheatsheet part, to replace the REST-cheatsheet.md

By "replace" I mean this new doc contains up-to-date information while the existing docs contain some out-of-date information, so the new doc could replace the existing ones.

Quoted 30 lines · Adriana Kobylak
Quoted 4 lines · vishwa

Hi Ma,

Thanks for putting this together. Could you please create a pull request so that it can go through the review process ?

Here are the guides to submitting a patch via gerrit:

https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes-via-gerrit-server
https://github.com/openbmc/docs/blob/master/development/gerrit-setup.md

Quoted 18 lines

!! Vishwa !!

Quoted 12 lines · Xiaochao Ma (马小超)

I wrote a document about the REST interface (contains the REDFISH section ).
It contains all the commands in REST-cheatsheet.md , REDFISH-cheatsheet.md and a REST related document.
This document includes power, FW update, time settings, event log and related commands.
All commands have been run on the fp5280g2 machine.
I want to upload this document to openbmc/docs because I think this document is good for the community.
Can this document be accepted?
Here is the link:

https://github.com/inspur-bmc/openbmc-doc/blob/master/user's%20guide.md