Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-2420

Document API for worker management service

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: Qserv
    • Labels:

      Description

      New worker management service exposes its API as an interface to RESTful web service. Many or all "methods" will be wrapped into some sort of Python API, but it would still be useful to document every web service "methods" independently. There is basic documentation in the design document (https://dev.lsstcorp.org/trac/wiki/db/Qserv/WMGRDesign), this needs to be extended with detailed description of what those methods do and what kind of data they accept and return.

      This story involves selecting the right tool.

        Attachments

          Issue Links

            Activity

            Hide
            bvan Brian Van Klaveren added a comment -

            I think we've aggregated all the potential documentation options. This may need to be pushed back a bit until we can decide on the most appropriate option.

            Show
            bvan Brian Van Klaveren added a comment - I think we've aggregated all the potential documentation options. This may need to be pushed back a bit until we can decide on the most appropriate option.
            Hide
            jbecla Jacek Becla added a comment -

            Andy will write some basic doc in markdown, and we will do a refresh once Jonathan is on board and helps us select best long term solution.

            Show
            jbecla Jacek Becla added a comment - Andy will write some basic doc in markdown, and we will do a refresh once Jonathan is on board and helps us select best long term solution.
            Hide
            salnikov Andy Salnikov added a comment -

            Brian, can you review the document that I generated from Python code (manually).

            Show
            salnikov Andy Salnikov added a comment - Brian, can you review the document that I generated from Python code (manually).
            Hide
            bvan Brian Van Klaveren added a comment -

            Looks good. I commented on a few things which wasn't sure about, but the documentation looks okay to me.

            Show
            bvan Brian Van Klaveren added a comment - Looks good. I commented on a few things which wasn't sure about, but the documentation looks okay to me.
            Hide
            salnikov Andy Salnikov added a comment -

            Thanks. applied fixes, merged to master. Done.

            Show
            salnikov Andy Salnikov added a comment - Thanks. applied fixes, merged to master. Done.

              People

              Assignee:
              salnikov Andy Salnikov
              Reporter:
              salnikov Andy Salnikov
              Reviewers:
              Brian Van Klaveren
              Watchers:
              Andy Salnikov, Brian Van Klaveren, Frossie Economou, Jacek Becla, Jonathan Sick, Kian-Tat Lim
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  CI Builds

                  No builds found.