Skip to content

Commit

Permalink
[feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Added swagg…
Browse files Browse the repository at this point in the history
…er endpoints to calculate folder size
  • Loading branch information
mohit-singh4 committed Aug 7, 2024
1 parent 2ded532 commit f241a31
Showing 1 changed file with 4 additions and 21 deletions.
25 changes: 4 additions & 21 deletions src/main/webapp/definitions/alfresco-core.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -129,16 +129,6 @@ parameters:
description: The identifier of a folder node.
required: true
type: string
maxItemsForSizeParam:
name: maxItems
in: query
description: |
```MaxItems``` ***parameter*** to partition a huge folder into smaller chunks so that we can compute more efficiently and consolidate all sizes into a single unit.
required: false
type: integer
minimum: 1
maximum: 1000
default: 100
nodeMinimalEntryIncludeParam:
name: include
in: query
Expand Down Expand Up @@ -2220,16 +2210,13 @@ paths:
the request has been accepted successfully.
The response body will include the ```nodeId``` of the pending action, which can be used in a
**GET/get-folder-size** endpoint to check if the action's status has been completed, at which point the result will be returned, comprising ```the size of the node in bytes```.
Here, We are taking ```maxItems``` ***parameter*** to partition a huge folder into smaller chunks so that we can compute more efficiently and consolidate all sizes into a single unit.
**GET/size** endpoint to check if the action's status has been completed, at which point the result will be returned, comprising ```the size of the node in bytes```.
operationId: calculateSize
produces:
- application/json
parameters:
- $ref: '#/parameters/nodeTargetIdParam'
- $ref: '#/parameters/maxItemsForSizeParam'
responses:
'202':
description: Request Accepted
Expand All @@ -2239,16 +2226,14 @@ paths:
description: Authentication failed
'403':
description: Current user does not have permission for **nodeId**
'404':
description: Entity with **nodeId** does not exist
'422':
description: |
Invalid parameter: value of **nodeId** is invalid
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
'/nodes/{nodeId}/get-folder-size':
'/nodes/{nodeId}/size':
get:
tags:
- nodes
Expand Down Expand Up @@ -2279,8 +2264,6 @@ paths:
description: Authentication failed
'403':
description: Current user does not have permission for **nodeId**
'404':
description: Entity with **nodeId** does not exist
'422':
description: |
Invalid parameter: value of **nodeId** is invalid
Expand Down Expand Up @@ -10806,9 +10789,9 @@ definitions:
sizeAcknowledgedResponse:
type: object
properties:
nodeId:
message:
type: string
description: Provides nodeId indicating that the request has been acknowledged.
description: Provides response indicating that the request has been acknowledged.
ProbeEntry:
type: object
required:
Expand Down

0 comments on commit f241a31

Please sign in to comment.