AWS solutions documentation change
Summary
Simplified endpoint title, removed all schema definitions and status enums, added OPTIONS method documentation, and updated response codes
Security assessment
Removed previous mention of authentication/authorization requirements but didn't add new security documentation. Changes appear focused on simplifying API documentation structure.
Diff
diff --git a/solutions/latest/dea-api/cases-caseid-details.md index e8ae2d645..ee9d31e78 100644 --- a/solutions/latest/dea-api/cases-caseid-details.md +++ b/solutions/latest/dea-api/cases-caseid-details.md @@ -5 +5 @@ -URIHTTP methodsSchemasProperties +URIHTTP methods @@ -7,3 +7 @@ URIHTTP methodsSchemasProperties -# 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. +# Cases caseId Details @@ -25,4 +22,0 @@ Path parametersName| Type| Required| Description -ResponsesStatus code| Response model| Description ----|---|--- -`200`| `Case`| Success - @@ -35,4 +28,0 @@ Path parametersName| Type| Required| Description -ResponsesStatus code| Response model| Description ----|---|--- -`200`| `Case`| Success - @@ -45,5 +35 @@ Path parametersName| Type| Required| Description -ResponsesStatus code| Response model| Description ----|---|--- -`200`| None| Success - -## Schemas +### OPTIONS @@ -51,30 +37 @@ ResponsesStatus code| Response model| Description -### 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 +Path parametersName| Type| Required| Description @@ -82,36 +39 @@ 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` - - - - -### CaseUpdateRequest +`caseId`| String| True| @@ -119,5 +41,3 @@ Property| Type| Required| Description -Property| Type| Required| Description ----|---|---|--- -`description`| string| False| -`name`| string| True| -`ulid`| string| True| +ResponsesStatus code| Response model| Description +---|---|--- +`204`| None| 204 response @@ -131 +51 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Cases – Available actions by caseId +Cases caseId Audit auditId Csv @@ -133 +53 @@ Cases – Available actions by caseId -Cases – Case file info +Cases caseId Files