Uploaded image for project: 'Calcite'
  1. Calcite
  2. CALCITE-1029

Add "purpose" explanations to Avatica JSON docs

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.6.0
    • Component/s: site
    • Labels:
      None

      Description

      Looking at the JSON docs again, they serve as a easily viewable/readable source for what objects (requests, responses, and "other") might be used with the JSON API. An area in which it is lacking is how each of these objects is actually used.

      Add a brief explanation to each object that describe how (and why, if necessary to give adequate explanation to "how") each are used, similar to a class-level Javadoc comment feel.

        Attachments

          Activity

            People

            • Assignee:
              elserj Josh Elser
              Reporter:
              elserj Josh Elser
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: