AWS solutions documentation change

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

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

Summary

Updated documentation for Cases endpoint with detailed schemas, properties, and request/response models. Added 'Create case' functionality documentation and removed OPTIONS method.

Security assessment

Changes focus on API structure and case management capabilities without mentioning security controls, vulnerabilities, or security-related features. The additions are standard API documentation improvements.

Diff

diff --git a/solutions/latest/dea-api/cases.md b/solutions/latest/dea-api/cases.md
index 3a2f810ef..8d8a66218 100644
--- a//solutions/latest/dea-api/cases.md
+++ b//solutions/latest/dea-api/cases.md
@@ -5 +5 @@
-URIHTTP methods
+URIHTTP methodsSchemasProperties
@@ -7 +7,3 @@ URIHTTP methods
-#  Cases
+# Cases – Create case
+
+The Cases endpoint provides a way to programmatically manage and interact with cases within DEA. It allows users to create a new case with its associated metadata, such as name, description, and status. 
@@ -17,2 +18,0 @@ URIHTTP methods
-### OPTIONS
-
@@ -21 +21,77 @@ ResponsesStatus code| Response model| Description
-`204`| None| 204 response  
+`200`| `Case`| Case successfully created  
+  
+## Schemas
+
+### Request bodies
+    
+    
+    {
+      "name": "string",
+      "description": "string",
+      "status": "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  
+---|---|---|---  
+`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|   
+  
+### CaseFileStatus
+
+  * `ACTIVE`
+
+  * `DELETING`
+
+  * `DELETE_FAILED`
+
+  * `DELETED`
+
+  * `PENDING`
+
+
+
+
+### CaseStatus
+
+  * `ACTIVE`
+
+  * `INACTIVE`
+
+
+
+
+### CreateCaseObject
+
+Property| Type| Required| Description  
+---|---|---|---  
+`description`| string| False|   
+`name`| string| True|   
+`status`| string| True|   
@@ -29 +105 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please
-AvailableEndpoints
+Cases – Case owner
@@ -31 +107 @@ AvailableEndpoints
-Cases All-cases
+Cases – CSV audit entry for a case