Merge pull request #1572 from CMSgov/QPPA-8689

QPPA-8689: Remove swagger logic from codebase

Author: ckawell-sb

README.md

@@ -164,7 +164,7 @@ can be found in the [sample-files](sample-files/README.md) folder.
 
 ## Swagger Info
 
-Swagger will be enabled under `/swagger-ui/index.html#/` path.  And the api docs are avilable under `v3/api-docs`.
+Swagger documentation logic for the CT is handled in the Submissions API codebase.
 
 ## Want to Contribute?
 

commons/src/main/resources/measures-data.json

@@ -14081,8 +14081,10 @@
     "primarySteward": "College of American Pathologists",
     "isInverse": false,
     "isRiskAdjusted": false,
-    "isIcdImpacted": false,
-    "icdImpacted": [],
+    "isIcdImpacted": true,
+    "icdImpacted": [
+      "registry"
+    ],
     "isClinicalGuidelineChanged": false,
     "clinicalGuidelineChanged": [],
     "companionMeasureId": [],
@@ -14820,10 +14822,6 @@
       {
         "name": "6points",
         "description": "Percentage of patients aged 14 years and older who achieved a net increase in PAM® score of at least 6 points in a 6 to 12 month period."
-      },
-      {
-        "name": "aveChg",
-        "description": "Average change between baseline PAM® score and the second score within 6 to 12 months of a baseline PAM® score."
       }
     ]
   },
@@ -15142,8 +15140,7 @@
     "measureId": "510",
     "title": "First Year Standardized Waitlist Ratio (FYSWR)",
     "description": "The number of newly initiated patients on dialysis in a practitioner group who are under the age of 75 and were either listed on the kidney or kidney-pancreas transplant waitlist or received a living donor transplant within the first year of initiating dialysis. The practitioner group is inclusive of physicians and advanced practice providers. The measure is the ratio-observed number of waitlist events in a practitioner group to its expected number of waitlist events. The measure uses the expected waitlist events calculated from a Cox model, which is adjusted for age, patient comorbidities, and other risk factors at the time of dialysis.",
-    "metricType": "multiPerformanceRate",
-    "overallAlgorithm": "split",
+    "metricType": "nonProportion",
     "isRegistryMeasure": false,
     "firstPerformanceYear": 2025,
     "lastPerformanceYear": null,
@@ -15180,16 +15177,6 @@
       "group",
       "subgroup",
       "individual"
