Uploaded image for project: 'Geode'
  1. Geode
  2. GEODE-2839

Enhance OQL portions of REST API developer documentation

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: docs, rest (dev)
    • Labels:
      None

      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.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              pivotalsarge Michael W. Dodge
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: