AWS solutions documentation change
Summary
Simplified root cases endpoint documentation by removing schemas, request/response models, and case status enumerations
Security assessment
No security-related content added or modified. Changes appear to be general documentation restructuring without security context.
Diff
diff --git a/solutions/latest/dea-api/cases.md index 8d8a66218..3a2f810ef 100644 --- a/solutions/latest/dea-api/cases.md +++ b/solutions/latest/dea-api/cases.md @@ -5 +5 @@ -URIHTTP methodsSchemasProperties +URIHTTP methods @@ -7,3 +7 @@ URIHTTP methodsSchemasProperties -# 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. +# Cases @@ -18,0 +17,2 @@ The Cases endpoint provides a way to programmatically manage and interact with c +### OPTIONS + @@ -21,77 +21 @@ ResponsesStatus code| Response model| Description -`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| +`204`| None| 204 response @@ -105 +29 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Cases – Case owner +AvailableEndpoints @@ -107 +31 @@ Cases – Case owner -Cases – CSV audit entry for a case +Cases All-cases