[GridDyna] Add some batch CRUD endpoints #111
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -74,9 +74,19 @@ public ResponseEntity<AbstractFilter> createFilter(@RequestParam("id") UUID filt | |||||
| .body(service.createFilter(filter)); | ||||||
| } | ||||||
|
|
||||||
| @PostMapping(value = "/filters/batch", consumes = MediaType.APPLICATION_JSON_VALUE) | ||||||
| @Operation(summary = "Create filters from provided uuids") | ||||||
| @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Filters have been successfully created")}) | ||||||
| public ResponseEntity<List<AbstractFilter>> createFilters(@RequestBody Map<UUID, AbstractFilter> filtersToCreateMap) { | ||||||
| filtersToCreateMap.forEach((uuid, expertFilter) -> expertFilter.setId(uuid)); | ||||||
| return ResponseEntity.ok() | ||||||
| .contentType(MediaType.APPLICATION_JSON) | ||||||
| .body(service.createFilters(filtersToCreateMap.values().stream().toList())); | ||||||
| } | ||||||
|
|
||||||
| @PostMapping(value = "/filters", params = "duplicateFrom") | ||||||
| @Operation(summary = "Duplicate a filter") | ||||||
| @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The uuid of the new filter has been successfully duplicated"), | ||||||
| @ApiResponse(responseCode = "404", description = "Source filter not found")}) | ||||||
| public ResponseEntity<UUID> duplicateFilter(@RequestParam("duplicateFrom") UUID filterId) { | ||||||
| return service.duplicateFilter(filterId).map(newFilterId -> ResponseEntity.ok() | ||||||
|
|
@@ -85,8 +95,19 @@ public ResponseEntity<UUID> duplicateFilter(@RequestParam("duplicateFrom") UUID | |||||
| .orElse(ResponseEntity.notFound().build()); | ||||||
| } | ||||||
|
|
||||||
| @PostMapping(value = "/filters/batch/duplicate") | ||||||
|
There was a problem hiding this comment. Adding Our rest API best practices are not very precise about extra data like this. But they state that the path should only be used to identify a data. @etiennehomer shouldn't we modify the filters duplication signature in an other PR ? There was a problem hiding this comment. We should add "duplicate" in the path of duplicate endpoint, i.e. POST /filters/duplicate but we have to changer also in gridexplorer-app. I think we can change in another TS In fact we should have : At least I can change from /filters/batch/duplicate to /filters/duplicate/batch, what do you think??? @etiennehomer @Mathieu-Deharbe There was a problem hiding this comment. Ok. I think the API you propose is good Thang. So let's change POST /filters/batch/duplicate to POST /filters/duplicate/batch |
||||||
| @Operation(summary = "Duplicate filters from provided uuids") | ||||||
| @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The map of sourceUuid and newUuid of duplicated filters"), | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. Done, I have a slight change from your suggestion to "Filters of given ids have been successfully duplicated" |
||||||
| @ApiResponse(responseCode = "404", description = "Source filter not found")}) | ||||||
| public ResponseEntity<Map<UUID, UUID>> duplicateFilters(@RequestBody List<UUID> filterUuids) { | ||||||
| Map<UUID, UUID> uuidsMap = service.duplicateFilters(filterUuids); | ||||||
| return ResponseEntity.ok() | ||||||
| .contentType(MediaType.APPLICATION_JSON) | ||||||
| .body(uuidsMap); | ||||||
| } | ||||||
|
|
||||||
| @PutMapping(value = "/filters/{id}", consumes = MediaType.APPLICATION_JSON_VALUE) | ||||||
| @Operation(summary = "Modify a filter from a provided fitler uuid and the whole new filter object") | ||||||
| @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The filter has been successfully modified")}) | ||||||
| public ResponseEntity<Void> changeFilter(@PathVariable UUID id, @RequestBody AbstractFilter filter, @RequestHeader("userId") String userId) { | ||||||
| try { | ||||||
|
|
@@ -97,6 +118,15 @@ public ResponseEntity<Void> changeFilter(@PathVariable UUID id, @RequestBody Abs | |||||
| } | ||||||
| } | ||||||
|
|
||||||
| @PutMapping(value = "/filters/batch", consumes = MediaType.APPLICATION_JSON_VALUE) | ||||||
| @Operation(summary = "Modify filters in batch from a provided map of each filter uuid and the corresponding whole new filter object") | ||||||
| @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Filters have been successfully modified")}) | ||||||
| public ResponseEntity<List<AbstractFilter>> changeFilters(@RequestBody Map<UUID, AbstractFilter> filtersToModifyMap) { | ||||||
Mathieu-Deharbe marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| return ResponseEntity.ok() | ||||||
| .contentType(MediaType.APPLICATION_JSON) | ||||||
| .body(service.changeFilters(filtersToModifyMap)); | ||||||
| } | ||||||
|
|
||||||
| @DeleteMapping(value = "/filters/{id}") | ||||||
| @Operation(summary = "delete the filter") | ||||||
| @ApiResponse(responseCode = "200", description = "The filter has been deleted") | ||||||
|
|
@@ -105,6 +135,14 @@ public ResponseEntity<Void> deleteFilter(@PathVariable("id") UUID id) { | |||||
| return ResponseEntity.ok().build(); | ||||||
| } | ||||||
|
|
||||||
| @DeleteMapping(value = "/filters") | ||||||
Mathieu-Deharbe marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| @Operation(summary = "delete the filters") | ||||||
| @ApiResponse(responseCode = "200", description = "The filters have been deleted") | ||||||
| public ResponseEntity<Void> deleteFilters(@RequestBody List<UUID> ids) { | ||||||
| service.deleteFilters(ids); | ||||||
| return ResponseEntity.ok().build(); | ||||||
| } | ||||||
|
|
||||||
| @GetMapping(value = "/filters/metadata") | ||||||
| @Operation(summary = "get filters metadata") | ||||||
| @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "filters metadata"), | ||||||
|
|
||||||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,4 +30,7 @@ public interface FilterRepository<T extends AbstractFilterEntity> extends JpaRep | |
|
|
||
| @Transactional | ||
| Integer removeById(UUID id); | ||
|
|
||
| @Transactional | ||
| void deleteAllByIdIn(List<UUID> ids); | ||
| } | ||
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 |
|---|---|---|
|
|
@@ -8,11 +8,10 @@ | |
| package org.gridsuite.filter.server.repositories.proxies; | ||
|
|
||
| import com.powsybl.commons.PowsyblException; | ||
| import org.gridsuite.filter.AbstractFilter; | ||
| import org.gridsuite.filter.criteriafilter.*; | ||
| import org.gridsuite.filter.server.dto.FilterAttributes; | ||
| import org.gridsuite.filter.server.entities.AbstractFilterEntity; | ||
| import org.gridsuite.filter.server.entities.criteriafilter.*; | ||
| import org.gridsuite.filter.server.repositories.FilterMetadata; | ||
| import org.gridsuite.filter.server.repositories.FilterRepository; | ||
|
|
@@ -123,15 +122,30 @@ public AbstractFilter insert(AbstractFilter f) { | |
| return toDto(getRepository().save(fromDto(f))); | ||
| } | ||
|
|
||
| public List<AbstractFilter> insertAll(List<AbstractFilter> filters) { | ||
| List<F> savedFilterEntities = getRepository().saveAll(filters.stream().map(this::fromDto).toList()); | ||
| return savedFilterEntities.stream().map(this::toDto).toList(); | ||
| } | ||
|
|
||
| public void modify(UUID id, AbstractFilter f) { | ||
| f.setId(id); | ||
| toDto(getRepository().save(fromDto(f))); | ||
| } | ||
|
|
||
| public List<AbstractFilter> modifyAll(Map<UUID, AbstractFilter> filtersToModifyMap) { | ||
| filtersToModifyMap.forEach((uuid, expertFilter) -> expertFilter.setId(uuid)); | ||
| List<F> savedFilterEntities = getRepository().saveAll(filtersToModifyMap.values().stream().map(this::fromDto).toList()); | ||
| return savedFilterEntities.stream().map(this::toDto).toList(); | ||
| } | ||
|
|
||
| public boolean deleteById(UUID id) { | ||
| return getRepository().removeById(id) != 0; | ||
| } | ||
|
|
||
| public void deleteAllByIds(List<UUID> ids) { | ||
| getRepository().deleteAllByIdIn(ids); | ||
| } | ||
|
|
||
| public void deleteAll() { | ||
| getRepository().deleteAll(); | ||
| } | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, I have a slight change from your suggestion to "The filter with given id has been successfully duplicated"