AWS solutions documentation change

Service: solutions · 2025-04-20 · Documentation low

File: solutions/latest/dea-api/cases-caseid-details.md

Summary

Updated API documentation with enhanced endpoint description, added authentication/authorization requirements, expanded schemas, properties, and response models

Security assessment

Added explicit mention of authentication and authorization requirements for accessing case details. While this improves security documentation, there's no evidence of addressing a specific vulnerability.

Diff

diff --git a/solutions/latest/dea-api/cases-caseid-details.md b/solutions/latest/dea-api/cases-caseid-details.md
index ee9d31e78..e8ae2d645 100644
--- a//solutions/latest/dea-api/cases-caseid-details.md
+++ b//solutions/latest/dea-api/cases-caseid-details.md
@@ -5 +5 @@
-URIHTTP methods
+URIHTTP methodsSchemasProperties
@@ -7 +7,3 @@ URIHTTP methods
-#  Cases caseId Details
+# Cases – Case details by caseId
+
+This endpoint provides a way to retrieve detailed information about a specific case within Digital Evidence Archive, facilitating better management and understanding of the case. This information includes the case name, description, creation date, status, and any other relevant metadata. The API requires authentication and authorization to ensure that only authorized users can retrieve the details of the case. 
@@ -22,0 +25,4 @@ Path parametersName| Type| Required| Description
+ResponsesStatus code| Response model| Description  
+---|---|---  
+`200`| `Case`| Success  
+  
@@ -28,0 +35,4 @@ Path parametersName| Type| Required| Description
+ResponsesStatus code| Response model| Description  
+---|---|---  
+`200`| `Case`| Success  
+  
@@ -35 +45,3 @@ Path parametersName| Type| Required| Description
-### OPTIONS
+ResponsesStatus code| Response model| Description  
+---|---|---  
+`200`| None| Success  
@@ -37 +49,32 @@ Path parametersName| Type| Required| Description
-Path parametersName| Type| Required| Description  
+## Schemas
+
+### Request bodies
+    
+    
+    {
+      "ulid": "string",
+      "name": "string",
+      "description": "string"
+    }
+
+### Response bodies
+    
+    
+    {
+      "ulid": "string",
+      "name": "string",
+      "status": enum,
+      "description": "string",
+      "objectCount": number,
+      "totalSizeBytes": number,
+      "fileStatus": enum,
+      "s3BatchJobId": "string",
+      "created": "string",
+      "updated": "string"
+    }
+
+## Properties
+
+### Case
+
+Property| Type| Required| Description  
@@ -39 +82,10 @@ Path parametersName| Type| Required| Description
-`caseId`| String| True|   
+`created`| string| False|   
+`description`| string| False|   
+`fileStatus`| CaseFileStatus| False|   
+`name`| string| False|   
+`objectCount`| number| False|   
+`s3BatchJobId`| string| False|   
+`status`| CaseStatus| False|   
+`totalSizeBytes`| number| False|   
+`ulid`| string| False|   
+`updated`| string| False|   
@@ -41,3 +93,31 @@ Path parametersName| Type| Required| Description
-ResponsesStatus code| Response model| Description  
----|---|---  
-`204`| None| 204 response  
+### CaseFileStatus
+
+  * `ACTIVE`
+
+  * `DELETING`
+
+  * `DELETE_FAILED`
+
+  * `DELETED`
+
+  * `PENDING`
+
+
+
+
+### CaseStatus
+
+  * `ACTIVE`
+
+  * `INACTIVE`
+
+
+
+
+### CaseUpdateRequest
+
+Property| Type| Required| Description  
+---|---|---|---  
+`description`| string| False|   
+`name`| string| True|   
+`ulid`| string| True|   
@@ -51 +131 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please
-Cases caseId Audit auditId Csv
+Cases – Available actions by caseId
@@ -53 +133 @@ Cases caseId Audit auditId Csv
-Cases caseId Files
+Cases – Case file info