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

Separate NCMP southbound (DMI) interface from northbound facing 'client' interface

    XMLWordPrintable

Details

    • Story
    • Status: Closed
    • High
    • Resolution: Done
    • None
    • Jakarta Release
    • DMI, NCMP

    Description

      • Agreed 'basePaths' for interfaces '/ncmp' v. '/ncmpInventory'
      • separate Yaml (swagger) definitions

      See interface definitions in cps-ncmp-rest/docs/openapi/openapi.yml.

      All except one method are Northbound (client) facing. The only Southbound facing method is:

      /v1/ch:
        $ref: 'ncmproxy.yml#/updateDmiRegistration'
      

      BasePath(s) defined in cps-application/src/main/resources/application.yml

      rest:
          api:
              cps-base-path: /cps/api
              ncmp-base-path: /ncmp
      

      TBC, can the one openapi support multiple basepaths?!

      servers:
        - url: /ncmp
      

       Input from stakeholder:

      • Stakeholder want clear separation between 'client' and 'internal' interfaces. Although both need to be available for publication, just different target audiences.
      • Preferred Internal interface pre-fix is /ncmpInventory

      Additional (sub) tasks

      1. Update DMI Interface to use new prefix
      2. Add "Examples" to all NCMP Open API Schema definitions 
      3. Add "Examples" to all DM-Plugin Open API Schema definitions 

      A/C

      1. Follow proposal documented here: https://wiki.onap.org/display/DW/CPS-707+Create+Detailed+NCMP-DMI+interfaces+diagram
      2. Existing northbound facing rest endpoint should NOT change! (basepath remains /ncmp)
      3. South-bound (internal) REST endpoint(s) will start with: /ncmpInventory
      4. "Examples" present for all NCMP Open API Schema definitions
      5. "Examples" present for all DM-Plugin Open API Schema definitions 

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              Unassigned Unassigned
              toinesiebelink Toine Siebelink
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: