type: array
items:
$ref: '#/components/schemas/RestCmHandle'
- example: [my-cm-handle1, my-cm-handle2, my-cm-handle3]
updatedCmHandles:
type: array
items:
type: string
example: my-cm-handle-id
+ ModuleReference:
+ type: object
+ title: Module reference details
+ properties:
+ moduleName:
+ type: string
+ example: my-module-name
+ revision:
+ type: string
+ example: my-module-revision
+
examples:
dataSampleRequest:
summary: Sample request
books:
- authors:
- Iain M. Banks
- - authors:
- Ursula K. Le Guin
- code: '02'
name: kids
categories:
- code: '01'
books:
- - {}
- - {}
+ - authors:
+ - Iain M. Banks
+ - Ursula K. Le Guin
name: SciFi
- code: '02'
books:
- - {}
+ - authors:
+ - Philip Pullman
name: kids
- bookstore-name: Chapters
parameters:
cmHandleInPath:
content:
application/json:
schema:
- type: string
+ type: object
+ examples:
+ dataSampleRequest:
+ $ref: 'components.yaml#/components/examples/dataSampleRequest'
responses:
201:
$ref: 'components.yaml#/components/responses/Created'
content:
application/json:
schema:
- type: string
+ type: object
+ examples:
+ dataSampleRequest:
+ $ref: 'components.yaml#/components/examples/dataSampleRequest'
responses:
200:
$ref: 'components.yaml#/components/responses/Ok'
content:
application/json:
schema:
- type: string
+ type: object
+ examples:
+ dataSampleRequest:
+ $ref: 'components.yaml#/components/examples/dataSampleRequest'
responses:
200:
$ref: 'components.yaml#/components/responses/Ok'
content:
application/json:
schema:
- type: string
+ type: object
+ examples:
+ dataSampleRequest:
+ $ref: 'components.yaml#/components/examples/dataSampleRequest'
responses:
201:
$ref: 'components.yaml#/components/responses/Created'
content:
application/json:
schema:
- type: string
+ type: object
examples:
dataSampleRequest:
$ref: 'components.yaml#/components/examples/dataSampleRequest'
application/yang-data+json:
schema:
- type: string
+ type: object
+ examples:
+ dataSampleRequest:
+ $ref: 'components.yaml#/components/examples/dataSampleRequest'
responses:
201:
$ref: 'components.yaml#/components/responses/Created'
content:
application/json:
schema:
- type: string
+ type: object
examples:
dataSampleRequest:
$ref: 'components.yaml#/components/examples/dataSampleRequest'
application/yang-data+json:
schema:
- type: string
+ type: object
+ examples:
+ dataSampleRequest:
+ $ref: 'components.yaml#/components/examples/dataSampleRequest'
responses:
200:
$ref: 'components.yaml#/components/responses/Ok'
application/json:
schema:
type: object
+ examples:
+ dataSampleRequest:
+ $ref: 'components.yaml#/components/examples/dataSampleRequest'
responses:
200:
$ref: 'components.yaml#/components/responses/Ok'
content:
application/json:
schema:
- type: string
+ type: object
+ examples:
+ dataSampleRequest:
+ $ref: 'components.yaml#/components/examples/dataSampleRequest'
responses:
204:
$ref: 'components.yaml#/components/responses/NoContent'
content:
application/json:
schema:
- type: object
- examples:
- moduleReferencesResponse:
- summary: Sample response
- value:
- - moduleName: my-module-name
- revision: yyyy-mm-dd
- - moduleName: my-module-name-2
- revision: yyyy-mm-dd
+ type: array
+ items:
+ $ref: 'components.yaml#/components/schemas/ModuleReference'
400:
$ref: 'components.yaml#/components/responses/BadRequest'
401:
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
</dependency>
+ <dependency>
+ <groupId>org.modelmapper</groupId>
+ <artifactId>modelmapper</artifactId>
+ </dependency>
<!-- T E S T D E P E N D E N C I E S -->
<dependency>
<groupId>org.codehaus.groovy</groupId>
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import lombok.extern.slf4j.Slf4j;
+import org.modelmapper.ModelMapper;
import org.onap.cps.ncmp.api.NetworkCmProxyDataService;
import org.onap.cps.ncmp.rest.api.NetworkCmProxyApi;
import org.onap.cps.ncmp.rest.model.CmHandleProperties;
import org.onap.cps.ncmp.rest.model.Conditions;
import org.onap.cps.ncmp.rest.model.ModuleNameAsJsonObject;
import org.onap.cps.ncmp.rest.model.ModuleNamesAsJsonArray;
+import org.onap.cps.ncmp.rest.model.ModuleReference;
import org.onap.cps.spi.FetchDescendantsOption;
import org.onap.cps.spi.model.DataNode;
-import org.onap.cps.spi.model.ModuleReference;
import org.onap.cps.utils.DataMapUtils;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
private static final Gson GSON = new GsonBuilder().create();
+ private final ModelMapper modelMapper = new ModelMapper();
private final NetworkCmProxyDataService networkCmProxyDataService;
/**
*/
@Override
@Deprecated(forRemoval = false)
- public ResponseEntity<Void> createNode(final String cmHandle, @Valid final String jsonData,
+ public ResponseEntity<Void> createNode(final String cmHandle, @Valid final Object jsonData,
@Valid final String parentNodeXpath) {
- networkCmProxyDataService.createDataNode(cmHandle, parentNodeXpath, jsonData);
+ networkCmProxyDataService.createDataNode(cmHandle, parentNodeXpath, GSON.toJson(jsonData));
return new ResponseEntity<>(HttpStatus.CREATED);
}
@Override
@Deprecated(forRemoval = false)
public ResponseEntity<Void> addListNodeElements(@NotNull @Valid final String parentNodeXpath,
- final String cmHandle, @Valid final String jsonData) {
- networkCmProxyDataService.addListNodeElements(cmHandle, parentNodeXpath, jsonData);
+ final String cmHandle, @Valid final Object jsonData) {
+ networkCmProxyDataService.addListNodeElements(cmHandle, parentNodeXpath, GSON.toJson(jsonData));
return new ResponseEntity<>(HttpStatus.CREATED);
}
*/
@Override
@Deprecated(forRemoval = false)
- public ResponseEntity<Object> replaceNode(final String cmHandle, @Valid final String jsonData,
+ public ResponseEntity<Object> replaceNode(final String cmHandle, @Valid final Object jsonData,
@Valid final String parentNodeXpath) {
- networkCmProxyDataService.replaceNodeTree(cmHandle, parentNodeXpath, jsonData);
+ networkCmProxyDataService.replaceNodeTree(cmHandle, parentNodeXpath, GSON.toJson(jsonData));
return new ResponseEntity<>(HttpStatus.OK);
}
*/
@Override
@Deprecated(forRemoval = false)
- public ResponseEntity<Object> updateNodeLeaves(final String cmHandle, @Valid final String jsonData,
+ public ResponseEntity<Object> updateNodeLeaves(final String cmHandle, @Valid final Object jsonData,
@Valid final String parentNodeXpath) {
- networkCmProxyDataService.updateNodeLeaves(cmHandle, parentNodeXpath, jsonData);
+ networkCmProxyDataService.updateNodeLeaves(cmHandle, parentNodeXpath, GSON.toJson(jsonData));
return new ResponseEntity<>(HttpStatus.OK);
}
final String cmHandle,
final Object requestBody, final String contentType) {
networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
- resourceIdentifier, PATCH, requestBody.toString(), contentType);
+ resourceIdentifier, PATCH, GSON.toJson(requestBody), contentType);
return new ResponseEntity<>(HttpStatus.OK);
}
*/
@Override
public ResponseEntity<Void> createResourceDataRunningForCmHandle(final String resourceIdentifier,
- final String cmHandle,
- final String requestBody,
- final String contentType) {
+ final String cmHandle, final Object requestBody, final String contentType) {
networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
- resourceIdentifier, CREATE, requestBody, contentType);
+ resourceIdentifier, CREATE, GSON.toJson(requestBody), contentType);
return new ResponseEntity<>(HttpStatus.CREATED);
}
@Override
public ResponseEntity<Object> updateResourceDataRunningForCmHandle(final String resourceIdentifier,
final String cmHandle,
- final String requestBody,
+ final Object requestBody,
final String contentType) {
networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
- resourceIdentifier, UPDATE, requestBody, contentType);
+ resourceIdentifier, UPDATE, GSON.toJson(requestBody), contentType);
return new ResponseEntity<>(HttpStatus.OK);
}
@Override
public ResponseEntity<Void> deleteResourceDataRunningForCmHandle(final String resourceIdentifier,
final String cmHandle,
- final String requestBody,
+ final Object requestBody,
final String contentType) {
networkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle(cmHandle,
- resourceIdentifier, DELETE, requestBody, contentType);
+ resourceIdentifier, DELETE, GSON.toJson(requestBody), contentType);
return new ResponseEntity<>(HttpStatus.NO_CONTENT);
}
* @param cmHandle the cm handle
* @return module references for cm handle
*/
- @Override
- public ResponseEntity<Object> getModuleReferencesByCmHandle(final String cmHandle) {
- final Collection<ModuleReference>
- moduleReferences = networkCmProxyDataService.getYangResourcesModuleReferences(cmHandle);
- return new ResponseEntity<>(new Gson().toJson(moduleReferences), HttpStatus.OK);
+ public ResponseEntity<List<ModuleReference>> getModuleReferencesByCmHandle(final String cmHandle) {
+ final List<ModuleReference> moduleReferences =
+ networkCmProxyDataService.getYangResourcesModuleReferences(cmHandle).stream()
+ .map(moduleReference -> modelMapper.map(moduleReference, ModuleReference.class))
+ .collect(Collectors.toList());
+ return new ResponseEntity<>(moduleReferences, HttpStatus.OK);
}
private Collection<String> processConditions(final List<ConditionProperties> conditionProperties) {
def cmHandle = 'some handle'
def xpath = 'some xpath'
+ def jsonString = '{"some-key":"some-value"}'
def 'Query data node by cps path for the given cm handle with #scenario.'() {
given: 'service method returns a list containing a data node'
}
def 'Create data node: #scenario.'() {
- given: 'json data'
- def jsonData = 'json data'
when: 'post request is performed'
def response = mvc.perform(
post("$ncmpBasePathV1/cm-handles/$cmHandle/nodes")
.contentType(MediaType.APPLICATION_JSON)
- .content(jsonData)
+ .content(jsonString)
.param('xpath', reqXpath)
).andReturn().response
then: 'the service method is invoked once with expected parameters'
- 1 * mockNetworkCmProxyDataService.createDataNode(cmHandle, usedXpath, jsonData)
+ 1 * mockNetworkCmProxyDataService.createDataNode(cmHandle, usedXpath, jsonString)
and: 'response status indicates success'
response.status == HttpStatus.CREATED.value()
where: 'following parameters were used'
}
def 'Add list-node elements.'() {
- given: 'json data and parent node xpath'
- def jsonData = 'json data'
+ given: ' parent node xpath'
def parentNodeXpath = 'parent node xpath'
when: 'post request is performed'
def response = mvc.perform(
post("$ncmpBasePathV1/cm-handles/$cmHandle/list-node")
.contentType(MediaType.APPLICATION_JSON)
- .content(jsonData)
+ .content(jsonString)
.param('xpath', parentNodeXpath)
).andReturn().response
then: 'the service method is invoked once with expected parameters'
- 1 * mockNetworkCmProxyDataService.addListNodeElements(cmHandle, parentNodeXpath, jsonData)
+ 1 * mockNetworkCmProxyDataService.addListNodeElements(cmHandle, parentNodeXpath, jsonString)
and: 'response status indicates success'
response.status == HttpStatus.CREATED.value()
}
def 'Update data node leaves.'() {
- given: 'json data'
- def jsonData = 'json data'
- and: 'the query endpoint'
+ given: 'the query endpoint'
def endpoint = "$ncmpBasePathV1/cm-handles/$cmHandle/nodes"
when: 'patch request is performed'
def response = mvc.perform(
patch(endpoint)
.contentType(MediaType.APPLICATION_JSON)
- .content(jsonData)
+ .content(jsonString)
.param('xpath', xpath)
).andReturn().response
then: 'the service method is invoked once with expected parameters'
- 1 * mockNetworkCmProxyDataService.updateNodeLeaves(cmHandle, xpath, jsonData)
+ 1 * mockNetworkCmProxyDataService.updateNodeLeaves(cmHandle, xpath, jsonString)
and: 'response status indicates success'
response.status == HttpStatus.OK.value()
}
def 'Replace data node tree.'() {
- given: 'json data'
- def jsonData = 'json data'
- and: 'the query endpoint'
+ given: 'the query endpoint'
def endpoint = "$ncmpBasePathV1/cm-handles/$cmHandle/nodes"
when: 'put request is performed'
def response = mvc.perform(
put(endpoint)
.contentType(MediaType.APPLICATION_JSON)
- .content(jsonData)
+ .content(jsonString)
.param('xpath', xpath)
).andReturn().response
then: 'the service method is invoked once with expected parameters'
- 1 * mockNetworkCmProxyDataService.replaceNodeTree(cmHandle, xpath, jsonData)
+ 1 * mockNetworkCmProxyDataService.replaceNodeTree(cmHandle, xpath, jsonString)
and: 'response status indicates success'
response.status == HttpStatus.OK.value()
}
def response = mvc.perform(
put(updateUrl)
.contentType(MediaType.APPLICATION_JSON_VALUE)
- .accept(MediaType.APPLICATION_JSON_VALUE).content('some-request-body')
+ .accept(MediaType.APPLICATION_JSON_VALUE).content(jsonString)
).andReturn().response
then: 'ncmp service method to update resource is called'
1 * mockNetworkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle('testCmHandle',
- 'parent/child', UPDATE,'some-request-body', 'application/json;charset=UTF-8')
+ 'parent/child', UPDATE, jsonString, 'application/json;charset=UTF-8')
and: 'the response status is OK'
response.status == HttpStatus.OK.value()
}
given: 'resource data url'
def url = "$ncmpBasePathV1/ch/testCmHandle/data/ds/ncmp-datastore:passthrough-running" +
"?resourceIdentifier=parent/child"
+ def requestBody = '{"some-key":"some-value"}'
when: 'create resource request is performed'
def response = mvc.perform(
post(url)
'parent/child', CREATE, requestBody, 'application/json;charset=UTF-8')
and: 'resource is created'
response.status == HttpStatus.CREATED.value()
- where: 'given request body'
- scenario | requestBody
- 'body contains " and new line' | 'body with " quote and \n new line'
- 'body contains normal string' | 'normal request body'
}
def 'Get module references for the given dataspace and cm handle.' () {
def response =mvc.perform(get(getUrl)).andReturn().response
then: 'ncmp service method to get yang resource module references is called'
mockNetworkCmProxyDataService.getYangResourcesModuleReferences('some-cmhandle')
- >> [new ModuleReference(moduleName: 'some-name1',revision: 'some-revision1')]
+ >> [new ModuleReference(moduleName: 'some-name1',revision: '2021-10-03')]
and: 'response contains an array with the module name and revision'
- response.getContentAsString() == '[{"moduleName":"some-name1","revision":"some-revision1"}]'
+ response.getContentAsString() == '[{"moduleName":"some-name1","revision":"2021-10-03"}]'
and: 'response returns an OK http code'
response.status == HttpStatus.OK.value()
}
def 'Retrieve cm handles.'() {
given: 'an endpoint and json data'
def searchesEndpoint = "$ncmpBasePathV1/ch/searches"
- String jsonData = TestUtils.getResourceFileContent('cmhandle-search.json')
+ String jsonString = TestUtils.getResourceFileContent('cmhandle-search.json')
and: 'the service method is invoked with module names and returns two cm handle ids'
mockNetworkCmProxyDataService.executeCmHandleHasAllModulesSearch(['module1', 'module2']) >> ['some-cmhandle-id1', 'some-cmhandle-id2']
when: 'the searches api is invoked'
def response = mvc.perform(post(searchesEndpoint)
.contentType(MediaType.APPLICATION_JSON)
- .content(jsonData)).andReturn().response
+ .content(jsonString)).andReturn().response
then: 'response status returns OK'
response.status == HttpStatus.OK.value()
and: 'the expected response content is returned'
def 'Call execute cm handle searches with unrecognized condition name.'() {
given: 'an endpoint and json data'
def searchesEndpoint = "$ncmpBasePathV1/ch/searches"
- String jsonData = TestUtils.getResourceFileContent('invalid-cmhandle-search.json')
+ String jsonString = TestUtils.getResourceFileContent('invalid-cmhandle-search.json')
when: 'the searches api is invoked'
def response = mvc.perform(post(searchesEndpoint)
.contentType(MediaType.APPLICATION_JSON)
- .content(jsonData)).andReturn().response
+ .content(jsonString)).andReturn().response
then: 'an empty cm handle identifier is returned'
response.contentAsString == '{"cmHandles":[]}'
}
def response = mvc.perform(
patch(url)
.contentType(MediaType.APPLICATION_JSON)
- .accept(MediaType.APPLICATION_JSON).content('{"some-key" : "some-value"}')
+ .accept(MediaType.APPLICATION_JSON).content(jsonString)
).andReturn().response
then: 'ncmp service method to update resource is called'
1 * mockNetworkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle('testCmHandle',
- 'parent/child', PATCH, '{some-key=some-value}', 'application/json;charset=UTF-8')
+ 'parent/child', PATCH, jsonString, 'application/json;charset=UTF-8')
and: 'the response status is OK'
response.status == HttpStatus.OK.value()
}
when: 'delete data resource request is performed'
def response = mvc.perform(
delete(url).contentType(MediaType.APPLICATION_JSON).accept(MediaType.APPLICATION_JSON)
- .content('{"some-key" : "some-value"}')).andReturn().response
+ .content(jsonString)).andReturn().response
then: 'the ncmp service method to delete resource is called'
1 * mockNetworkCmProxyDataService.writeResourceDataPassThroughRunningForCmHandle('testCmHandle',
- 'parent/child', DELETE, '{"some-key" : "some-value"}', 'application/json;charset=UTF-8')
+ 'parent/child', DELETE, jsonString, 'application/json;charset=UTF-8')
and: 'the response is No Content'
response.status == HttpStatus.NO_CONTENT.value()
}
Features
--------
+
+ - `CPS-559 <https://jira.onap.org/browse/CPS-559>`_ Define response objects (schemas) in cps-ncmp
- `CPS-636 <https://jira.onap.org/browse/CPS-636>`_ Update operation for datastore pass through running
- `CPS-638 <https://jira.onap.org/browse/CPS-638>`_ Delete operation for datastore pass through running
- `CPS-741 <https://jira.onap.org/browse/CPS-741>`_ Re sync after removing cm handles
+ - `CPS-780 <https://jira.onap.org/browse/CPS-780>`_ Add examples for parameters, request and response in openapi yaml for cps-core
Bug Fixes
---------
Code Review / cps.git / commitdiff