Use nested JSON syntax in `unikraft api`

[jedevc]

unikraft api is quite nice. However, in the -d flag, it only takes full JSON bodies.

Ideally we would also support something like the nested JSON syntax of https://httpie.io/docs/cli/nested-json, and make sure it's documented on our generated markdown docs (like here). Also see the docs here: https://unikraft.com/docs/api/platform/v1/instances

Examples:

• unikraft api /v1/volumes name=data size_mb:=256
• unikraft api /v1/something 'tags[]=production' 'tags[]=eu-west'

Internal issue: https://linear.app/unikraft/issue/TOOL-927/use-nested-json-syntax-in-unikraft-api

[khatibomar]

@jedevc I would like to contribute to this issue.

[jedevc]

Absolutely! Does it make sense how this would work, etc?

[khatibomar]

Absolutely! Does it make sense how this would work, etc?

@jedevc based on what understood we need to support both of:

unikraft api /endpoint -d JSON
unikraft api /endpoint nested-json

if we detect a -d means the following input is being passed as a JSON
if -d absent means it's a nested
what if there is a multiple -d flags passed? should we combine them or simply reject? if yes what if same field appeared in both do we just take latest?

same for latter.

[jedevc]

I actually wonder if maybe we should drop the -d flag entirely.

So instead, it looks like:

• unikraft api /endpoint JSON
• unikraft api /endpoint nested-json

And we auto-determine based on what's there. Maybe you could even combine? Like:

• unikraft api /v1/volumes name=data {"size_mb": 256}
  And it would auto-merge them.

[jedevc]

Although I guess we should still support the -d flag for backwards-compat - but I think we should drop it going forwards.

[khatibomar]

@jedevc what about passing a file and stdin? they should be auto supported without having -d flag?

[khatibomar]

created a draft PR #389

need to do some testing and work on docs part.

Meanwhile feel free to review approach and leave comments.