-    ],
-    "strata": [
-      {
-        "name": "reporting",
-        "description": "Percentage of patients in their first year of dialysis who had documentation of waitlist status at the end of the performance period"
-      },
-      {
-        "name": "performance",
-        "description": "Ratio of the observed number of waitlist events to the number of expected waitlist events"
-      }
     ]
   },
   {
@@ -19236,7 +19223,8 @@
     "companionMeasureId": [],
     "allowedPrograms": [
       "mips",
-      "app1"
+      "app1",
+      "appPlus"
     ],
     "submissionMethods": [
       "certifiedSurveyVendor"
@@ -19275,7 +19263,8 @@
     "companionMeasureId": [],
     "allowedPrograms": [
       "mips",
-      "app1"
+      "app1",
+      "appPlus"
     ],
     "submissionMethods": [
       "certifiedSurveyVendor"
@@ -19314,7 +19303,8 @@
     "companionMeasureId": [],
     "allowedPrograms": [
       "mips",
-      "app1"
+      "app1",
+      "appPlus"
     ],
     "submissionMethods": [
       "certifiedSurveyVendor"
@@ -19353,7 +19343,8 @@
     "companionMeasureId": [],
     "allowedPrograms": [
       "mips",
-      "app1"
+      "app1",
+      "appPlus"
     ],
     "submissionMethods": [
       "certifiedSurveyVendor"
@@ -19392,7 +19383,8 @@
     "companionMeasureId": [],
     "allowedPrograms": [
       "mips",
-      "app1"
+      "app1",
+      "appPlus"
     ],
     "submissionMethods": [
       "certifiedSurveyVendor"
@@ -19431,7 +19423,8 @@
     "companionMeasureId": [],
     "allowedPrograms": [
       "mips",
-      "app1"
+      "app1",
+      "appPlus"
     ],
     "submissionMethods": [
       "certifiedSurveyVendor"
@@ -19470,7 +19463,8 @@
     "companionMeasureId": [],
     "allowedPrograms": [
       "mips",
-      "app1"
+      "app1",
+      "appPlus"
     ],
     "submissionMethods": [
       "certifiedSurveyVendor"
@@ -19509,7 +19503,8 @@
     "companionMeasureId": [],
     "allowedPrograms": [
       "mips",
-      "app1"
+      "app1",
+      "appPlus"
     ],
     "submissionMethods": [
       "certifiedSurveyVendor"
@@ -19548,7 +19543,8 @@
     "companionMeasureId": [],
     "allowedPrograms": [
       "mips",
-      "app1"
+      "app1",
+      "appPlus"
     ],
     "submissionMethods": [
       "certifiedSurveyVendor"
@@ -19587,7 +19583,8 @@
     "companionMeasureId": [],
     "allowedPrograms": [
       "mips",
-      "app1"
+      "app1",
+      "appPlus"
     ],
     "submissionMethods": [
       "certifiedSurveyVendor"

rest-api/pom.xml

@@ -155,7 +155,7 @@
             <dependency>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-dependencies</artifactId>
-                <version>3.4.8</version>
+                <version>3.4.11</version>
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>
@@ -227,11 +227,6 @@
                 <artifactId>snakeyaml</artifactId>
                 <version>2.3</version>
             </dependency>
-            <dependency>
-                <groupId>io.swagger.core.v3</groupId>
-                <artifactId>swagger-annotations</artifactId>
-                <version>2.2.9</version>
-            </dependency>
         </dependencies>
     </dependencyManagement>
 

rest-api/src/main/java/gov/cms/qpp/conversion/api/config/OpenAPIConfig.java

@@ -3,12 +3,6 @@
 import gov.cms.qpp.conversion.api.model.HealthCheck;
 import gov.cms.qpp.conversion.api.services.VersionService;
 
-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 io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -19,7 +13,6 @@
 /**
  * Controller to simply respond with status 200 with a GET /health call.
  */
-@Tag(name = "Health Check")
 @RestController
 @RequestMapping("/health")
 public class HealthCheckController {
@@ -40,11 +33,6 @@ public HealthCheckController(VersionService version) {
 	 *
 	 * @return health check of version, environment variables, and system properties
 	 */
-	@Operation(summary = "Gets the current state of the API.", description = "Returns the environment variables, system properties and implementation version of the conversion tool.")
-	@ApiResponses({
-			@ApiResponse(responseCode = "200", content = { @Content(schema = @Schema(implementation = HealthCheck.class), mediaType = "application/json") }),
-			@ApiResponse(responseCode = "404", content = { @Content(schema = @Schema()) }),
-			@ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }) })
 	@GetMapping
 	@ResponseStatus(HttpStatus.OK)
 	public @ResponseBody HealthCheck health() {

rest-api/src/main/java/gov/cms/qpp/conversion/api/controllers/HealthCheckController.java

@@ -6,17 +6,13 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 
-import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.tags.Tag;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.util.ObjectUtils;
-import org.springframework.util.StringUtils;
 import org.springframework.web.bind.annotation.*;
 import org.springframework.web.multipart.MultipartFile;
 
@@ -32,7 +28,6 @@
 /**
  * Controller to handle uploading files for QRDA-III Conversion
  */
-@Tag(name="Conversion")
 @RestController
 @CrossOrigin
 public abstract class SkeletalQrdaController<T> {
@@ -66,8 +61,6 @@ public SkeletalQrdaController(QrdaService qrdaService, ValidationService validat
 	 * @param purpose the purpose for the conversion
 	 * @return Valid json or error json content
 	 */
-	@Operation(summary = "Converts QRDA3 XML to QPP JSON", description = "Converts QRDA3 XML to QPP JSON. Provide a QRDA3 XML file as a multipart file. The response body will contain the QPP JSON upon success or error JSON on failure.")
-	@Parameter(name = "Purpose", hidden = true)
 	@PostMapping(consumes = {"multipart/form-data"})
 	public ResponseEntity<T> uploadQrdaFile(
 		@RequestParam(name = "file") MultipartFile file,

rest-api/src/main/java/gov/cms/qpp/conversion/api/controllers/SkeletalQrdaController.java

@@ -1,19 +1,12 @@
 package gov.cms.qpp.conversion.api.controllers.v1;
 
-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 io.swagger.v3.oas.annotations.tags.Tag;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.core.io.InputStreamResource;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.util.ObjectUtils;
-import org.springframework.util.StringUtils;
 import org.springframework.web.bind.annotation.CrossOrigin;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -31,7 +24,6 @@
 import java.io.IOException;
 import java.util.List;
 
-@Tag(name = "PCF Endpoints")
 @RestController
 @RequestMapping("/pcf")
 @CrossOrigin(allowCredentials = "false")
@@ -52,11 +44,6 @@ public PcfFileControllerV1(AdvancedApmFileService advancedApmFileService) {
 	 *
 	 * @return Valid json or error json content
 	 */
-	@Operation(summary = "Retrieve unprocessed files", description = "Retrieve a list of unprocessed CPC+ files.")
-	@ApiResponses({
-			@ApiResponse(responseCode = "200", content = { @Content(schema = @Schema(implementation = UnprocessedFileData.class), mediaType = "application/json") }),
-			@ApiResponse(responseCode = "404", content = { @Content(schema = @Schema()) }),
-			@ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }) })
 	@GetMapping(value = "/unprocessed-files/{org}",
 		headers = {"Accept=" + Constants.V1_API_ACCEPT})
 	public ResponseEntity<List<UnprocessedFileData>> getUnprocessedPcfPlusFiles(@PathVariable("org") String organization) {
@@ -86,11 +73,6 @@ public ResponseEntity<List<UnprocessedFileData>> getUnprocessedPcfPlusFiles(@Pat
 	 * @return object json or xml content
 	 * @throws IOException if S3Object content stream is invalid
 	 */
-	@Operation(summary = "Retrieve a submitted QPP JSON file", description = "Retrieves the submitted file content containing converted QPP JSON data")
-	@ApiResponses({
-			@ApiResponse(responseCode = "200", content = { @Content(schema = @Schema(), mediaType = "application/json") }),
-			@ApiResponse(responseCode = "404", content = { @Content(schema = @Schema()) }),
-			@ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }) })
 	@GetMapping(value = "/qpp/{fileId}",
 		headers = {"Accept=" + Constants.V1_API_ACCEPT})
 	public ResponseEntity<InputStreamResource> getQppById(@PathVariable("fileId") String fileId)
@@ -116,11 +98,6 @@ public ResponseEntity<InputStreamResource> getQppById(@PathVariable("fileId") St
 	 * @return object json or xml content
 	 * @throws IOException if S3Object content stream is invalid
 	 */
-	@Operation(summary = "Retrieve a submitted QRDA-III file", description = "Retrieves the submitted file containing QRDA-III XML data")
-	@ApiResponses({
-			@ApiResponse(responseCode = "200", content = { @Content(schema = @Schema(), mediaType = "application/xml") }),
-			@ApiResponse(responseCode = "404", content = { @Content(schema = @Schema()) }),
-			@ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }) })
 	@GetMapping(value = "/file/{fileId}",
 		headers = {"Accept=" + Constants.V1_API_ACCEPT})
 	public ResponseEntity<InputStreamResource> getFileById(@PathVariable("fileId") String fileId)
@@ -146,11 +123,6 @@ public ResponseEntity<InputStreamResource> getFileById(@PathVariable("fileId") S
 	 * @param request The new state of the file being updated
 	 * @return Message if the file was updated or not
 	 */
-	@Operation(summary = "Update status of CPC+ file", description = "Update the status of a CPC+ file to processed/unprocessed.  Returns if the file has been updated as processed/unprocessed.")
-	@ApiResponses({
-			@ApiResponse(responseCode = "200", content = { @Content(schema = @Schema(), mediaType = "text/plain") }),
-			@ApiResponse(responseCode = "404", content = { @Content(schema = @Schema()) }),
-			@ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }) })
 	@PutMapping(value = "/file/{fileId}/{org}",
 		headers = {"Accept=" +
 			Constants.V1_API_ACCEPT})

rest-api/src/main/java/gov/cms/qpp/conversion/api/controllers/v1/PcfFileControllerV1.java

@@ -9,7 +9,6 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 
-import io.swagger.v3.oas.annotations.Hidden;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpHeaders;
@@ -25,7 +24,6 @@
 import gov.cms.qpp.conversion.api.services.QrdaService;
 import gov.cms.qpp.conversion.api.services.ValidationService;
 
-@Hidden
 @RestController
 @RequestMapping(path = "/", headers = {"Accept=application/zip"})
 public class ZipController extends SkeletalQrdaController<List<ConvertResponse>> {