AWS solutions documentation change
Summary
Simplified API documentation structure, removed schemas/properties sections, changed HTTP methods (POST to OPTIONS), and updated endpoint descriptions
Security assessment
Changes focus on restructuring API documentation rather than addressing security issues. While original text mentions authentication/authorization, there's no evidence of security vulnerability fixes or new security features added.
Diff
diff --git a/solutions/latest/dea-api/cases-caseid-files.md index ec9631d55..9a6b04b9c 100644 --- a/solutions/latest/dea-api/cases-caseid-files.md +++ b/solutions/latest/dea-api/cases-caseid-files.md @@ -5 +5 @@ -URIHTTP methodsSchemasProperties +URIHTTP methods @@ -7,3 +7 @@ URIHTTP methodsSchemasProperties -# Cases – Files by caseId - -This endpoint provides a way to manage files within a specific case in Digital Evidence Archive, allowing users to upload and retrieve files as needed. The API requires authentication and authorization to ensure that only authorized users can retrieve the details of the case. +# Cases caseId Files @@ -25,5 +23 @@ Path parametersName| Type| Required| Description -Query parametersName| Type| Required| Description ----|---|---|--- -`filePath`| String| False| -`limit`| Integer| False| -`next`| String| False| +### POST @@ -31,3 +25,3 @@ Query parametersName| Type| Required| Description -ResponsesStatus code| Response model| Description ----|---|--- -`200`| `Cases_response_200_3`| Success +Path parametersName| Type| Required| Description +---|---|---|--- +`caseId`| String| True| @@ -35 +29 @@ ResponsesStatus code| Response model| Description -### POST +### OPTIONS @@ -43,177 +37 @@ ResponsesStatus code| Response model| Description -`200`| `CaseUploadResponse`| Success Response - -## Schemas - -### Request bodies - - - { - "fileName": "string", - "filePath": "string", - "caseUlid": "string", - "fileSizeBytes": number, - "details": "string", - "reason": "string", - "uploadId": "string", - "contentType": "string" - } - -### Response bodies - - - { - "caseFiles": [ - [ - { - "fileName": "string", - "filePath": "string", - "caseUlid": "string", - "contentType": "string", - "createdBy": "string", - "fileSizeBytes": number, - "sha256Hash": "string", - "ulid": "string", - "status": enum, - "uploadId": "string", - "isFile": boolean, - "created": "string", - "updated": "string", - "details": "string", - "fileS3Key": "string", - "dataVaultUlid": "string", - "executionId": "string", - "associationCreatedby": "string", - "associationDate": "string", - "dataVaultUploadDate": "string", - "dataVaultName": "string", - "reason": "string" - } - ] - ], - "total": number, - "next": "string" - } - - - { - "fileName": "string", - "filePath": "string", - "caseUlid": "string", - "contentType": "string", - "createdBy": "string", - "fileSizeBytes": number, - "sha256Hash": "string", - "ulid": "string", - "fileStatus": enum, - "uploadId": "string", - "isFile": boolean, - "created": "string", - "updated": "string", - "details": "string", - "fileS3Key": "string", - "dataVaultUlid": "string", - "executionId": "string", - "associationCreatedby": "string", - "associationDate": "string", - "dataVaultUploadDate": "string", - "dataVaultName": "string", - "federationCredentials": "string", - "bucket": "string", - "region": "string", - "reason": "string" - } - -## Properties - -### CaseFile - -Property| Type| Required| Description ----|---|---|--- -`associationCreatedby`| string| False| -`associationDate`| string| False| -`caseUlid`| string| False| -`contentType`| string| False| -`created`| string| False| -`createdBy`| string| False| -`dataVaultName`| string| False| -`dataVaultUlid`| string| False| -`dataVaultUploadDate`| string| False| -`details`| string| False| -`executionId`| string| False| -`fileName`| string| False| -`filePath`| string| False| -`fileS3Key`| string| False| -`fileSizeBytes`| number| False| -`isFile`| boolean| False| -`reason`| string| False| -`sha256Hash`| string| False| -`status`| CaseFileStatus| False| -`ulid`| string| False| -`updated`| string| False| -`uploadId`| string| False| - -### CaseFileInitiateUpload - -Property| Type| Required| Description ----|---|---|--- -`caseUlid`| string| True| -`contentType`| string| True| -`details`| string| False| -`fileName`| string| True| -`filePath`| string| True| -`fileSizeBytes`| number| True| -`reason`| string| False| -`uploadId`| string| False| - -### CaseFileStatus - - * `ACTIVE` - - * `DELETING` - - * `DELETE_FAILED` - - * `DELETED` - - * `PENDING` - - - - -### CaseUploadResponse - -Property| Type| Required| Description ----|---|---|--- -`associationCreatedby`| string| False| -`associationDate`| string| False| -`bucket`| string| False| -`caseUlid`| string| False| -`contentType`| string| False| -`created`| string| False| -`createdBy`| string| False| -`dataVaultName`| string| False| -`dataVaultUlid`| string| False| -`dataVaultUploadDate`| string| False| -`details`| string| False| -`executionId`| string| False| -`federationCredentials`| string| False| -`fileName`| string| False| -`filePath`| string| False| -`fileS3Key`| string| False| -`fileSizeBytes`| number| False| -`fileStatus`| CaseFileStatus| False| -`isFile`| boolean| False| -`reason`| string| False| -`region`| string| False| -`sha256Hash`| string| False| -`ulid`| string| False| -`updated`| string| False| -`uploadId`| string| False| -