schemas: fix: wrong field name 'data' in client snapshot msg examples

[PATCH] schemas: fix: wrong field name 'data' in client snapshot msg examples

Fabian Holler posted 1 patch 2 years, 2 months ago

Download mbox

Test checkpatch passed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20220222141431.43559-1-fabian.holler@simplesurance.de

Maintainers: Eric Blake <eblake@redhat.com>, "Dr. David Alan Gilbert" <dgilbert@redhat.com>, Markus Armbruster <armbru@redhat.com>, Juan Quintela <quintela@redhat.com>

qapi/migration.json | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

Expand all Fold all

[PATCH] schemas: fix: wrong field name 'data' in client snapshot msg examples

Posted by Fabian Holler 2 years, 2 months ago

The examples for the snapshot-* commands documented that arguments for
the commands must be passed in a 'data' field.
This is wrong, passing them in a "data" field results in
the error:
  {"error": {"class": "GenericError", "desc": "QMP input member 'data'
		       is unexpected"}}

Arguments are expected to be passed in an field called "arguments".
Replace "data" with "arguments" in the snapshot-* command examples.

Signed-off-by: Fabian Holler <fabian.holler@simplesurance.de>
---
 qapi/migration.json | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/qapi/migration.json b/qapi/migration.json
index 5975a0e104..1c6296897d 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -1888,7 +1888,7 @@
 # Example:
 #
 # -> { "execute": "snapshot-save",
-#      "data": {
+#      "arguments": {
 #         "job-id": "snapsave0",
 #         "tag": "my-snap",
 #         "vmstate": "disk0",
@@ -1949,7 +1949,7 @@
 # Example:
 #
 # -> { "execute": "snapshot-load",
-#      "data": {
+#      "arguments": {
 #         "job-id": "snapload0",
 #         "tag": "my-snap",
 #         "vmstate": "disk0",
@@ -2002,7 +2002,7 @@
 # Example:
 #
 # -> { "execute": "snapshot-delete",
-#      "data": {
+#      "arguments": {
 #         "job-id": "snapdelete0",
 #         "tag": "my-snap",
 #         "devices": ["disk0", "disk1"]
-- 
2.35.1

Re: [PATCH] schemas: fix: wrong field name 'data' in client snapshot msg examples

Posted by Markus Armbruster 2 years, 2 months ago

Recommend to tweak the title to something like

    qapi/migration: Fix examples ...

Fabian Holler <fabian.holler@simplesurance.de> writes:

> The examples for the snapshot-* commands documented that arguments for

document

> the commands must be passed in a 'data' field.
> This is wrong, passing them in a "data" field results in
> the error:
>   {"error": {"class": "GenericError", "desc": "QMP input member 'data'
> 		       is unexpected"}}
>
> Arguments are expected to be passed in an field called "arguments".
> Replace "data" with "arguments" in the snapshot-* command examples.
>
> Signed-off-by: Fabian Holler <fabian.holler@simplesurance.de>
> ---
>  qapi/migration.json | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/qapi/migration.json b/qapi/migration.json
> index 5975a0e104..1c6296897d 100644
> --- a/qapi/migration.json
> +++ b/qapi/migration.json

Please also fix this one:

   # Example:
   #   {"command": "calc-dirty-rate", "data": {"calc-time": 1,
   #                                           'sample-pages': 512} }
   #

> @@ -1888,7 +1888,7 @@
>  # Example:
>  #
>  # -> { "execute": "snapshot-save",
> -#      "data": {
> +#      "arguments": {
>  #         "job-id": "snapsave0",
>  #         "tag": "my-snap",
>  #         "vmstate": "disk0",
> @@ -1949,7 +1949,7 @@
>  # Example:
>  #
>  # -> { "execute": "snapshot-load",
> -#      "data": {
> +#      "arguments": {
>  #         "job-id": "snapload0",
>  #         "tag": "my-snap",
>  #         "vmstate": "disk0",
> @@ -2002,7 +2002,7 @@
>  # Example:
>  #
>  # -> { "execute": "snapshot-delete",
> -#      "data": {
> +#      "arguments": {
>  #         "job-id": "snapdelete0",
>  #         "tag": "my-snap",
>  #         "devices": ["disk0", "disk1"]

Good catch!