qemu/qapi/introspect.json

1 # -*- Mode: Python -*-
9 # This work is licensed under the terms of the GNU GPL, version 2 or later.
10 # See the COPYING file in the top-level directory.
17 # @query-qmp-schema:
19 # Command query-qmp-schema exposes the QMP wire ABI as an array of
28 # Furthermore, while we strive to keep the QMP wire format
29 # backwards-compatible across qemu versions, the introspection output
32 # non-variant, while another lists the same member only through the
42 #     with different meta-types).
46 #    QMP wire ABI, and therefore not returned by this command.
50 { 'command': 'query-qmp-schema',
52   'allow-preconfig': true }
86 #     names, type names are not part of the wire ABI.  Consequently,
88 #     guaranteed unique regardless of @meta-type.
90 # @meta-type: the entity's meta type, inherited from @base.
99   'base': { 'name': 'str', 'meta-type': 'SchemaMetaType',
101   'discriminator': 'meta-type',
114 # Additional SchemaInfo members for meta-type 'builtin'.
116 # @json-type: the JSON type used for this type on the wire.
121   'data': { 'json-type': 'JSONType' } }
155 # Additional SchemaInfo members for meta-type 'enum'.
168 # Values of this type are JSON string on the wire.
195 # Additional SchemaInfo members for meta-type 'array'.
197 # @element-type: the array type's element type.
199 # Values of this type are JSON array on the wire.
204   'data': { 'element-type': 'str' } }
209 # Additional SchemaInfo members for meta-type 'object'.
211 # @members: the object type's (non-variant) members, in no particular
222 # Values of this type are JSON object on the wire.
243 #     specified here.  Future extension: if present and non-null, the
274 # Additional SchemaInfo members for meta-type 'alternate'.
277 #     members' wire encoding is distinct, see
278 #     :doc:`/devel/qapi-code-gen` section Alternate types.
280 # On the wire, this can be any of the members.
302 # Additional SchemaInfo members for meta-type 'command'.
304 # @arg-type: the name of the object type that provides the command's
307 # @ret-type: the name of the command's result type.
309 # @allow-oob: whether the command allows out-of-band execution,
312 # TODO: @success-response (currently irrelevant, because it's QGA, not
318   'data': { 'arg-type': 'str', 'ret-type': 'str',
319             '*allow-oob': 'bool' } }
324 # Additional SchemaInfo members for meta-type 'event'.
326 # @arg-type: the name of the object type that provides the event's
332   'data': { 'arg-type': 'str' } }