Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat:savepoint #191

Open
wants to merge 6 commits into
base: release-6.0.0
Choose a base branch
from
Open

feat:savepoint #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4f5e856
feat:savepoint
borkarsaish65 Aug 1, 2024
914924c
feat:take array from req.query
borkarsaish65 Aug 2, 2024
813513c
feat:clarity on comments
borkarsaish65 Aug 2, 2024
3f52050
feat:added documentation for the api
borkarsaish65 Aug 2, 2024
a233f76
feat:documentation added + req.query modified to take single instring…
borkarsaish65 Aug 2, 2024
e49fa33
feat:documentation added + req.query modified to take single instring…
borkarsaish65 Aug 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 29 additions & 10 deletions controllers/v1/cloud-services/files.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,27 +116,39 @@ module.exports = class Files {
});
}

/**
/**
* @api {post} /kendra/api/v1/cloud-services/files/getDownloadableUrl
* Get downloadable URL.
* @apiVersion 1.0.0
* @apiGroup Gcp
* @apiHeader {String} X-authenticated-user-token Authenticity token
* @apiParamExample {json} Request:
* @apiParam {String[]} [filePaths] An array of file paths, can be sent via query parameters or request body.
* @apiParamExample {json} Request (Body):
* {
* "filePaths": []
* "filePaths": ["survey/5f72f9998925ec7c60f79a91//e7455f6c-468d-4fdf-9f6c-546d6b7d1370/uploadFile.jpg","survey/5f72f9998925ec7c60f79a91//e7455f6c-468d-4fdf-9f6c-546d6b7d1370/uploadFile2.jpg"]
* }
* @apiParamExample {json} Request (Query):
* /kendra/api/v1/cloud-services/files/getDownloadableUrl?filePaths=survey/5f72f9998925ec7c60f79a91//e7455f6c-468d-4fdf-9f6c-546d6b7d1370/uploadFile.jpg,survey/5f72f9998925ec7c60f79a91//e7455f6c-468d-4fdf-9f6c-546d6b7d1370/uploadFile2.jpg
* @apiSampleRequest /kendra/api/v1/cloud-services/files/getDownloadableUrl
* @apiUse successBody
* @apiUse errorBody
* @apiParamExample {json} Response:
* {
* "status": 200,
* "message": "Url's generated successfully",
* "result": [{
* "filePath": "5e1c28a050452374e1cf9841/e97b5582-471c-4649-8401-3cc4249359bb/cdv_photo_117.jpg",
* "url": "https://storage.googleapis.com/download/storage/v1/b/sl-dev-storage/o/5e1c28a050452374e1cf9841%2Fe97b5582-471c-4649-8401-3cc4249359bb%2Fcdv_photo_117.jpg?generation=1579240054787924&alt=media"
* }]
* "message": "Url's generated successfully",
* "status": 200,
* "result": [
* {
* "cloudStorage": "oci",
* "filePath": "survey/5f72f9998925ec7c60f79a91//e7455f6c-468d-4fdf-9f6c-546d6b7d1370/uploadFile.jpg",
* "url": "https://ax2cel5zyviy.compat.objectstorage.ap-hyderabad-1.oraclecloud.com/samiksha/survey/5f72f9998925ec7c60f79a91//e7455f6c-468d-4fdf-9f6c-546d6b7d1370/uploadFile.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=3737771d26e1d8f211a04ec59cfd3037c8d1c6ff%2F20240802%2Fap-hyderabad-1%2Fs3%2Faws4_request&X-Amz-Date=20240802T051354Z&X-Amz-Expires=1800&X-Amz-Signature=4ed5c7327315bb8cba99f4c99a71178fffdbc62156e0f1b2ba471a17533eb4dc&X-Amz-SignedHeaders=host&x-id=GetObject"
* },
* {
* "cloudStorage": "oci",
* "filePath": "survey/5f72f9998925ec7c60f79a91//e7455f6c-468d-4fdf-9f6c-546d6b7d1370/uploadFile2.jpg",
* "url": "https://ax2cel5zyviy.compat.objectstorage.ap-hyderabad-1.oraclecloud.com/samiksha/survey/5f72f9998925ec7c60f79a91//e7455f6c-468d-4fdf-9f6c-546d6b7d1370/uploadFile2.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=3737771d26e1d8f211a04ec59cfd3037c8d1c6ff%2F20240802%2Fap-hyderabad-1%2Fs3%2Faws4_request&X-Amz-Date=20240802T051354Z&X-Amz-Expires=1800&X-Amz-Signature=6c86d4465d9150af2b7bccd0ce81624367447f67b6a5c9b88c40cfff7b5047f9&X-Amz-SignedHeaders=host&x-id=GetObject"
* }
* ]
* }
*/

/**
Expand All @@ -152,9 +164,16 @@ module.exports = class Files {

try {

//allows file array to be taken from req.query as well as req.body
if(req.query.filePaths){
req.query.filePaths = req.query.filePaths.split(',').map(filePath => filePath.trim()).filter(filePath => filePath.length > 0);
}

let filePaths = req.query.filePaths || req.body.filePaths;

let downloadableUrl =
await filesHelpers.getDownloadableUrl(
req.body.filePaths
filePaths
);

return resolve(downloadableUrl)
Expand Down
4 changes: 2 additions & 2 deletions module/files/helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ module.exports = class FilesHelper {
responseObj.filePath = element;
// Get the downloadable URL from the cloud client SDK.
// {sample response} : https://sunbirdstagingpublic.blob.core.windows.net/sample-name/reports/uploadFile2.jpg?st=2023-08-05T07%3A11%3A25Z&se=2024-02-03T14%3A11%3A25Z&sp=r&sv=2018-03-28&sr=b&sig=k66FWCIJ9NjoZfShccLmml3vOq9Lt%2FDirSrSN55UclU%3D
responseObj.url = await cloudClient.getDownloadableUrl(
responseObj.url = await cloudClient.getSignedUrl(
bucketName,
element,
linkExpireTime, // Link ExpireIn
Expand All @@ -80,7 +80,7 @@ module.exports = class FilesHelper {
let result;
// Get the downloadable URL from the cloud client SDK.

result = await cloudClient.getDownloadableUrl(
result = await cloudClient.getSignedUrl(
bucketName, // bucket name
filePath, // resource file path
linkExpireTime, // Link Expire time
Expand Down