Get endpoint only accepts application/json.
Issue-ID: CPS-957
Change-Id: I7b9dd00f293f183dc76623c8e32699e8e90fd17c
Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca>
schema:
type: string
example: my-schema:my-node
- - name: accept
- in: header
- description: Accept parameter for response, if accept parameter is null, that
- means client can accept any format.
- schema:
- type: string
- enum:
- - application/json
- - application/yang-data+json
- name: options
in: query
description: options parameter in query, it is mandatory to wrap key(s)=value(s)
schema:
type: string
example: my-schema:my-node
- - name: accept
- in: header
- description: Accept parameter for response, if accept parameter is null, that
- means client can accept any format.
- schema:
- type: string
- enum:
- - application/json
- - application/yang-data+json
- name: options
in: query
description: options parameter in query, it is mandatory to wrap key(s)=value(s)
+# ============LICENSE_START=======================================================
+# Copyright (C) 2021 Nordix Foundation
+# Modifications Copyright (C) 2022 Bell Canada
+# ================================================================================
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+# ============LICENSE_END=========================================================
+
components:
schemas:
ErrorMessage:
type: string
example: my-schema:my-node
- acceptParamInHeader:
- name: accept
- in: header
- description: Accept parameter for response, if accept parameter is null, that means client can accept any format.
- schema:
- type: string
- enum: [ application/json, application/yang-data+json ]
-
optionsParamInQuery:
name: options
in: query
# ============LICENSE_START=======================================================
# Copyright (C) 2021 Nordix Foundation
+# Modifications Copyright (C) 2022 Bell Canada
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
parameters:
- $ref: 'components.yml#/components/parameters/cmHandleInPath'
- $ref: 'components.yml#/components/parameters/resourceIdentifierInQuery'
- - $ref: 'components.yml#/components/parameters/acceptParamInHeader'
- $ref: 'components.yml#/components/parameters/optionsParamInQuery'
requestBody:
description: Operational body
parameters:
- $ref: 'components.yml#/components/parameters/cmHandleInPath'
- $ref: 'components.yml#/components/parameters/resourceIdentifierInQuery'
- - $ref: 'components.yml#/components/parameters/acceptParamInHeader'
- $ref: 'components.yml#/components/parameters/optionsParamInQuery'
requestBody:
content:
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 Nordix Foundation
+ * Modifications Copyright (C) 2022 Bell Canada
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* @param resourceIdentifier resource identifier to fetch data
* @param cmHandle cm handle identifier
* @param dataAccessRequest data Access Request
- * @param acceptParamInHeader accept header parameter
* @param optionsParamInQuery options query parameter
* @return {@code ResponseEntity} response entity
*/
final String cmHandle,
final @Valid DataAccessRequest
dataAccessRequest,
- final String acceptParamInHeader,
final @Valid String optionsParamInQuery) {
if (isReadOperation(dataAccessRequest)) {
final String resourceDataAsJson = dmiService.getResourceData(cmHandle,
resourceIdentifier,
- acceptParamInHeader,
optionsParamInQuery,
DmiService.RESTCONF_CONTENT_PASSTHROUGH_OPERATIONAL_QUERY_PARAM);
return ResponseEntity.ok(resourceDataAsJson);
final String cmHandle,
final @Valid DataAccessRequest
dataAccessRequest,
- final String acceptParamInHeader,
final @Valid String optionsParamInQuery) {
final String sdncResponse;
if (isReadOperation(dataAccessRequest)) {
sdncResponse = dmiService.getResourceData(cmHandle,
resourceIdentifier,
- acceptParamInHeader,
optionsParamInQuery,
DmiService.RESTCONF_CONTENT_PASSTHROUGH_RUNNING_QUERY_PARAM);
} else {
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 Nordix Foundation
+ * Modifications Copyright (C) 2022 Bell Canada
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
* @param cmHandle cm handle identifier
* @param resourceIdentifier resource identifier
- * @param acceptParamInHeader accept header parameter
* @param optionsParamInQuery options query parameter
* @param restconfContentQueryParam restconf content i.e. datastore to use
* @return {@code Object} response from network function
*/
String getResourceData(@NotNull String cmHandle,
@NotNull String resourceIdentifier,
- String acceptParamInHeader,
String optionsParamInQuery,
String restconfContentQueryParam);
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 Nordix Foundation
- * Modifications Copyright (C) 2021 Bell Canada
+ * Modifications Copyright (C) 2021-2022 Bell Canada
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@Override
public String getResourceData(final String cmHandle,
final String resourceIdentifier,
- final String acceptParamInHeader,
final String optionsParamInQuery,
final String restconfContentQueryParam) {
final ResponseEntity<String> responseEntity = sdncOperations.getResouceDataForOperationalAndRunning(cmHandle,
resourceIdentifier,
optionsParamInQuery,
- acceptParamInHeader,
restconfContentQueryParam);
return prepareAndSendResponse(responseEntity, cmHandle);
}
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021-2022 Nordix Foundation
- * Modifications Copyright (C) 2021 Bell Canada
+ * Modifications Copyright (C) 2021-2022 Bell Canada
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* @param nodeId network resource identifier
* @param resourceId resource identifier
* @param optionsParamInQuery fields query
- * @param acceptParamInHeader accept parameter
* @param restConfContentQueryParam restConf content query param
* @return {@code ResponseEntity} response entity
*/
public ResponseEntity<String> getResouceDataForOperationalAndRunning(final String nodeId,
final String resourceId,
final String optionsParamInQuery,
- final String acceptParamInHeader,
final String restConfContentQueryParam) {
final String getResourceDataUrl = prepareResourceDataUrl(nodeId,
- resourceId,
- buildQueryParamMap(optionsParamInQuery, restConfContentQueryParam));
- final HttpHeaders httpHeaders = new HttpHeaders();
- if (acceptParamInHeader != null && !acceptParamInHeader.isBlank()) {
- httpHeaders.set(HttpHeaders.ACCEPT, acceptParamInHeader);
- }
- return sdncRestconfClient.getOperation(getResourceDataUrl, httpHeaders);
+ resourceId, buildQueryParamMap(optionsParamInQuery, restConfContentQueryParam));
+ return sdncRestconfClient.getOperation(getResourceDataUrl);
}
/**
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 Nordix Foundation
- * Modifications Copyright (C) 2021 Bell Canada
+ * Modifications Copyright (C) 2021-2022 Bell Canada
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
def json = '{"cmHandleProperties" : { "prop1" : "value1", "prop2" : "value2"}}'
when: 'get resource data POST api is invoked'
def response = mvc.perform(
- post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON)
- .accept(MediaType.APPLICATION_JSON).content(json)
+ post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON).content(json)
).andReturn().response
then: 'response status is ok'
response.status == OK.value()
and: 'dmi service called with get resource data'
1 * mockDmiService.getResourceData('some-cmHandle',
'parent/child',
- 'application/json',
'(fields=myfields,depth=5)',
'content=all')
}
def jsonData = TestUtils.getResourceFileContent('createDataWithNormalChar.json')
when: 'get resource data POST api is invoked'
def response = mvc.perform(
- post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON)
- .accept(MediaType.APPLICATION_JSON).content(jsonData)
+ post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON).content(jsonData)
).andReturn().response
then: 'response status is bad request'
response.status == BAD_REQUEST.value()
def json = '{"cmHandleProperties" : { "prop1" : "value1", "prop2" : "value2"}}'
when: 'get resource data POST api is invoked'
def response = mvc.perform(
- post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON)
- .accept(MediaType.APPLICATION_JSON).content(json)
+ post(getResourceDataForCmHandleUrl).contentType(MediaType.APPLICATION_JSON).content(json)
).andReturn().response
then: 'response status is ok'
response.status == OK.value()
and: 'dmi service called with get resource data for a cm handle'
1 * mockDmiService.getResourceData('some-cmHandle',
resourceIdentifier,
- 'application/json',
'(fields=myfields,depth=5)',
'content=config')
where: 'tokens are used in the resource identifier parameter'
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 Nordix Foundation
- * Modifications Copyright (C) 2021 Bell Canada
+ * Modifications Copyright (C) 2021-2022 Bell Canada
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
given: 'cm-handle, passthrough parameter, resourceId, accept header, fields, depth'
def cmHandle = 'testCmHandle'
def resourceId = 'testResourceId'
- def acceptHeaderParam = 'testAcceptParam'
def optionsParam = '(fields=x/y/z,depth=10,test=abc)'
def contentQuery = 'content=all'
and: 'sdnc operation returns OK response'
- mockSdncOperations.getResouceDataForOperationalAndRunning(cmHandle, resourceId, optionsParam, acceptHeaderParam, contentQuery) >> new ResponseEntity<>('response json', HttpStatus.OK)
+ mockSdncOperations.getResouceDataForOperationalAndRunning(cmHandle, resourceId, optionsParam, contentQuery) >> new ResponseEntity<>('response json', HttpStatus.OK)
when: 'get resource data from cm handles service method invoked'
def response = objectUnderTest.getResourceData(cmHandle,
- resourceId, acceptHeaderParam,
- optionsParam, contentQuery)
+ resourceId, optionsParam, contentQuery)
then: 'response have expected json'
response == 'response json'
}
given: 'cm-handle, passthrough parameter, resourceId, accept header, fields, depth, query param'
def cmHandle = 'testCmHandle'
def resourceId = 'testResourceId'
- def acceptHeaderParam = 'testAcceptParam'
def optionsParam = '(fields=x/y/z,depth=10,test=abc)'
def restConfQueryParam = 'content=config'
and: 'sdnc operation returns "NOT_FOUND" response'
- mockSdncOperations.getResouceDataForOperationalAndRunning(cmHandle, resourceId, optionsParam, acceptHeaderParam, _ as String) >> new ResponseEntity<>(HttpStatus.NOT_FOUND)
+ mockSdncOperations.getResouceDataForOperationalAndRunning(cmHandle, resourceId, optionsParam, _ as String) >> new ResponseEntity<>(HttpStatus.NOT_FOUND)
when: 'get resource data from cm handles service method invoked'
objectUnderTest.getResourceData(cmHandle,
- resourceId, acceptHeaderParam,
- optionsParam, restConfQueryParam)
+ resourceId, optionsParam, restConfQueryParam)
then: 'resource data not found'
thrown(ResourceDataNotFound.class)
}
given: 'cm-handle, passthrough parameter, resourceId, accept header, fields, depth'
def cmHandle = 'testCmHandle'
def resourceId = 'testResourceId'
- def acceptHeaderParam = 'testAcceptParam'
def optionsParam = '(fields=x/y/z,depth=10,test=abc)'
def contentQuery = 'content=config'
and: 'sdnc operation returns OK response'
mockSdncOperations.getResouceDataForOperationalAndRunning(cmHandle, resourceId, optionsParam,
- acceptHeaderParam, contentQuery) >> new ResponseEntity<>('response json', HttpStatus.OK)
+ contentQuery) >> new ResponseEntity<>('response json', HttpStatus.OK)
when: 'get resource data from cm handles service method invoked'
def response = objectUnderTest.getResourceData(cmHandle,
- resourceId, acceptHeaderParam,
- optionsParam, contentQuery)
+ resourceId, optionsParam, contentQuery)
then: 'response have expected json'
response == 'response json'
}
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021-2022 Nordix Foundation
- * Modifications Copyright (C) 2021 Bell Canada
+ * Modifications Copyright (C) 2021-2022 Bell Canada
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
1 * mockSdncRestClient.httpOperationWithJsonData(HttpMethod.POST, expectedUrl, 'some-json-data', _ as HttpHeaders)
}
- def 'Get resource data from node to SDNC. with#scenario accept header'() {
+ def 'Get resource data from node to SDNC.'() {
given: 'expected url, topology-id, sdncOperation object'
def expectedUrl = '/rests/data/network-topology:network-topology/topology=test-topology/node=node1/yang-ext:mount/testResourceId?a=1&b=2&content=testContent'
when: 'called get modules from node'
objectUnderTest.getResouceDataForOperationalAndRunning('node1', 'testResourceId',
- '(a=1,b=2)', acceptParamInHeader, 'content=testContent')
- then: 'the get operation is executed with the correct URL and Http headers'
- 1 * mockSdncRestClient.getOperation(expectedUrl, expectedHttpHeaders)
- where:
- scenario | acceptParamInHeader || expectedHttpHeaders
- 'test' | 'test' || new HttpHeaders([Accept:'test'])
- 'empty' | '' || new HttpHeaders()
- 'null' | null || new HttpHeaders()
+ '(a=1,b=2)', 'content=testContent')
+ then: 'the get operation is executed with the correct URL'
+ 1 * mockSdncRestClient.getOperation(expectedUrl)
}
def 'Write resource data with #scenario operation to SDNC.'() {
Code Review / cps / ncmp-dmi-plugin.git / commitdiff