feat(generic bpm): eclipse-tractusx#384 Gate API: Create input endpoi…

…nts for generic business partners - Comments from the review incorporated
catenax-ng · Sep 5, 2023 · a84805a · a84805a
1 parent a817b2a
commit a84805a
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 16 deletions.
diff --git a/bpdm-gate-api/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/GateBusinessPartnerApi.kt b/bpdm-gate-api/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/GateBusinessPartnerApi.kt
@@ -27,7 +27,7 @@ import jakarta.validation.Valid
 import org.eclipse.tractusx.bpdm.common.dto.request.PaginationRequest
 import org.eclipse.tractusx.bpdm.common.dto.response.PageDto
 import org.eclipse.tractusx.bpdm.gate.api.model.request.BusinessPartnerInputRequest
-import org.eclipse.tractusx.bpdm.gate.api.model.response.BusinessPartnerInputResponseDto
+import org.eclipse.tractusx.bpdm.gate.api.model.response.BusinessPartnerInputDto
 import org.springdoc.core.annotations.ParameterObject
 import org.springframework.http.MediaType
 import org.springframework.web.bind.annotation.PostMapping
@@ -45,8 +45,8 @@ interface GateBusinessPartnerApi {
     @Operation(
         summary = "Create or update business partner with given external ID",
         description = "Create or update generic business partner. " +
-                "Updates instead of creating a new business partner if an already existing external id is used. " +
-                "The same external id may not occur more than once in a single request. " +
+                "Updates instead of creating a new business partner if an already existing external ID is used. " +
+                "The same external ID may not occur more than once in a single request. " +
                 "For a single request, the maximum number of business partners in the request is limited to \${bpdm.api.upsert-limit} entries."
     )
     @ApiResponses(
@@ -57,7 +57,7 @@ interface GateBusinessPartnerApi {
     )
     @PutMapping("/input/business-partners")
     @PutExchange("/input/business-partners")
-    fun upsertBusinessPartnersInput(@RequestBody businessPartners: Collection<BusinessPartnerInputRequest>): Collection<BusinessPartnerInputResponseDto>
+    fun upsertBusinessPartnersInput(@RequestBody businessPartners: Collection<BusinessPartnerInputRequest>): Collection<BusinessPartnerInputDto>
 
     @Operation(
         summary = "Search business partner by external ID. An empty external ID list returns a paginated list of all business partners.",
@@ -74,6 +74,6 @@ interface GateBusinessPartnerApi {
     fun getBusinessPartnersInputByExternalIds(
         @ParameterObject @Valid paginationRequest: PaginationRequest,
         @RequestBody externalIds: Collection<String>
-    ): PageDto<BusinessPartnerInputResponseDto>
+    ): PageDto<BusinessPartnerInputDto>
 
 }
diff --git a/.../src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/model/BusinessPartnerIdentifierDto.kt b/.../src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/model/BusinessPartnerIdentifierDto.kt
@@ -25,7 +25,7 @@ import io.swagger.v3.oas.annotations.media.Schema
 data class BusinessPartnerIdentifierDto(
 
     @get:Schema(description = "Value of the identifier")
-    val value: String,
+    val value: String?,
 
     @get:Schema(description = "Technical key of the type to which this identifier belongs to")
     val type: String,

diff --git a/.../src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/model/IBaseBusinessPartnerInputDto.kt b/.../src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/model/IBaseBusinessPartnerInputDto.kt
@@ -22,12 +22,12 @@ package org.eclipse.tractusx.bpdm.gate.api.model
 import io.swagger.v3.oas.annotations.media.ArraySchema
 import io.swagger.v3.oas.annotations.media.Schema
 import org.eclipse.tractusx.bpdm.common.dto.ClassificationDto
-import org.eclipse.tractusx.bpdm.common.dto.openapidescription.LegalEntityDescription
+import org.eclipse.tractusx.bpdm.common.dto.openapidescription.CommonDescription
 
 
 interface IBaseBusinessPartnerInputDto {
 
-    @get:Schema(description = "ID the record has in the external system where the record originates from")
+    @get:Schema(description = CommonDescription.externalId)
     val externalId: String
 
     @get:Schema(description = "")
@@ -36,16 +36,16 @@ interface IBaseBusinessPartnerInputDto {
     @get:Schema(description = "Abbreviated name or shorthand")
     val shortName: String?
 
-    @get:ArraySchema(arraySchema = Schema(description = LegalEntityDescription.identifiers))
+    @get:ArraySchema(arraySchema = Schema(description = "The list of identifiers of the business partner"))
     val identifiers: Collection<BusinessPartnerIdentifierDto>
 
     @get:Schema(description = "Technical key of the legal form")
     val legalForm: String?
 
-    @get:ArraySchema(arraySchema = Schema(description = LegalEntityDescription.states))
+    @get:ArraySchema(arraySchema = Schema(description = "The list of (temporary) states of the business partner."))
     val states: Collection<BusinessPartnerStateDto>
 
-    @get:ArraySchema(arraySchema = Schema(description = LegalEntityDescription.classifications))
+    @get:ArraySchema(arraySchema = Schema(description = "The list of classifications of the legal entity, such as a specific industry."))
     val classifications: Collection<ClassificationDto>
 
     @get:Schema(description = "Which roles this business partner takes in relation to the sharing member")
@@ -54,7 +54,7 @@ interface IBaseBusinessPartnerInputDto {
     @get:Schema(description = "")
     val isOwner: Boolean
 
-    @get:Schema(description = "Address of the official seat of this legal entity")
+    @get:Schema(description = "Address of the official seat of this business partner")
     val postalAddress: BusinessPartnerPostalAddressDto
 
 

diff --git a/...sponse/BusinessPartnerInputResponseDto.kt → ...model/response/BusinessPartnerInputDto.kt b/...sponse/BusinessPartnerInputResponseDto.kt → ...model/response/BusinessPartnerInputDto.kt
@@ -27,7 +27,7 @@ import java.time.Instant
 
 
 @Schema(description = "Generic business partner with external id", requiredProperties = ["externalId", "postalAddress"])
-data class BusinessPartnerInputResponseDto(
+data class BusinessPartnerInputDto(
     override val externalId: String,
     override val nameParts: List<String> = emptyList(),
     override val shortName: String?,

diff --git a/...te/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/controller/BusinessPartnerController.kt b/...te/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/controller/BusinessPartnerController.kt
@@ -23,20 +23,20 @@ import org.eclipse.tractusx.bpdm.common.dto.request.PaginationRequest
 import org.eclipse.tractusx.bpdm.common.dto.response.PageDto
 import org.eclipse.tractusx.bpdm.gate.api.GateBusinessPartnerApi
 import org.eclipse.tractusx.bpdm.gate.api.model.request.BusinessPartnerInputRequest
-import org.eclipse.tractusx.bpdm.gate.api.model.response.BusinessPartnerInputResponseDto
+import org.eclipse.tractusx.bpdm.gate.api.model.response.BusinessPartnerInputDto
 import org.springframework.web.bind.annotation.RestController
 
 @RestController
 class BusinessPartnerController() : GateBusinessPartnerApi {
 
-    override fun upsertBusinessPartnersInput(businessPartners: Collection<BusinessPartnerInputRequest>): Collection<BusinessPartnerInputResponseDto> {
+    override fun upsertBusinessPartnersInput(businessPartners: Collection<BusinessPartnerInputRequest>): Collection<BusinessPartnerInputDto> {
         TODO("Not yet implemented")
     }
 
     override fun getBusinessPartnersInputByExternalIds(
         paginationRequest: PaginationRequest,
         externalIds: Collection<String>
-    ): PageDto<BusinessPartnerInputResponseDto> {
+    ): PageDto<BusinessPartnerInputDto> {
         TODO("Not yet implemented")
     }
 }