From a4b721c3e9c4aa7c5342304a061dc5634935acd0 Mon Sep 17 00:00:00 2001 From: JakobKrieg Date: Tue, 8 Dec 2020 19:04:52 +0100 Subject: CDS add Swagger annotations for BP Model API Issue-ID: CCSDK-3014 Change-Id: Ibca7cbaa2c70f04acf818e2b554664e13b116c5e Signed-off-by: JakobKrieg --- .../db/primary/domain/BlueprintModelSearch.kt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'ms/blueprintsprocessor/modules/commons') diff --git a/ms/blueprintsprocessor/modules/commons/db-lib/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/db/primary/domain/BlueprintModelSearch.kt b/ms/blueprintsprocessor/modules/commons/db-lib/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/db/primary/domain/BlueprintModelSearch.kt index e6373d9b8..734bf3689 100644 --- a/ms/blueprintsprocessor/modules/commons/db-lib/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/db/primary/domain/BlueprintModelSearch.kt +++ b/ms/blueprintsprocessor/modules/commons/db-lib/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/db/primary/domain/BlueprintModelSearch.kt @@ -19,6 +19,9 @@ package org.onap.ccsdk.cds.blueprintsprocessor.db.primary.domain import com.fasterxml.jackson.annotation.JsonFormat import com.fasterxml.jackson.annotation.JsonTypeInfo import com.fasterxml.jackson.annotation.JsonTypeName +import com.fasterxml.jackson.databind.annotation.JsonSerialize +import io.swagger.annotations.ApiModel +import io.swagger.annotations.ApiModelProperty import org.springframework.data.annotation.LastModifiedDate import java.io.Serializable import java.util.Date @@ -41,43 +44,60 @@ import javax.persistence.TemporalType @Table(name = "BLUEPRINT_MODEL") @JsonTypeName("blueprintModel") @JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME) +@ApiModel class BlueprintModelSearch : Serializable { + @ApiModelProperty( + value = "ID of Blueprint model, is automatically created by CDS", + example = "\"658f9a48-7f54-41ba-ae18-c69f26f3dc94\"", + required = true + ) @Id @Column(name = "blueprint_model_id") var id: String? = null + @ApiModelProperty(value = "Artifact UUID, usually null", example = "null", required = false) @Column(name = "artifact_uuid") var artifactUUId: String? = null + @JsonSerialize + @ApiModelProperty(value = "Artifact Type, usually null", example = "\"SDNC_MODEL\"", required = false) @Column(name = "artifact_type") var artifactType: String? = null + @ApiModelProperty(value = "Artifact Version, usually 1.0.0", example = "\"1.0.0\"", required = true) @Column(name = "artifact_version", nullable = false) var artifactVersion: String? = null + @ApiModelProperty(value = "Artifact Description, usually empty", example = "\"\"", required = false) @Lob @Column(name = "artifact_description") var artifactDescription: String? = null + @ApiModelProperty(value = "Internal Version of CBA, usually null", example = "null", required = false) @Column(name = "internal_version") var internalVersion: Int? = null + @ApiModelProperty(value = "Datetime of the creation of CBA in CDS", example = "\"2020-11-19T10:34:56.000Z\"", required = true) @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'") @LastModifiedDate @Temporal(TemporalType.TIMESTAMP) @Column(name = "creation_date") var createdDate = Date() + @ApiModelProperty(value = "Artifact Name, defined in Metadata", example = "\"pnf_netconf\"", required = true) @Column(name = "artifact_name", nullable = false) var artifactName: String? = null + @ApiModelProperty(value = "Artifact Name, defined in Metadata", example = "\"pnf_netconf\"", required = true) @Column(name = "published", nullable = false) var published: String? = null + @ApiModelProperty(value = "Name of publisher, defined in Metadata", example = "\"Deutsche Telekom AG\"", required = true) @Column(name = "updated_by", nullable = false) var updatedBy: String? = null + @ApiModelProperty(value = "Tags to identify the CBA, defined in Metadata", example = "\"test\"", required = true) @Lob @Column(name = "tags", nullable = false) var tags: String? = null -- cgit 1.2.3-korg