[GEODE-2839] Enhance OQL portions of REST API developer documentation

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: docs, rest (dev)
• Assignee: Unassigned
• Reporter: Michael W. Dodge
• Created: 28/Apr/17 17:02
• Updated: 08/May/17 18:05

Description

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.