Details
-
Story
-
Status: Closed
-
Medium
-
Resolution: Done
-
None
Description
CPS-Core (and NCMP) has moduelService method to retrieve module-references (name and revision) for a given Anchor
See org.onap.cps.api.CpsModuleService#getSchemaSet
Issue: naming conflict possible "SchemaSet" already used to represent collection of references (possibly refactor to include flag to indicate yang-resources should be included)
NCMP need to be extended? so the response will include the actual 'yang-resources'
Current Endpoint in NCMP:
/v1/ch/{cm-handle}/modules:
Possible
- /v1/ch/{cm-handle}/modules/yangResources
- /v1/ch/{cm-handle}/yangResources
- /v1/ch/{cm-handle}/modules&includeYangResources=true
- Other ?
so effectively returns the whole SchemaSet
Agreed:
- Rest endpoint
- /v1/ch/{cm-handle}/modules/definitions/
- Response format
- Returns list of array (modules,revision, yangResource content)
- JSON
- to keep the ouput format of yang resource content having \n for newline based on swagger
A/C
- Define & document sizes of SchemaSets ie. number of modules and average module size (for one SchemaSet)
- Agree with team and stakeholders the exact rest endpoint and response format (consider plain text, objects, zipfile etc.)
- Demo end-2-end
Out-of-Scope
- No similar endpoint on CPS-Core just a Java-API method
- CSIT test not need as the functionality is in the same process