Uploaded image for project: 'JOC - JobScheduler Operations Center'
  1. JOC - JobScheduler Operations Center
  2. JOC-1283

Rework the JS7 API for better consistency

    XMLWordPrintable

Details

    Description

      Improvements

      • The JS7 REST Web Service API requires improvements. Main pain points include:
        • inconsistent wording of web services
          • for example: /iam/identityservice/rename is in fact a replace operation
        • inconsistent wording of web service parameterization
          • for example: /inventory/repository/git/clone makes use of a remoteUri that in fact is a remoteUrl
        • inconsistent return values
          • properties in return values should carry the same names when used as parameters across a number of web services
        • inapplicable use of IDs
          • for example: /configurations, /configuration
        • missing input checks
          • a number of web services do not properly check parameterization
          • for example: /iam/identityservice/store does not check the ordering parameter
        • missing documentation
          • for example: /xmleditor, /configurations, /configuration
        • design problems
          • in order to hide an Agent the full Agent configuration has to be specified which is error-prone
          • in order to manage profiles the api for manage configurations is used. There should be CRUD operations with a profiles api directly.
      • The JOC Cockpit GUI requires improvements for more efficient use of the API
        • when hiding an Agent then the GUI requests the list of all Agents to be stored

      Attachments

        Activity

          People

            oh Oliver Haufe
            ap Andreas PĆ¼schel
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: