-
Story
-
Resolution: Done
-
High
-
None
- 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
- Update DMI Interface to use new prefix
- Add "Examples" to all NCMP Open API Schema definitions
- Add "Examples" to all DM-Plugin Open API Schema definitions
A/C
- Follow proposal documented here: https://wiki.onap.org/display/DW/CPS-707+Create+Detailed+NCMP-DMI+interfaces+diagram
- Existing northbound facing rest endpoint should NOT change! (basepath remains /ncmp)
- South-bound (internal) REST endpoint(s) will start with: /ncmpInventory
- "Examples" present for all NCMP Open API Schema definitions
- "Examples" present for all DM-Plugin Open API Schema definitions
1.
|
Separate ncmp and ncmp-inventory endpoints | Closed | renukumari |