geode-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Dodge (JIRA)" <>
Subject [jira] [Created] (GEODE-2839) Enhance OQL portions of REST API developer documentation
Date Fri, 28 Apr 2017 17:03:04 GMT
Michael Dodge created GEODE-2839:

             Summary: Enhance OQL portions of REST API developer documentation
                 Key: GEODE-2839
             Project: Geode
          Issue Type: Improvement
          Components: docs
            Reporter: Michael Dodge

The documentation for querying has excellent coverage of OQL (developing/query_additional/query_language_features.html)
however it is difficult to get to that coverage from the REST API developer documentation,
e.g., rest_apps/rest_queries.html, rest_apps/post_create_query.html.

* Some functionality differs between ad hoc ("unnamed") queries and created ("named") queries,
in particular whether the "LIKE 'foo%'" construct is supported, and those differences are
not obvious.
* Whilst OQL syntax is discussed in the REST API documentation, there are no hyperlinks to
the OQL documentation.
* The REST API documentation contains a few example of OQL use yet the OQL documentation has
more complete examples.

This message was sent by Atlassian JIRA

View raw message