Updated openapi spec

CDCgov · May 20, 2024 · 16298db · 16298db
1 parent 3ae0ca8
commit 16298db
Showing 1 changed file with 103 additions and 30 deletions.
diff --git a/docs/processing-status-openapi-spec.yaml b/docs/processing-status-openapi-spec.yaml
@@ -452,34 +452,42 @@ paths:
           content:
             application/json:
               schema:
-                anyOf:
-                  - $ref: '#/components/schemas/HL7Report'
-                  - $ref: '#/components/schemas/CSVReport'
+                type: array
+                items:
+                  anyOf:
+                    - $ref: '#/components/schemas/HL7Report'
+                    - $ref: '#/components/schemas/CSVReport'
         '400':
           description: Bad request.  The identifier provided was not found.
         '401':
           description: Authorization information is missing or invalid.
-  '/report/ids/{dataStreamId}':
+  '/report/stage/{dataStreamId}/{stageName}':
     get:
       tags:
         - DEX Reports
-      summary: Provides list of report identifiers for given criteria. (Not yet implemented)
+      summary: Report counts for the given criteria data stream ID and stage name.
       description: >-
-        Provides list of report identifiers for the given criteria. **(Not yet implemented)**
+        Provides report counts for the given criteria.
       parameters:
+        - name: dataStreamId
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Filter by the data stream identifier to retrieve the report counts for.
         - name: dataStreamRoute
           in: query
+          required: false
           schema:
             type: string
-          description: >-
-            If specified, also filter by dataStreamRoute that was provided with the upload.
-          example: RoutineImmunization
-        - name: dataStreamId
+          description: If specified, also filter by data_stream_route that was provided with the upload.
+          example: routineImmunization
+        - name: stageName
           in: path
           required: true
           schema:
             type: string
-          description: Data Stream identifier to retrieve all the upload statuses for.
+          description: Filter by the data stream identifier to retrieve the report counts for.
         - name: date_start
           in: query
           schema:
@@ -496,28 +504,23 @@ paths:
             End date of filter.  Format is YYYYMMDDTHHMMSSZ (UTC format,
             exclusive).  Defaults to today.
           example: 20231030T14103000Z
+        - name: days_interval
+          in: query
+          schema:
+            type: string
+          description: >-
+            Number of days for which the query should be executed.
       responses:
         '200':
-          description: List of report identifiers
+          description: Report counts for the given criteria
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  type: object
-                  properties:
-                    report_id:
-                      type: string
-                      format: uuid
-                    timestamp:
-                      type: string
-                      format: date-time
-                    destination_id:
-                      type: string
-                    event_type:
-                      type: string
+                anyOf:
+                  - $ref: '#/components/schemas/HL7Report'
+                  - $ref: '#/components/schemas/CSVReport'
         '400':
-          description: Bad request.  The identifier provided was not found.
+          description: Bad request.  The destination identifier provided was not found.
         '401':
           description: Authorization information is missing or invalid.
   '/info/dataStreamId':
@@ -690,7 +693,7 @@ paths:
           description: Bad request.  The destination identifier provided was not found.
         '401':
           description: Authorization information is missing or invalid.
-  '/report/counts/{uploadId}':
+  '/report/counts/id/{uploadId}':
     get:
       tags:
         - DEX Status
@@ -717,6 +720,75 @@ paths:
           description: Bad request.  The destination identifier provided was not found.
         '401':
           description: Authorization information is missing or invalid.
+  '/report/counts/uploadStats':
+    get:
+      tags:
+        - DEX Status
+      summary: Get upload stats for the data stream ID and route.
+      description: >-
+        Get upload stats for the data stream ID and route provided over the date range or days interval provided.
+      parameters:
+        - name: data_stream_id
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Filter by the data stream identifier to retrieve the report counts for.
+        - name: data_stream_route
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Filter by the data stream route that was provided with the upload.
+          example: routineImmunization
+        - name: date_start
+          in: query
+          schema:
+            type: string
+          description: >-
+            Start date of filter.  Format is YYYYMMDDTHHMMSSZ (UTC format,
+            inclusive).  Defaults to 3 months prior to today.
+          example: 20231020T14103000Z
+        - name: date_end
+          in: query
+          schema:
+            type: string
+          description: >-
+            End date of filter.  Format is YYYYMMDDTHHMMSSZ (UTC format,
+            exclusive).  Defaults to today.
+          example: 20231030T14103000Z
+        - name: days_interval
+          in: query
+          schema:
+            type: string
+          description: >-
+            Number of days for which the query should be executed.
+      responses:
+        '200':
+          description: Report counts for the given upload identifier
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  unique_upload_ids_count:
+                    type: integer
+                  uploads_with_status_count:
+                    type: integer
+                  bad_metadata_count:
+                    type: integer
+                  in_progress_upload_count:
+                    type: integer
+                  completed_upload_count:
+                    type: integer
+                  uploads_with_duplicate_filenames:
+                    type: integer
+                  query_time_millis:
+                    type: integer
+        '400':
+          description: Bad request.  The destination identifier provided was not found.
+        '401':
+          description: Authorization information is missing or invalid.
   '/report/counts':
     get:
       tags:
@@ -759,7 +831,7 @@ paths:
           schema:
             type: string
           description: >-
-            Number of days for which the query should be executed.  
+            Number of days for which the query should be executed.
       responses:
         '200':
           description: Report counts for the given upload identifier
@@ -813,7 +885,7 @@ paths:
           schema:
             type: string
           description: >-
-            Number of days for which the query should be executed.  
+            Number of days for which the query should be executed.
       responses:
         '200':
           description: Report counts for the given criteria
@@ -1117,6 +1189,7 @@ paths:
           description: Bad request.  The destination identifier provided was not found.
         '401':
           description: Authorization information is missing or invalid.
+
   '/health':
     get:
       tags: