Uploaded image for project: 'Configuration Persistence Service'
  1. Configuration Persistence Service
  2. CPS-643

OpenAPI (document) Improvements

XMLWordPrintable

       

      Includes

      1. Ensure all request data is well described
      2. Ensure all response data is well described (not just string for a json object) e.g.
        1. DataNode is described for CPS-Data and CPS-Query interfaces as 'Object' or 'String' (both for request and response data
      3. Ensure examples are correct (eg. no additional formatting for partial object definitions)
      4. For error messages use a 'generic example' at the HTTP error code level

      Scope (create subtasks as needed)

      1. CPS Core
      2. CPS NCMP
      3. DMI Plugin
      4. CPS Temporal

      Preliminary Analysis

      1. what to do about when data is returned

      Out of Scope

      • Deprecated APIs
      • Other functional changes to API

      Note
      Discuss examples with team

            puthuparambil.aditya puthuparambil.aditya
            ToineSiebelink Toine Siebelink
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: