Revision 208a6cff doc/rapi.rst
b/doc/rapi.rst | ||
---|---|---|
1289 | 1289 |
It supports the ``dry-run`` argument. |
1290 | 1290 |
|
1291 | 1291 |
|
1292 |
``/2/query/[resource]`` |
|
1293 |
+++++++++++++++++++++++ |
|
1294 |
|
|
1295 |
Requests resource information. Available fields can be found in man |
|
1296 |
pages and using ``/2/query/[resource]/fields``. The resource is one of |
|
1297 |
:pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the :doc:`query2 |
|
1298 |
design document <design-query2>` for more details. |
|
1299 |
|
|
1300 |
Supports the following commands: ``GET``, ``PUT``. |
|
1301 |
|
|
1302 |
``GET`` |
|
1303 |
~~~~~~~ |
|
1304 |
|
|
1305 |
Returns list of included fields and actual data. Takes a query parameter |
|
1306 |
named "fields", containing a comma-separated list of field names. Does |
|
1307 |
not support filtering. |
|
1308 |
|
|
1309 |
``PUT`` |
|
1310 |
~~~~~~~ |
|
1311 |
|
|
1312 |
Returns list of included fields and actual data. The list of requested |
|
1313 |
fields can either be given as the query parameter "fields" or as a body |
|
1314 |
parameter with the same name. The optional body parameter "filter" can |
|
1315 |
be given and must be either ``null`` or a list containing filter |
|
1316 |
operators. |
|
1317 |
|
|
1318 |
|
|
1319 |
``/2/query/[resource]/fields`` |
|
1320 |
++++++++++++++++++++++++++++++ |
|
1321 |
|
|
1322 |
Request list of available fields for a resource. The resource is one of |
|
1323 |
:pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the |
|
1324 |
:doc:`query2 design document <design-query2>` for more details. |
|
1325 |
|
|
1326 |
Supports the following commands: ``GET``. |
|
1327 |
|
|
1328 |
``GET`` |
|
1329 |
~~~~~~~ |
|
1330 |
|
|
1331 |
Returns a list of field descriptions for available fields. Takes an |
|
1332 |
optional query parameter named "fields", containing a comma-separated |
|
1333 |
list of field names. |
|
1334 |
|
|
1335 |
|
|
1292 | 1336 |
``/2/os`` |
1293 | 1337 |
+++++++++ |
1294 | 1338 |
|
Also available in: Unified diff