summaryrefslogtreecommitdiffstats
path: root/ms/blueprintsprocessor
diff options
context:
space:
mode:
authorPiotr Stanior <piotr.stanior@t-mobile.pl>2020-12-15 10:13:34 +0100
committerKAPIL SINGAL <ks220y@att.com>2020-12-15 20:13:07 +0000
commitf38e495d47e69b5203940e1f3eb76145c2a30e83 (patch)
tree030da0e7ffebadc524bd2a7c18fde4af794176bf /ms/blueprintsprocessor
parenta0c98da2730a1e7883ff29f461db27506189a843 (diff)
CDS add Postman collection for Resource, Template, Dictionary and Config API
Issue-ID: CCSDK-3014 Change-Id: Ic9892c035067064fd612f2781507a36072e4e712 Signed-off-by: Piotr Stanior <piotr.stanior@t-mobile.pl>
Diffstat (limited to 'ms/blueprintsprocessor')
-rwxr-xr-xms/blueprintsprocessor/application/pom.xml1
-rw-r--r--ms/blueprintsprocessor/modules/inbounds/configs-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/configs/api/ResourceConfigSnapshotController.kt32
-rw-r--r--ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/BlueprintModelController.kt2
-rw-r--r--ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/ResourceDictionaryController.kt42
-rw-r--r--ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/ResourceController.kt38
-rw-r--r--ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/TemplateController.kt42
6 files changed, 78 insertions, 79 deletions
diff --git a/ms/blueprintsprocessor/application/pom.xml b/ms/blueprintsprocessor/application/pom.xml
index cccff5228..2f398d3e7 100755
--- a/ms/blueprintsprocessor/application/pom.xml
+++ b/ms/blueprintsprocessor/application/pom.xml
@@ -335,6 +335,7 @@
<springmvc>true</springmvc>
<locations>
<location>org.onap.ccsdk.cds.blueprintsprocessor.designer.api.BlueprintModelController</location>
+ <location>org.onap.ccsdk.cds.blueprintsprocessor.designer.api.ResourceDictionaryController</location>
<location>org.onap.ccsdk.cds.blueprintsprocessor.resource.api</location>
<location>org.onap.ccsdk.cds.blueprintsprocessor.configs.api</location>
<!-- This location is not implemented yet
diff --git a/ms/blueprintsprocessor/modules/inbounds/configs-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/configs/api/ResourceConfigSnapshotController.kt b/ms/blueprintsprocessor/modules/inbounds/configs-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/configs/api/ResourceConfigSnapshotController.kt
index 584df27ed..9dadd398e 100644
--- a/ms/blueprintsprocessor/modules/inbounds/configs-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/configs/api/ResourceConfigSnapshotController.kt
+++ b/ms/blueprintsprocessor/modules/inbounds/configs-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/configs/api/ResourceConfigSnapshotController.kt
@@ -49,7 +49,7 @@ import org.springframework.web.bind.annotation.RestController
@RequestMapping("/api/v1/configs")
@Api(
value = "Resource configuration",
- description = "Interaction with stored configurations."
+ description = "Interaction with stored configurations"
)
open class ResourceConfigSnapshotController(private val resourceConfigSnapshotService: ResourceConfigSnapshotService) {
@@ -71,24 +71,24 @@ open class ResourceConfigSnapshotController(private val resourceConfigSnapshotSe
produces = [MediaType.TEXT_PLAIN_VALUE, MediaType.APPLICATION_JSON_VALUE, MediaType.APPLICATION_XML_VALUE]
)
@ApiOperation(
- value = "Retrieve a resource configuration snapshot.",
+ value = "Retrieve a resource configuration snapshot",
notes = "Retrieve a config snapshot, identified by its Resource Id and Type. " +
"An extra 'format' parameter can be passed to tell what content-type is expected."
)
@ResponseBody
@PreAuthorize("hasRole('USER')")
fun get(
- @ApiParam(value = "Resource Type associated of the resource configuration snapshot.", required = false, example = "\"PNF\"")
+ @ApiParam(value = "Resource Type associated of the resource configuration snapshot", required = false, example = "\"PNF\"")
@RequestParam(value = "resourceType", required = true) resourceType: String,
- @ApiParam(value = "Resource Id associated of the resource configuration snapshot.", required = false, example = "\"1\"")
+ @ApiParam(value = "Resource Id associated of the resource configuration snapshot", required = false, example = "\"1\"")
@RequestParam(value = "resourceId", required = true) resourceId: String,
- @ApiParam(value = "Status of the snapshot being retrieved.", defaultValue = "RUNNING", required = false)
+ @ApiParam(value = "Status of the snapshot being retrieved", defaultValue = "RUNNING", required = false)
@RequestParam(value = "status", required = false, defaultValue = "RUNNING") status: String,
@ApiParam(
- value = "Expected format of the snapshot being retrieved.", defaultValue = MediaType.TEXT_PLAIN_VALUE,
+ value = "Expected format of the snapshot being retrieved", defaultValue = MediaType.TEXT_PLAIN_VALUE,
required = false
)
@RequestParam(value = "format", required = false, defaultValue = MediaType.TEXT_PLAIN_VALUE) format: String
@@ -138,7 +138,7 @@ open class ResourceConfigSnapshotController(private val resourceConfigSnapshotSe
produces = [MediaType.APPLICATION_JSON_VALUE]
)
@ApiOperation(
- value = "Store a resource configuration snapshot identified by resourceId, resourceType, status.",
+ value = "Store a resource configuration snapshot identified by resourceId, resourceType, status",
notes = "Store a resource configuration snapshot, identified by its resourceId and resourceType, " +
"and optionally its status, either RUNNING or CANDIDATE.",
response = ResourceConfigSnapshot::class
@@ -146,13 +146,13 @@ open class ResourceConfigSnapshotController(private val resourceConfigSnapshotSe
@ResponseBody
@PreAuthorize("hasRole('USER')")
fun postWithResourceIdAndResourceType(
- @ApiParam(value = "Resource Type associated with the resolution.", required = false, example = "\"PNF\"")
+ @ApiParam(value = "Resource Type associated with the resolution", required = false, example = "\"PNF\"")
@PathVariable(value = "resourceType", required = true) resourceType: String,
- @ApiParam(value = "Resource Id associated with the resolution.", required = false, example = "\"1\"")
+ @ApiParam(value = "Resource Id associated with the resolution", required = false, example = "\"1\"")
@PathVariable(value = "resourceId", required = true) resourceId: String,
- @ApiParam(value = "Status of the snapshot being retrieved.", defaultValue = "RUNNING", required = true)
+ @ApiParam(value = "Status of the snapshot being retrieved", defaultValue = "RUNNING", required = true)
@PathVariable(value = "status", required = true) status: String,
- @ApiParam(value = "Config snapshot to store.", required = true, example = "\"config_snapshot\"")
+ @ApiParam(value = "Config snapshot to store", required = true, example = "\"config_snapshot\"")
@RequestBody snapshot: String
): ResponseEntity<ResourceConfigSnapshot> = runBlocking {
@@ -177,9 +177,9 @@ open class ResourceConfigSnapshotController(private val resourceConfigSnapshotSe
@ResponseBody
@PreAuthorize("hasRole('USER')")
fun getAllByID(
- @ApiParam(value = "Resource Id associated of the resource configuration snapshots.", required = false, example = "\"1\"")
+ @ApiParam(value = "Resource Id associated of the resource configuration snapshots", required = false, example = "\"1\"")
@RequestParam(value = "resourceId", required = true) resourceId: String,
- @ApiParam(value = "Status of the snapshot being retrieved.", defaultValue = "ANY", required = false)
+ @ApiParam(value = "Status of the snapshot being retrieved", defaultValue = "ANY", required = false)
@RequestParam(value = "status", required = false, defaultValue = "ANY") status: String
): ResponseEntity<List<ResourceConfigSnapshot>?> = runBlocking {
var configSnapshots: List<ResourceConfigSnapshot>?
@@ -216,15 +216,15 @@ open class ResourceConfigSnapshotController(private val resourceConfigSnapshotSe
produces = [MediaType.APPLICATION_JSON_VALUE]
)
@ApiOperation(
- value = "Retrieve all resource configuration snapshots for a given resource type.",
+ value = "Retrieve all resource configuration snapshots for a given resource type",
notes = "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date. "
)
@ResponseBody
@PreAuthorize("hasRole('USER')")
fun getAllByType(
- @ApiParam(value = "Resource Type associated of the resource configuration snapshot.", required = false, example = "\"PNF\"")
+ @ApiParam(value = "Resource Type associated of the resource configuration snapshot", required = false, example = "\"PNF\"")
@RequestParam(value = "resourceType", required = true) resourceType: String,
- @ApiParam(value = "Status of the snapshot being retrieved.", defaultValue = "ANY", required = false)
+ @ApiParam(value = "Status of the snapshot being retrieved", defaultValue = "ANY", required = false)
@RequestParam(value = "status", required = false, defaultValue = "ANY") status: String
): ResponseEntity<List<ResourceConfigSnapshot>?> = runBlocking {
var configSnapshots: List<ResourceConfigSnapshot>?
diff --git a/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/BlueprintModelController.kt b/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/BlueprintModelController.kt
index 8b79ce74a..66d4b0e16 100644
--- a/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/BlueprintModelController.kt
+++ b/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/BlueprintModelController.kt
@@ -59,7 +59,7 @@ import org.springframework.web.bind.annotation.RestController
@RestController
@RequestMapping("/api/v1/blueprint-model")
@Api(
- value = "Blueprint Model Catalog API",
+ value = "Blueprint Model Catalog",
description = "Manages all blueprint models which are available in CDS"
)
open class BlueprintModelController(private val bluePrintModelHandler: BluePrintModelHandler) {
diff --git a/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/ResourceDictionaryController.kt b/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/ResourceDictionaryController.kt
index 1dcfa2ff1..8d69ccdde 100644
--- a/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/ResourceDictionaryController.kt
+++ b/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/ResourceDictionaryController.kt
@@ -39,20 +39,20 @@ import org.springframework.web.bind.annotation.RestController
@RequestMapping(value = ["/api/v1/dictionary"])
@Api(
value = "Resource dictionary",
- description = "Interaction with stored dictionaries."
+ description = "Interaction with stored dictionaries"
)
open class ResourceDictionaryController(private val resourceDictionaryHandler: ResourceDictionaryHandler) {
@GetMapping(path = ["/{name}"], produces = [MediaType.APPLICATION_JSON_VALUE])
@ApiOperation(
- value = "Retrieve a resource dictionary.",
+ value = "Retrieve a resource dictionary",
notes = "Retrieve a resource dictionary by name provided.",
response = ResourceDictionary::class
)
@ResponseBody
@Throws(BluePrintException::class)
suspend fun getResourceDictionaryByName(
- @ApiParam(value = "Name of the resource.", required = true, example = "\"hostname\"")
+ @ApiParam(value = "Name of the resource", required = true, example = "\"hostname\"")
@PathVariable(value = "name") name: String
): ResourceDictionary =
mdcWebCoroutineScope {
@@ -64,14 +64,14 @@ open class ResourceDictionaryController(private val resourceDictionaryHandler: R
consumes = [MediaType.APPLICATION_JSON_VALUE]
)
@ApiOperation(
- value = "Saves a resource dictionary.",
- notes = "Saves a resource dictionary by dictionary provided.",
+ value = "Save a resource dictionary",
+ notes = "Save a resource dictionary by dictionary provided.",
response = ResourceDictionary::class
)
@ResponseBody
@Throws(BluePrintException::class)
suspend fun saveResourceDictionary(
- @ApiParam(value = "Resource dictionary to store.", required = true)
+ @ApiParam(value = "Resource dictionary to store", required = true)
@RequestBody dataDictionary: ResourceDictionary
): ResourceDictionary =
mdcWebCoroutineScope {
@@ -84,15 +84,15 @@ open class ResourceDictionaryController(private val resourceDictionaryHandler: R
consumes = [MediaType.APPLICATION_JSON_VALUE]
)
@ApiOperation(
- value = "Saves a resource dictionary.",
- notes = "Saves a resource dictionary by resource definition provided.",
+ value = "Save a resource dictionary",
+ notes = "Save a resource dictionary by resource definition provided.",
nickname = "ResourceDictionaryController_saveResourceDictionary_1_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
response = ResourceDefinition::class
)
@ResponseBody
@Throws(BluePrintException::class)
suspend fun saveResourceDictionary(
- @ApiParam(value = "Resource definition to generate.", required = true)
+ @ApiParam(value = "Resource definition to generate", required = true)
@RequestBody resourceDefinition: ResourceDefinition
): ResourceDefinition =
mdcWebCoroutineScope {
@@ -101,11 +101,11 @@ open class ResourceDictionaryController(private val resourceDictionaryHandler: R
@DeleteMapping(path = ["/{name}"])
@ApiOperation(
- value = "Removes a resource dictionary.",
- notes = "Removes a resource dictionary by name provided."
+ value = "Remove a resource dictionary",
+ notes = "Remove a resource dictionary by name provided."
)
suspend fun deleteResourceDictionaryByName(
- @ApiParam(value = "Name of the resource.", required = true)
+ @ApiParam(value = "Name of the resource", required = true)
@PathVariable(value = "name") name: String
) = mdcWebCoroutineScope {
resourceDictionaryHandler.deleteResourceDictionary(name)
@@ -117,14 +117,14 @@ open class ResourceDictionaryController(private val resourceDictionaryHandler: R
consumes = [MediaType.APPLICATION_JSON_VALUE]
)
@ApiOperation(
- value = "Searches for a resource dictionary.",
- notes = "Searches for a resource dictionary by names provided.",
+ value = "Search for a resource dictionary",
+ notes = "Search for a resource dictionary by names provided.",
responseContainer = "List",
response = ResourceDictionary::class
)
@ResponseBody
suspend fun searchResourceDictionaryByNames(
- @ApiParam(value = "List of names.", required = true)
+ @ApiParam(value = "List of names", required = true)
@RequestBody names: List<String>
): List<ResourceDictionary> =
mdcWebCoroutineScope {
@@ -133,14 +133,14 @@ open class ResourceDictionaryController(private val resourceDictionaryHandler: R
@GetMapping(path = ["/search/{tags}"], produces = [MediaType.APPLICATION_JSON_VALUE])
@ApiOperation(
- value = "Searches for a resource dictionary.",
- notes = "Searches for a resource dictionary by tags provided.",
+ value = "Search for a resource dictionary",
+ notes = "Search for a resource dictionary by tags provided.",
responseContainer = "List",
response = ResourceDictionary::class
)
@ResponseBody
suspend fun searchResourceDictionaryByTags(
- @ApiParam(value = "Tags list.", required = true, example = "\"status\"")
+ @ApiParam(value = "Tags list", required = true, example = "\"status\"")
@PathVariable(value = "tags") tags: String
): List<ResourceDictionary> =
mdcWebCoroutineScope {
@@ -149,8 +149,8 @@ open class ResourceDictionaryController(private val resourceDictionaryHandler: R
@GetMapping(path = ["/source-mapping"], produces = [MediaType.APPLICATION_JSON_VALUE])
@ApiOperation(
- value = "Searches for a source mapping.",
- notes = "Searches for a source mapping.",
+ value = "Search for a source mapping",
+ notes = "Search for a source mapping.",
response = ResourceSourceMapping::class
)
@ResponseBody
@@ -160,7 +160,7 @@ open class ResourceDictionaryController(private val resourceDictionaryHandler: R
@GetMapping(path = ["/resource_dictionary_group"], produces = [MediaType.APPLICATION_JSON_VALUE])
@ApiOperation(
- value = "Retrieve all resource dictionary groups.",
+ value = "Retrieve all resource dictionary groups",
notes = "Retrieve all resource dictionary groups.",
responseContainer = "List",
response = String::class
diff --git a/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/ResourceController.kt b/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/ResourceController.kt
index 3c18ba4f9..15c27a43b 100644
--- a/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/ResourceController.kt
+++ b/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/ResourceController.kt
@@ -39,7 +39,7 @@ import org.springframework.web.bind.annotation.RestController
@RequestMapping("/api/v1/resources")
@Api(
value = "Resources",
- description = "Interaction with resolved resources."
+ description = "Interaction with resolved resources"
)
open class ResourceController(private var resourceResolutionDBService: ResourceResolutionDBService) {
@@ -55,11 +55,10 @@ open class ResourceController(private var resourceResolutionDBService: ResourceR
}
@RequestMapping(
- path = [""],
method = [RequestMethod.GET], produces = [MediaType.APPLICATION_JSON_VALUE]
)
@ApiOperation(
- value = "Get all resolved resources using the resolution key. ",
+ value = "Get all resolved resources using the resolution key",
notes = "Retrieve all stored resolved resources using the blueprint name, blueprint version, " +
"artifact name and the resolution-key.",
response = ResourceResolution::class,
@@ -69,17 +68,17 @@ open class ResourceController(private var resourceResolutionDBService: ResourceR
@ResponseBody
@PreAuthorize("hasRole('USER')")
fun getAllFromResolutionKeyOrFromResourceTypeAndId(
- @ApiParam(value = "Name of the CBA.", required = true)
+ @ApiParam(value = "Name of the CBA", required = true)
@RequestParam(value = "bpName", required = true) bpName: String,
- @ApiParam(value = "Version of the CBA.", required = true)
+ @ApiParam(value = "Version of the CBA", required = true)
@RequestParam(value = "bpVersion", required = true) bpVersion: String,
- @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
+ @ApiParam(value = "Artifact name for which to retrieve a resolved resource", required = true)
@RequestParam(value = "artifactName", required = false, defaultValue = "") artifactName: String,
- @ApiParam(value = "Resolution Key associated with the resolution.", required = false)
+ @ApiParam(value = "Resolution Key associated with the resolution", required = false)
@RequestParam(value = "resolutionKey", required = false, defaultValue = "") resolutionKey: String,
- @ApiParam(value = "Resource Type associated with the resolution.", required = false)
+ @ApiParam(value = "Resource Type associated with the resolution", required = false)
@RequestParam(value = "resourceType", required = false, defaultValue = "") resourceType: String,
- @ApiParam(value = "Resource Id associated with the resolution.", required = false)
+ @ApiParam(value = "Resource Id associated with the resolution", required = false)
@RequestParam(value = "resourceId", required = false, defaultValue = "") resourceId: String
):
ResponseEntity<List<ResourceResolution>> = runBlocking {
@@ -111,7 +110,6 @@ open class ResourceController(private var resourceResolutionDBService: ResourceR
}
@RequestMapping(
- path = [""],
method = [RequestMethod.DELETE], produces = [MediaType.APPLICATION_JSON_VALUE]
)
@ApiOperation(
@@ -120,13 +118,13 @@ open class ResourceController(private var resourceResolutionDBService: ResourceR
)
@PreAuthorize("hasRole('USER')")
fun deleteByBlueprintNameAndBlueprintVersionAndArtifactNameAndResolutionKey(
- @ApiParam(value = "Name of the CBA.", required = true)
+ @ApiParam(value = "Name of the CBA", required = true)
@RequestParam(value = "bpName", required = true) bpName: String,
- @ApiParam(value = "Version of the CBA.", required = true)
+ @ApiParam(value = "Version of the CBA", required = true)
@RequestParam(value = "bpVersion", required = true) bpVersion: String,
- @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
+ @ApiParam(value = "Artifact name for which to retrieve a resolved resource", required = true)
@RequestParam(value = "artifactName", required = false, defaultValue = "") artifactName: String,
- @ApiParam(value = "Resolution Key associated with the resolution.", required = true)
+ @ApiParam(value = "Resolution Key associated with the resolution", required = true)
@RequestParam(value = "resolutionKey", required = true) resolutionKey: String
) = runBlocking {
ResponseEntity.ok()
@@ -146,21 +144,21 @@ open class ResourceController(private var resourceResolutionDBService: ResourceR
produces = [MediaType.APPLICATION_JSON_VALUE]
)
@ApiOperation(
- value = "Fetch a resource value using resolution key.",
+ value = "Fetch a resource value using resolution key",
notes = "Retrieve a stored resource value using the blueprint metadata, artifact name, resolution-key along with the name of the resource value to retrieve."
)
@ResponseBody
@PreAuthorize("hasRole('USER')")
fun getOneFromResolutionKey(
- @ApiParam(value = "Name of the CBA.", required = true)
+ @ApiParam(value = "Name of the CBA", required = true)
@RequestParam(value = "bpName", required = true) bpName: String,
- @ApiParam(value = "Version of the CBA.", required = true)
+ @ApiParam(value = "Version of the CBA", required = true)
@RequestParam(value = "bpVersion", required = true) bpVersion: String,
- @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
+ @ApiParam(value = "Artifact name for which to retrieve a resolved resource", required = true)
@RequestParam(value = "artifactName", required = true) artifactName: String,
- @ApiParam(value = "Resolution Key associated with the resolution.", required = true)
+ @ApiParam(value = "Resolution Key associated with the resolution", required = true)
@RequestParam(value = "resolutionKey", required = true) resolutionKey: String,
- @ApiParam(value = "Name of the resource to retrieve.", required = true)
+ @ApiParam(value = "Name of the resource to retrieve", required = true)
@RequestParam(value = "name", required = true) name: String
):
ResponseEntity<ResourceResolution> = runBlocking {
diff --git a/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/TemplateController.kt b/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/TemplateController.kt
index b80e81ca0..2d32d0e1d 100644
--- a/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/TemplateController.kt
+++ b/ms/blueprintsprocessor/modules/inbounds/resource-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/resource/api/TemplateController.kt
@@ -48,7 +48,7 @@ import org.springframework.web.bind.annotation.RestController
@RequestMapping("/api/v1/template")
@Api(
value = "Resource template",
- description = "Interaction with resolved template."
+ description = "Interaction with resolved templates"
)
open class TemplateController(private val templateResolutionService: TemplateResolutionService) {
@@ -69,7 +69,7 @@ open class TemplateController(private val templateResolutionService: TemplateRes
produces = [MediaType.TEXT_PLAIN_VALUE, MediaType.APPLICATION_JSON_VALUE, MediaType.APPLICATION_XML_VALUE]
)
@ApiOperation(
- value = "Retrieve a resolved template.",
+ value = "Retrieve a resolved template",
notes = "Retrieve a config template for a given CBA's action, identified by its blueprint name, blueprint version, " +
"artifact name and resolution key. An extra 'format' parameter can be passed to tell what content-type" +
" to expect in return"
@@ -77,25 +77,25 @@ open class TemplateController(private val templateResolutionService: TemplateRes
@ResponseBody
@PreAuthorize("hasRole('USER')")
fun get(
- @ApiParam(value = "Name of the CBA.", required = true)
+ @ApiParam(value = "Name of the CBA", required = true)
@RequestParam(value = "bpName") bpName: String,
- @ApiParam(value = "Version of the CBA.", required = true)
+ @ApiParam(value = "Version of the CBA", required = true)
@RequestParam(value = "bpVersion") bpVersion: String,
- @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
+ @ApiParam(value = "Artifact name for which to retrieve a resolved resource", required = true)
@RequestParam(value = "artifactName") artifactName: String,
- @ApiParam(value = "Resolution Key associated with the resolution.", required = false)
+ @ApiParam(value = "Resolution Key associated with the resolution", required = false)
@RequestParam(value = "resolutionKey") resolutionKey: String,
- @ApiParam(value = "Resource Type associated with the resolution.", required = false)
+ @ApiParam(value = "Resource Type associated with the resolution", required = false)
@RequestParam(value = "resourceType", required = false, defaultValue = "") resourceType: String,
- @ApiParam(value = "Resource Id associated with the resolution.", required = false)
+ @ApiParam(value = "Resource Id associated with the resolution", required = false)
@RequestParam(value = "resourceId", required = false, defaultValue = "") resourceId: String,
@ApiParam(
- value = "Expected format of the template being retrieved.",
+ value = "Expected format of the template being retrieved",
defaultValue = MediaType.TEXT_PLAIN_VALUE,
required = true
)
@RequestParam(value = "format", required = false, defaultValue = MediaType.TEXT_PLAIN_VALUE) format: String,
- @ApiParam(value = "Occurrence of the template resolution (1-n).", required = false)
+ @ApiParam(value = "Occurrence of the template resolution (1-n)", required = false)
@RequestParam(value = "occurrence", required = false, defaultValue = "1") occurrence: Int = 1
):
ResponseEntity<String> = runBlocking {
@@ -151,15 +151,15 @@ open class TemplateController(private val templateResolutionService: TemplateRes
@ResponseBody
@PreAuthorize("hasRole('USER')")
fun postWithResolutionKey(
- @ApiParam(value = "Name of the CBA.", required = true)
+ @ApiParam(value = "Name of the CBA", required = true)
@PathVariable(value = "bpName") bpName: String,
- @ApiParam(value = "Version of the CBA.", required = true)
+ @ApiParam(value = "Version of the CBA", required = true)
@PathVariable(value = "bpVersion") bpVersion: String,
- @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
+ @ApiParam(value = "Artifact name for which to retrieve a resolved resource", required = true)
@PathVariable(value = "artifactName") artifactName: String,
- @ApiParam(value = "Resolution Key associated with the resolution.", required = true)
+ @ApiParam(value = "Resolution Key associated with the resolution", required = true)
@PathVariable(value = "resolutionKey") resolutionKey: String,
- @ApiParam(value = "Template to store.", required = true)
+ @ApiParam(value = "Template to store", required = true)
@RequestBody result: String
): ResponseEntity<TemplateResolution> = runBlocking {
@@ -182,17 +182,17 @@ open class TemplateController(private val templateResolutionService: TemplateRes
@ResponseBody
@PreAuthorize("hasRole('USER')")
fun postWithResourceIdAndResourceType(
- @ApiParam(value = "Name of the CBA.", required = true)
+ @ApiParam(value = "Name of the CBA", required = true)
@PathVariable(value = "bpName") bpName: String,
- @ApiParam(value = "Version of the CBA.", required = true)
+ @ApiParam(value = "Version of the CBA", required = true)
@PathVariable(value = "bpVersion") bpVersion: String,
- @ApiParam(value = "Artifact name for which to retrieve a resolved resource.", required = true)
+ @ApiParam(value = "Artifact name for which to retrieve a resolved resource", required = true)
@PathVariable(value = "artifactName") artifactName: String,
- @ApiParam(value = "Resource Type associated with the resolution.", required = false)
+ @ApiParam(value = "Resource Type associated with the resolution", required = false)
@PathVariable(value = "resourceType", required = true) resourceType: String,
- @ApiParam(value = "Resource Id associated with the resolution.", required = false)
+ @ApiParam(value = "Resource Id associated with the resolution", required = false)
@PathVariable(value = "resourceId", required = true) resourceId: String,
- @ApiParam(value = "Template to store.", required = true)
+ @ApiParam(value = "Template to store", required = true)
@RequestBody result: String
): ResponseEntity<TemplateResolution> = runBlocking {