xref: /openbmc/qemu/storage-daemon/qapi/qapi-schema.json (revision 0d70c5aa1bbfb0f5099d53d6e084337a8246cc0c)
1# -*- Mode: Python -*-
2# vim: filetype=python
3
4# Note that modules are shared with the QEMU main schema under the assumption
5# that the storage daemon schema is a subset of the main schema. For the shared
6# modules, no code is generated here, but we reuse the code files generated
7# from the main schema.
8#
9# If you wish to extend the storage daemon schema to contain things that are
10# not in the main schema, be aware that array types of types defined in shared
11# modules are only generated if an array of the respective type is already used
12# in the main schema. Therefore, if you use such arrays, you may need to define
13# the array type in the main schema, even if it is unused outside of the
14# storage daemon.
15
16##
17# ************
18# Introduction
19# ************
20#
21# This manual describes the commands and events supported by the QEMU
22# storage daemon QMP.
23#
24# For locating a particular item, please see the `qapi-qsd-index`.
25#
26# The following notation is used in examples:
27#
28# .. qmp-example::
29#
30#   -> ... text sent by client (commands) ...
31#   <- ... text sent by server (command responses and events) ...
32#
33# Example text is formatted for readability.  However, in real
34# protocol usage, its commonly emitted as a single line.
35#
36# Please refer to the
37# :doc:`QEMU Machine Protocol Specification </interop/qmp-spec>`
38# for the general format of commands, responses, and events.
39##
40
41
42{ 'include': '../../qapi/pragma.json' }
43
44# Documentation generated with qapi-gen.py is in source order, with
45# included sub-schemas inserted at the first include directive
46# (subsequent include directives have no effect).  To get a sane and
47# stable order, it's best to include each sub-schema just once, or
48# include it first right here.
49
50{ 'include': '../../qapi/common.json' }
51{ 'include': '../../qapi/sockets.json' }
52{ 'include': '../../qapi/crypto.json' }
53{ 'include': '../../qapi/job.json' }
54
55##
56# *************
57# Block devices
58# *************
59##
60{ 'include': '../../qapi/block-core.json' }
61{ 'include': '../../qapi/block-export.json' }
62
63{ 'include': '../../qapi/char.json' }
64{ 'include': '../../qapi/authz.json' }
65{ 'include': '../../qapi/transaction.json' }
66{ 'include': '../../qapi/control.json' }
67{ 'include': '../../qapi/introspect.json' }
68{ 'include': '../../qapi/qom.json' }
69