openstack
/
panko
Code Issues Proposed changes

doc: remove talk about query/complex queries 

This does not exist in Panko.

Change-Id: Idf2bf1e40d4675124de4b9335f100ab491dbe7f5
This commit is contained in:
Julien Danjou 2016-09-15 23:14:43 +02:00
parent 02d16e5f70
commit ac051f70eb
1 changed files with 1 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/source/webapi/v2.rst
View File

@ -44,47 +44,7 @@ Events and Traits
Filtering Queries
=================
Panko's REST API currently supports two types of queries. The Simple
Query functionality provides simple filtering on several fields of the
*Sample* type. Complex Query provides the possibility to specify queries
with logical and comparison operators on the fields of *Sample*.
You may also apply filters based on the values of one or more of the
*resource_metadata* field, which you can identify by using *metadata.<field>*
syntax in either type of query. Note, however, that given the free-form
nature of *resource_metadata* field, there is no practical or consistent way
to validate the query fields under *metadata* domain like it is done for
all other fields.
.. note::
The API call will return HTTP 200 OK status for both of the
following cases: when a query with *metadata.<field>* does not match its
value, and when *<field>* itself does not exist in any of the records being
queried.
Simple Query
++++++++++++
Many of the endpoints above accept a query filter argument, which
should be a list of Query data structures. Whatever the endpoint you
want to apply a filter on, you always filter on the fields of the *Sample*
type (for example, if you apply a filter on a query for statistics,
you won't target *duration_start* field of *Statistics*, but *timestamp*
field of *Sample*). See :ref:`api-queries` for how to query the API.
.. autotype:: panko.api.controllers.v2.base.Query
:members:
Event Query
+++++++++++
Event query is similar to simple query, its type EventQuery is actually
a subclass of Query, so EventQuery has every attribute Query has.
But there are some differences. If a field is one of the following:
event_type, message_id, start_timestamp, end_timestamp, then this field
will be applied on event, otherwise it will be treated as trait name and
applied on trait. See :ref:`api-queries` for how to query the API.
See :ref:`api-queries` for how to query the API.
.. autotype:: panko.api.controllers.v2.events.EventQuery
:members: