DTSRD-5698 Updates to retrieveCourtVenuesByServiceCode API - depricate court_type parameter (#1133)

Author: mattnayler

src/main/java/uk/gov/hmcts/reform/lrdapi/controllers/LrdCourtVenueController.java

@@ -67,6 +67,8 @@
 @Slf4j
 public class LrdCourtVenueController {
 
+    private static final String WARNING_COURT_VENUE_ID = "⚠ **Note: the `court_venue_id` property returned "
+        + "should not be used: as it is an internal value that may change.**";
 
     @Value("${loggingComponentName}")
     private String loggingComponentName;
@@ -166,13 +168,12 @@ public ResponseEntity<List<LrdCourtVenueResponse>> retrieveCourtVenues(
 
     @Operation(
         summary = "This API will retrieve Court Venues for given Service Code",
-        description = "No roles required to access this API",
+        description = "No roles required to access this API<br/><br/>" + WARNING_COURT_VENUE_ID,
         security = {
             @SecurityRequirement(name = "ServiceAuthorization"),
             @SecurityRequirement(name = "Authorization")
         }
     )
-
     @ApiResponse(
             responseCode = "200",
             description = "Successfully retrieved list of Court Venues for given Service Code",
@@ -198,7 +199,6 @@ public ResponseEntity<List<LrdCourtVenueResponse>> retrieveCourtVenues(
             description = "Internal Server Error",
             content = @Content
         )
-
     @GetMapping(
         path = "/services",
         produces = APPLICATION_JSON_VALUE