-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(Gate): add business partner relations
- add new endpoints to search, create, update and delete business partner relations - add logic for CRUD and constraint checking - add database table for relations - add tests
- Loading branch information
Showing
56 changed files
with
4,834 additions
and
265 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
147 changes: 147 additions & 0 deletions
147
bpdm-gate-api/src/main/kotlin/org/eclipse/tractusx/bpdm/gate/api/GateRelationApi.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2021,2024 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 | ||
|
|
||
| import io.swagger.v3.oas.annotations.Operation | ||
| import io.swagger.v3.oas.annotations.media.Content | ||
| import io.swagger.v3.oas.annotations.media.Schema | ||
| import io.swagger.v3.oas.annotations.responses.ApiResponse | ||
| import io.swagger.v3.oas.annotations.responses.ApiResponses | ||
| import jakarta.validation.Valid | ||
| import org.eclipse.tractusx.bpdm.common.dto.PageDto | ||
| import org.eclipse.tractusx.bpdm.common.dto.PaginationRequest | ||
| import org.eclipse.tractusx.bpdm.gate.api.GateRelationApi.Companion.RELATIONS_PATH | ||
| import org.eclipse.tractusx.bpdm.gate.api.model.RelationDto | ||
| import org.eclipse.tractusx.bpdm.gate.api.model.RelationType | ||
| import org.eclipse.tractusx.bpdm.gate.api.model.request.RelationPostRequest | ||
| import org.eclipse.tractusx.bpdm.gate.api.model.request.RelationPutRequest | ||
| import org.eclipse.tractusx.bpdm.gate.api.model.response.GateErrorResponse | ||
| import org.springdoc.core.annotations.ParameterObject | ||
| import org.springframework.http.MediaType | ||
| import org.springframework.web.bind.annotation.* | ||
| import java.time.Instant | ||
|
|
||
| @RequestMapping(RELATIONS_PATH, produces = [MediaType.APPLICATION_JSON_VALUE]) | ||
| interface GateRelationApi { | ||
|
|
||
| companion object{ | ||
| const val RELATIONS_PATH = "${ApiCommons.BASE_PATH}/input/business-partner-relations" | ||
| } | ||
|
|
||
| @Operation( | ||
| summary = "Find business partner input relations", | ||
| description = "Find paginated list of business partner relations from the input stage. " + | ||
| "There are various filter criteria available. " + | ||
| "All filters are 'AND' filters." | ||
| ) | ||
| @ApiResponses( | ||
| value = [ | ||
| ApiResponse(responseCode = "200", description = "A paginated list of business partner relations for the input stage") | ||
| ] | ||
| ) | ||
| @GetMapping | ||
| fun get( | ||
| @Schema(description = "The BPNL of the tenant to search in. If not given, the system attempts to infer the tenant from the authentication.") | ||
| @RequestParam tenantBpnL: String? = null, | ||
| @Schema(description = "Only show relations with the given external identifiers") | ||
| @RequestParam externalIds: List<String>? = null, | ||
| @Schema(description = "Only show relations of the given type") | ||
| @RequestParam relationType: RelationType? = null, | ||
| @Schema(description = "Only show relations which have the given business partners as sources") | ||
| @RequestParam businessPartnerSourceExternalIds: List<String>? = null, | ||
| @Schema(description = "Only show relations which have the given business partners as targets") | ||
| @RequestParam businessPartnerTargetExternalIds: List<String>? = null, | ||
| @Schema(description = "Only show relations which have been modified after the given time stamp") | ||
| @RequestParam updatedAtFrom: Instant? = null, | ||
| @ParameterObject @Valid paginationRequest: PaginationRequest = PaginationRequest() | ||
| ): PageDto<RelationDto> | ||
|
|
||
| @Operation( | ||
| summary = "Create a new business partner input relation", | ||
| description = "Create a new relation between two business partner entries on the input stage. " + | ||
| "The external identifier is optional and a new one will be automatically created if not given. " + | ||
| "A given external identifier has to be unique." | ||
| ) | ||
| @ApiResponses( | ||
| value = [ | ||
| ApiResponse(responseCode = "201", description = "The created business partner input relation"), | ||
| ApiResponse(responseCode = "400", description = "If the business partner could not be created based on wrong or insufficient data provided such as non-existent business partners or violated relation constraints. ", | ||
| content = [Content( | ||
| mediaType = "application/json", | ||
| schema = Schema(implementation = GateErrorResponse::class) | ||
| )]), | ||
| ApiResponse(responseCode = "409", description = "If a relation with the given external identifier already exists", | ||
| content = [Content( | ||
| mediaType = "application/json", | ||
| schema = Schema(implementation = GateErrorResponse::class) | ||
| )]), | ||
| ] | ||
| ) | ||
| @PostMapping(consumes = [MediaType.APPLICATION_JSON_VALUE]) | ||
| fun post( | ||
| @RequestBody requestBody: RelationPostRequest | ||
| ): RelationDto | ||
|
|
||
| @Operation( | ||
| summary = "Update a business partner input relation", | ||
| description = "Update an existing business partner relation on the input stage. " + | ||
| "By using a request parameter it is also possible to create a relation if the relation with the given external identifier does not exist. " | ||
| ) | ||
| @ApiResponses( | ||
| value = [ | ||
| ApiResponse(responseCode = "200", description = "The given business partner relation has been updated."), | ||
| ApiResponse(responseCode = "400", description = "On wrong or insufficient user provided data like references to non-existent business partners or relations that violate the relation constraints. ", | ||
| content = [Content( | ||
| mediaType = "application/json", | ||
| schema = Schema(implementation = GateErrorResponse::class) | ||
| )]) | ||
| ] | ||
| ) | ||
| @PutMapping(consumes = [MediaType.APPLICATION_JSON_VALUE]) | ||
| fun put( | ||
| @Schema(description = "If true a business partner relation will be created even if a relation could not be found under the given external identifier.") | ||
| @RequestParam createIfNotExist: Boolean = false, | ||
| @RequestBody requestBody: RelationPutRequest | ||
| ): RelationDto | ||
|
|
||
| @Operation( | ||
| summary = "Delete an existing business partner relation", | ||
| description = "Delete a relation between two business partners on the input stage." | ||
| ) | ||
| @ApiResponses( | ||
| value = [ | ||
| ApiResponse(responseCode = "200", description = "The specified relation has been deleted."), | ||
| ApiResponse(responseCode = "400", description = "On specifying a relation that does not exist. ", | ||
| content = [Content( | ||
| mediaType = "application/json", | ||
| schema = Schema(implementation = GateErrorResponse::class) | ||
| )]) | ||
| ] | ||
| ) | ||
| @DeleteMapping | ||
| fun delete( | ||
| @Schema(description = "The BPNL of the tenant to search in. If not given, the system attempts to infer the tenant from the authentication.") | ||
| @RequestParam tenantBpnL: String? = null, | ||
| @Schema(description = "The external identifier of the business partner relation to delete") | ||
| @RequestParam externalId: String | ||
| ) | ||
|
|
||
|
|
||
| } |
Oops, something went wrong.