On Thu, Mar 24, 2022 at 1:50 PM Victor Toso <victort...@redhat.com> wrote:
>
> * Timestamp is not optional, let's add for completeness.
> * Add '<-' to signalize it is receiving the data
> * While at it, add extra space before "result" and "total"
>
> Signed-off-by: Victor Toso <victort...@redhat.com>
> ---
> qapi/dump.json | 7 ++++---
> 1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/qapi/dump.json b/qapi/dump.json
> index f7c4267e3f..d3ed79e8cd 100644
> --- a/qapi/dump.json
> +++ b/qapi/dump.json
> @@ -161,9 +161,10 @@
> #
> # Example:
> #
> -# { "event": "DUMP_COMPLETED",
> -# "data": {"result": {"total": 1090650112, "status": "completed",
> -# "completed": 1090650112} } }
> +# <- { "event": "DUMP_COMPLETED",
> +# "data": { "result": { "total": 1090650112, "status": "completed",
> +# "completed": 1090650112} },
> +# "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
> #
> ##
> { 'event': 'DUMP_COMPLETED' ,
> --
> 2.35.1
>
Other events seem to use the timestamp as well, so go for it. I agree
that being able to programmatically verify docstrings is pretty
valuable in an API test suite.
(What date did you choose? Does it mean anything to you? :p)
Reviewed-by: John Snow <js...@redhat.com>
