AWS solutions documentation change
Summary
Updated documentation for data vault files endpoint with expanded schema details, added query parameters (filePath, limit, next), and response structure including SHA256 hash field
Security assessment
Added 'sha256Hash' property in response schema provides documentation about file integrity verification capabilities, which is a security feature. However, there's no indication this addresses an active security vulnerability.
Diff
diff --git a/solutions/latest/dea-api/datavaults-datavaultid-files.md b/solutions/latest/dea-api/datavaults-datavaultid-files.md index 07dc3a3cc..6abe4001e 100644 --- a//solutions/latest/dea-api/datavaults-datavaultid-files.md +++ b//solutions/latest/dea-api/datavaults-datavaultid-files.md @@ -5 +5 @@ -URIHTTP methods +URIHTTP methodsSchemasProperties @@ -7 +7,3 @@ URIHTTP methods -# Datavaults dataVaultId Files +# Data vaults – Files + +This endpoint provides a way to retrieve information about the files or evidence associated with a specific data vault in Digital Evidence Archive, allowing users to access and manage the evidence related to the data vault. @@ -23,3 +25 @@ Path parametersName| Type| Required| Description -### OPTIONS - -Path parametersName| Type| Required| Description +Query parametersName| Type| Required| Description @@ -27 +27,3 @@ Path parametersName| Type| Required| Description -`dataVaultId`| String| True| Data vault ID to generate audit log for +`filePath`| String| False| +`limit`| Integer| False| +`next`| String| False| @@ -31 +33,74 @@ ResponsesStatus code| Response model| Description -`204`| None| 204 response +`200`| `DataVaults_response_200_1`| Success + +## Schemas + +### Response bodies + + + { + "dataVaultFiles": [ + [ + { + "fileName": "string", + "filePath": "string", + "dataVaultUlid": "string", + "fileSizeBytes": number, + "sha256Hash": "string", + "ulid": "string", + "versionId": "string", + "fileS3Key": "string", + "uploadId": "string", + "isFile": boolean, + "contentType": "string", + "executionId": "string", + "created": "string", + "updated": "string", + "caseCount": number, + "cases": [ + { + "ulid": "string", + "name": "string" + } + ] + } + ] + ], + "next": "string" + } + +## Properties + +### DataVaultFile + +Property| Type| Required| Description +---|---|---|--- +`caseCount`| number| False| +`cases`| Array of type ScopedCase| False| +`contentType`| string| False| +`created`| string| False| +`dataVaultUlid`| string| False| +`executionId`| string| False| +`fileName`| string| False| +`filePath`| string| False| +`fileS3Key`| string| False| +`fileSizeBytes`| number| False| +`isFile`| boolean| False| +`sha256Hash`| string| False| +`ulid`| string| False| +`updated`| string| False| +`uploadId`| string| False| +`versionId`| string| False| + +### DataVaults_response_200_1 + +Property| Type| Required| Description +---|---|---|--- +`dataVaultFiles`| Array of type Array of type DataVaultFile| False| +`next`| string| False| + +### ScopedCase + +Property| Type| Required| Description +---|---|---|--- +`name`| string| False| +`ulid`| string| False| @@ -39 +114 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Datavaults dataVaultId Details +Data vaults – File info @@ -41 +116 @@ Datavaults dataVaultId Details -Datavaults dataVaultId Files fileId Audit +Data vaults – Task execution