Hide replacement clickhouse endpoints from swagger (except new treatm…

…ent) (#10919)
cBioPortal · Aug 2, 2024 · e935c41 · e935c41
1 parent 8746a34
commit e935c41
Showing 1 changed file with 16 additions and 5 deletions.
diff --git a/src/main/java/org/cbioportal/web/columnar/StudyViewColumnStoreController.java b/src/main/java/org/cbioportal/web/columnar/StudyViewColumnStoreController.java
@@ -1,5 +1,6 @@
 package org.cbioportal.web.columnar;
 
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.media.ArraySchema;
@@ -79,7 +80,7 @@ public StudyViewColumnStoreController(StudyViewColumnarService studyViewColumnar
     }
 
 
-
+    @Hidden
     @PreAuthorize("hasPermission(#involvedCancerStudies, 'Collection<CancerStudyId>', T(org.cbioportal.utils.security.AccessLevel).READ)")
     @PostMapping(value = "/column-store/filtered-samples/fetch",
         consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
@@ -94,6 +95,7 @@ public ResponseEntity<List<Sample>> fetchFilteredSamples(
         );
     }
 
+    @Hidden
     @PreAuthorize("hasPermission(#involvedCancerStudies, 'Collection<CancerStudyId>', T(org.cbioportal.utils.security.AccessLevel).READ)")
     @PostMapping(value = "/column-store/mutated-genes/fetch",
         consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
@@ -109,6 +111,7 @@ public ResponseEntity<List<AlterationCountByGene>> fetchMutatedGenes(
         );
     }
 
+    @Hidden
     @PreAuthorize("hasPermission(#involvedCancerStudies, 'Collection<CancerStudyId>', T(org.cbioportal.utils.security.AccessLevel).READ)")
     @RequestMapping(value = "/column-store/molecular-profile-sample-counts/fetch", method = RequestMethod.POST,
         consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
@@ -128,7 +131,8 @@ public ResponseEntity<List<GenomicDataCount>> fetchMolecularProfileSampleCounts(
             studyViewColumnarService.getGenomicDataCounts(interceptedStudyViewFilter)
             , HttpStatus.OK);
     }
-
+
+    @Hidden
     @PostMapping(value = "/column-store/cna-genes/fetch",
         consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
     public ResponseEntity<List<CopyNumberCountByGene>> fetchCnaGenes(
@@ -142,6 +146,7 @@ public ResponseEntity<List<CopyNumberCountByGene>> fetchCnaGenes(
         );
     }
 
+    @Hidden
     @PostMapping(value = "/column-store/structuralvariant-genes/fetch",
         consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
     @Operation(description = "Fetch structural variant genes by study view filter")
@@ -158,6 +163,7 @@ public ResponseEntity<List<AlterationCountByGene>> fetchStructuralVariantGenes(
         return new ResponseEntity<>(studyViewColumnarService.getStructuralVariantGenes(interceptedStudyViewFilter), HttpStatus.OK);
     }
 
+    @Hidden
     @PreAuthorize("hasPermission(#involvedCancerStudies, 'Collection<CancerStudyId>', T(org.cbioportal.utils.security.AccessLevel).READ)")
     @PostMapping(value = "/column-store/clinical-data-counts/fetch", 
         consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
@@ -180,6 +186,7 @@ public ResponseEntity<List<ClinicalDataCountItem>> fetchClinicalDataCounts(
 
     }
 
+    @Hidden
     @PreAuthorize("hasPermission(#involvedCancerStudies, 'Collection<CancerStudyId>', T(org.cbioportal.utils.security.AccessLevel).READ)")
     @RequestMapping(value = "/column-store/sample-lists-counts/fetch", method = RequestMethod.POST,
         consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
@@ -196,6 +203,7 @@ public List<CaseListDataCount> fetchCaseListCounts(
 
     }
 
+    @Hidden
     @PreAuthorize("hasPermission(#involvedCancerStudies, 'Collection<CancerStudyId>', T(org.cbioportal.utils.security.AccessLevel).READ)")
     @RequestMapping(value = "/column-store/clinical-data-bin-counts/fetch", method = RequestMethod.POST,
         consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
@@ -213,6 +221,7 @@ public ResponseEntity<List<ClinicalDataBin>> fetchClinicalDataBinCounts(
         return new ResponseEntity<>(clinicalDataBins, HttpStatus.OK);
     }
 
+    @Hidden
     @PreAuthorize("hasPermission(#involvedCancerStudies, 'Collection<CancerStudyId>', T(org.cbioportal.utils.security.AccessLevel).READ)")
     @PostMapping(value = "/column-store/clinical-data-density-plot/fetch", consumes = MediaType.APPLICATION_JSON_VALUE, 
         produces = MediaType.APPLICATION_JSON_VALUE)
@@ -270,6 +279,7 @@ public ResponseEntity<DensityPlotData> fetchClinicalDataDensityPlot(
         return new ResponseEntity<>(result, HttpStatus.OK);
     }
 
+    @Hidden
     @PreAuthorize("hasPermission(#involvedCancerStudies, 'Collection<CancerStudyId>', T(org.cbioportal.utils.security.AccessLevel).READ)")
     @PostMapping(value = "/column-store/clinical-data-violin-plots/fetch",
         consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
@@ -330,6 +340,7 @@ public ResponseEntity<ClinicalViolinPlotData> fetchClinicalDataViolinPlots(
         return new ResponseEntity<>(result, HttpStatus.OK);
     }
 
+    @Hidden
     @PreAuthorize("hasPermission(#involvedCancerStudies, 'Collection<CancerStudyId>', T(org.cbioportal.utils.security.AccessLevel).READ)")
     @PostMapping(value = "/column-store/clinical-event-type-counts/fetch", consumes = MediaType.APPLICATION_JSON_VALUE,
         produces = MediaType.APPLICATION_JSON_VALUE)
@@ -353,13 +364,13 @@ public ResponseEntity<List<ClinicalEventTypeCount>> getClinicalEventTypeCounts(
     ) {
         return new ResponseEntity<>(studyViewColumnarService.getClinicalEventTypeCounts(interceptedStudyViewFilter), HttpStatus.OK);
     }
-
+    
     @PreAuthorize("hasPermission(#involvedCancerStudies, 'Collection<CancerStudyId>', T(org.cbioportal.utils.security.AccessLevel).READ)")
     @PostMapping(value = "/column-store/treatments/patient-counts/fetch", produces = MediaType.APPLICATION_JSON_VALUE)
     @Operation(description = "Get all patient level treatments")
     @ApiResponse(responseCode = "200", description = "OK",
-        content = @Content(array = @ArraySchema(schema = @Schema(implementation = PatientTreatmentRow.class))))
-    public ResponseEntity<PatientTreatmentReport> getPatientTreatmentCounts(
+        content = @Content(schema = @Schema(implementation = PatientTreatmentReport.class)))
+    public ResponseEntity<PatientTreatmentReport> fetchPatientTreatmentCounts(
         @Parameter(required = false )
         @RequestParam(name = "tier", required = false, defaultValue = "Agent")
         ClinicalEventKeyCode tier,