search

openmainframeproject / feilong

Feilong is a open source z/VM cloud connector project under the Open Mainframe Project umbrella that will accelerate the z/VM adoption, extending its ecosystem and its user experience. It provides a set of APIs to operate z/VM including guest, image, network, volume etc.
https://www.openmainframeproject.org/projects/feilong
Apache License 2.0
35 stars 70 forks source link

Doc: Register guest: either description or example is wrong #790

Closed Bischoff closed 7 months ago

Bischoff commented 7 months ago

In section https://cloudlib4zvm.readthedocs.io/en/latest/restapi.html#guest-register , one reads:

meta   body  string  The metadata of the vm to be registered.

and

{
   "action": "register_vm",
   "meta": '{"os_version": "sles12sp3"}',
   "net_set": "1",
}

The field meta cannot be both a string and a dictionary. Which one is it?

According to the source code, I think it is rather a string, but I am not 100% sure. If so, what would be a correct example?

Bischoff commented 7 months ago

Oops, I did not see the external single quotes in the example. My bad.

Closing the issue.