feat(generic bpm): eclipse-tractusx#387 Gate API: Create output endpo…

…ints for generic business partner

bpdm-gate-api/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/GateBusinessPartnerApi.kt

@@ -28,6 +28,7 @@ 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.BusinessPartnerInputDto
+import org.eclipse.tractusx.bpdm.gate.api.model.response.BusinessPartnerOutputDto
 import org.springdoc.core.annotations.ParameterObject
 import org.springframework.http.MediaType
 import org.springframework.web.bind.annotation.PostMapping
@@ -65,7 +66,7 @@ interface GateBusinessPartnerApi {
     )
     @ApiResponses(
         value = [
-            ApiResponse(responseCode = "200", description = "The requested page of business partners"),
+            ApiResponse(responseCode = "200", description = "The requested page of busines partners"),
             ApiResponse(responseCode = "400", description = "On malformed pagination request", content = [Content()]),
         ]
     )
@@ -76,4 +77,23 @@ interface GateBusinessPartnerApi {
         @RequestBody externalIds: Collection<String>
     ): PageDto<BusinessPartnerInputDto>
 
+
+    @Operation(
+        summary = "Search business partners by an array of external IDs from the output stage",
+        description = "Get page of business partners output data filtered by a collection of external IDs. " +
+                "An empty external ID list will return a paginated list of all business partners."
+    )
+    @ApiResponses(
+        value = [
+            ApiResponse(responseCode = "200", description = "The requested page of business partners"),
+            ApiResponse(responseCode = "400", description = "On malformed pagination request", content = [Content()]),
+        ]
+    )
+    @PostMapping("/output/business-partners/search")
+    @PostExchange("/output/business-partners/search")
+    fun getLegalEntitiesOutput(
+        @ParameterObject @Valid paginationRequest: PaginationRequest,
+        @RequestBody(required = false) externalIds: Collection<String>?
+    ): PageDto<BusinessPartnerOutputDto>
+
 }

bpdm-gate-api/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/model/response/BusinessPartnerOutputDto.kt

@@ -0,0 +1,56 @@
+/*******************************************************************************
+ * Copyright (c) 2021,2023 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Apache License, Version 2.0 which is available at
+ * https://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
+ ******************************************************************************/
+
+package org.eclipse.tractusx.bpdm.gate.api.model.response
+
+import io.swagger.v3.oas.annotations.media.Schema
+import org.eclipse.tractusx.bpdm.common.dto.ClassificationDto
+import org.eclipse.tractusx.bpdm.common.dto.openapidescription.CommonDescription
+import org.eclipse.tractusx.bpdm.gate.api.model.*
+import java.time.Instant
+
+
+@Schema(description = "Generic business partner output with external id", requiredProperties = ["externalId", "postalAddress", "bpna", "bpnl"])
+data class BusinessPartnerOutputDto(
+    override val externalId: String,
+    override val nameParts: List<String> = emptyList(),
+    override val shortName: String?,
+    override val identifiers: Collection<BusinessPartnerIdentifierDto> = emptyList(),
+    override val legalForm: String? = null,
+    override val states: Collection<BusinessPartnerStateDto> = emptyList(),
+    override val classifications: Collection<ClassificationDto> = emptyList(),
+    override val roles: Collection<BusinessPartnerRole> = emptyList(),
+    override val postalAddress: BusinessPartnerPostalAddressDto,
+    override val isOwner: Boolean,
+
+    @get:Schema(description = "BPNA")
+    val bpna: String,
+
+    @get:Schema(description = "BPNS")
+    val bpns: String?,
+
+    @get:Schema(description = "BPNL")
+    val bpnl: String,
+
+    @get:Schema(description = CommonDescription.createdAt)
+    val createdAt: Instant,
+
+    @get:Schema(description = CommonDescription.updatedAt)
+    val updatedAt: Instant,
+) : IBaseBusinessPartnerInputDto

bpdm-gate/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/controller/BusinessPartnerController.kt

@@ -24,6 +24,7 @@ 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.BusinessPartnerInputDto
+import org.eclipse.tractusx.bpdm.gate.api.model.response.BusinessPartnerOutputDto
 import org.springframework.web.bind.annotation.RestController
 
 @RestController
@@ -39,4 +40,10 @@ class BusinessPartnerController() : GateBusinessPartnerApi {
     ): PageDto<BusinessPartnerInputDto> {
         TODO("Not yet implemented")
     }
+
+    override fun getLegalEntitiesOutput(paginationRequest: PaginationRequest, externalIds: Collection<String>?): PageDto<BusinessPartnerOutputDto> {
+        TODO("Not yet implemented")
+    }
+
+
 }