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

Create documentation for RPC message format(s)

    Details

    • Type: Task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.5.0
    • Component/s: avatica
    • Labels:
      None

      Description

      It would be nice to add some documentation for the JSON messages and, if everything goes according to plan, the protobuf messages to the website.

      After doing the protobuf work, I have a fairly good understanding of how the messages work now and would be happy to add some documentation here too.

        Issue Links

          Activity

          Hide
          jcamachorodriguez Jesus Camacho Rodriguez added a comment -

          Resolved in release 1.5.0 (2015-11-10)

          Show
          jcamachorodriguez Jesus Camacho Rodriguez added a comment - Resolved in release 1.5.0 (2015-11-10)
          Show
          julianhyde Julian Hyde added a comment - Fixed in http://git-wip-us.apache.org/repos/asf/incubator-calcite/commit/538a7df8 and deployed to http://calcite.incubator.apache.org/ . Thanks for the PR, Josh Elser !
          Hide
          julianhyde Julian Hyde added a comment -

          Josh Elser Wow, looks very nice. I reviewed, and found some very minor issues. Please let me know when they are fixed.

          Show
          julianhyde Julian Hyde added a comment - Josh Elser Wow, looks very nice. I reviewed, and found some very minor issues. Please let me know when they are fixed.
          Hide
          elserj Josh Elser added a comment -

          Opened up a PR with the rebased patch.

          Show
          elserj Josh Elser added a comment - Opened up a PR with the rebased patch.
          Hide
          elserj Josh Elser added a comment -

          It seems JIRA permissions/workflow has changed. I don't have the ability to "Submit Patch".

          But anyways, here's a patch for some documentation on the website given my understanding of the JSON objects

          For your viewing pleasure, I also hosted it to view the rendered HTML: http://calcite-site.penguinsinabox.com/docs/avatica_overview.html. Note the 3 new pages in the sidebar under "Avatica". The majority of updated text is in the "Reference" page.

          Show
          elserj Josh Elser added a comment - It seems JIRA permissions/workflow has changed. I don't have the ability to "Submit Patch". But anyways, here's a patch for some documentation on the website given my understanding of the JSON objects For your viewing pleasure, I also hosted it to view the rendered HTML: http://calcite-site.penguinsinabox.com/docs/avatica_overview.html . Note the 3 new pages in the sidebar under "Avatica". The majority of updated text is in the "Reference" page.

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Development