[MNT-24127] Added Endpoint To Calculate Folder Size #213
Conversation
|
It's recommended to add Jira ticket number in square bracket in title at start. This will link the PR to the corresponding Jira ticket. Also It's a good practise to add jira ttcket link in the description. |
mohit-singh4
changed the title
| @@ -2484,6 +2491,92 @@ paths: | |||
| description: Unexpected error | |||
| schema: | |||
| $ref: '#/definitions/Error' | |||
| '/nodes/{nodeId}/calculateSize': | |||
| post: | |||
| x-alfresco-since: "5.2" | |||
There was a problem hiding this comment.
Are we supporting this API from ACS 5.2 ?
There was a problem hiding this comment.
No, I have removed the same.
| schema: | ||
| $ref: '#/definitions/Error' | ||
| get: | ||
| x-alfresco-since: "5.2" |
There was a problem hiding this comment.
Same as above. Are we supporting this API from ACS 5.2 ?
There was a problem hiding this comment.
No, I have removed the same.
| post: | ||
| tags: | ||
| - nodes | ||
| summary: Calculate a folder size |
There was a problem hiding this comment.
Are we supporting the API to calculate the size of a file. If yes, then we shd mention in the description.
There was a problem hiding this comment.
We are only calculating the size of a folder not file.
| default: | ||
| description: Unexpected error | ||
| schema: | ||
| $ref: '#/definitions/Error' |
There was a problem hiding this comment.
What error code are we returning in case its a valid node id but this is a retention-schedule node id i.e. invalid node type
There was a problem hiding this comment.
We are returning 404- nodeId does not exist, as we are only considering folder type node.
There was a problem hiding this comment.
But here node id exist in the system but it has different node type. I think we should have a different message and may be status code as well. Please check other endpoints.
There was a problem hiding this comment.
Updated with 400 status code. with description
There was a problem hiding this comment.
Plz once validate the message with other endpoints in the swagger so that we are having similar standards. Rest looks good to me.
| calculatedAtTime: | ||
| type: string | ||
| status: | ||
| type: string |
There was a problem hiding this comment.
It's a good practice to add description for all the fields.
| type: object | ||
| properties: | ||
| executionId: | ||
| type: string |
There was a problem hiding this comment.
Same as above. Add the desctiption for the field.
| type: string | ||
| description: Provides the time when the calculating folder size will be completed. | ||
| status: | ||
| type: string |
There was a problem hiding this comment.
I think we should have "number of files" field in the response. This was earlier part of RFC confluence page as well and is in sync with the requirement from Product Manager.
There was a problem hiding this comment.
Added the same.
Done
This reverts commit d0c1ddb.
https://hyland.atlassian.net/browse/MNT-24127