From d9122649c0766f51e8ed31938dc91fb79ea1b8fd Mon Sep 17 00:00:00 2001 From: Mohit Singh Date: Wed, 17 Apr 2024 09:59:15 +0530 Subject: [PATCH 01/29] [MNT-24127] Added Endpoint to calculate Size --- .../webapp/definitions/alfresco-core.yaml | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 625717be..1b9d5c27 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2484,6 +2484,35 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' + '/nodes/{nodeId}/calculateSize': + get: + tags: + - nodes + summary: Get folder size + description: | + Get the size of a folder + operationId: getFolderSize + produces: + - application/json + parameters: + - $ref: '#/parameters/nodeTargetIdParam' + responses: + '202': + description: Request Accepted + '200': + description: Successful response + schema: + $ref: '#/definitions/calculateSizeResponse' + '401': + description: Authentication failed + '403': + description: Current user does not have permission for **nodeId** + '404': + description: Entity with **nodeId** does not exist + default: + description: Unexpected error + schema: + $ref: '#/definitions/Error' '/nodes/{nodeId}/secondary-children': post: @@ -10690,6 +10719,13 @@ definitions: $ref: '#/definitions/PermissionsInfo' definition: $ref: '#/definitions/Definition' + calculateSizeResponse: + type: object + properties: + id: + type: string + size: + type: string ProbeEntry: type: object required: From 0d66cc5d24b7eb28615fc3bae8fe8c74d7b6bcb3 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Tue, 18 Jun 2024 18:13:45 +0530 Subject: [PATCH 02/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- .../webapp/definitions/alfresco-core.yaml | 95 ++++++++++++++++--- 1 file changed, 84 insertions(+), 11 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 1b9d5c27..bf9cd5dc 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -123,12 +123,19 @@ parameters: description: The identifier of a target node. required: true type: string - nodeFolderIdParam: - name: nodeId - in: path - description: The identifier of a folder node. - required: true - type: string + maxItemsForSizeParam: + name: maxItems + in: query + description: | + This assists in handling scenarios where ***large files*** or ***subfolders*** exist within a folder, + allowing the folder size determination mechanism to function in chunks. + + So that calculating the huge folder will be done efficiently. + If not supplied then the default value is 100. + required: false + type: integer + minimum: 1 + default: 100 nodeMinimalEntryIncludeParam: name: include in: query @@ -2485,22 +2492,79 @@ paths: schema: $ref: '#/definitions/Error' '/nodes/{nodeId}/calculateSize': - get: + post: + x-alfresco-since: "5.2" tags: - nodes - summary: Get folder size + summary: Calculate a folder size description: | - Get the size of a folder - operationId: getFolderSize + + This may be executed against a node specified by **nodeId** and this nodeId must be a valid node ID. + Furthermore, this POST endpoint will be executed **asynchronously** with a `202` HTTP response signifying that + the request has been accepted successfully. + + The response body will include the ```nodeId``` of the pending action, which can be used in a + **GET/calculateSize** 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```. + + Essentially, ```maxItems``` ***parameter*** is utilized for pagination purposes. + + By default, **results are limited to the first 100.** + Results can be restricted using "paging". For example: + + ```JSON + "paging": { + "maxItems": "50", + "skipCount": "28" + } + ``` + This assists in handling scenarios where large files or subfolders exist within a folder, allowing the folder size determination mechanism to function in chunks. + + operationId: calculateSize produces: - application/json parameters: - $ref: '#/parameters/nodeTargetIdParam' + - $ref: '#/parameters/maxItemsForSizeParam' responses: '202': description: Request Accepted + schema: + $ref: '#/definitions/sizeAcknowledgedResponse' + '401': + description: Authentication failed + '403': + description: Current user does not have permission for **nodeId** + '404': + description: Entity with **nodeId** does not exist + default: + description: Unexpected error + schema: + $ref: '#/definitions/Error' + get: + x-alfresco-since: "5.2" + tags: + - nodes + summary: Get the size of folder after initiating POST/calculate Endpoint. + description: | + ***Receiving the size*** + + This endpoint takes ```nodeId``` as a path parameter and returns the result after executing above POST request. + + Below are the three stages, which reflect the status for the present execution ***nodeId***. + + ``` + NOT INITIATED: Not Iniated yet. + IN-PROGRESS: Calculating execution is in progress. + COMPLETED: Calculation has been done. + ``` + operationId: getSize + produces: + - application/json + parameters: + - $ref: '#/parameters/nodeTargetIdParam' + responses: '200': - description: Successful response + description: Successful Response schema: $ref: '#/definitions/calculateSizeResponse' '401': @@ -10726,6 +10790,15 @@ definitions: type: string size: type: string + calculatedAtTime: + type: string + status: + type: string + sizeAcknowledgedResponse: + type: object + properties: + executionId: + type: string ProbeEntry: type: object required: From d6815e14c026819e7b110da6f42b4dca27825e1b Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Wed, 19 Jun 2024 15:08:15 +0530 Subject: [PATCH 03/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- .../webapp/definitions/alfresco-core.yaml | 377 +++++++++--------- 1 file changed, 187 insertions(+), 190 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index bf9cd5dc..af6b25f2 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -455,14 +455,14 @@ parameters: name: attachment in: query description: | - **true** enables a web browser to download the file as an attachment. - **false** means a web browser may preview the file in a new tab or window. - - You can only set this parameter to **false** if the content type of the file is in the supported list; - for example, certain image files and PDF files. - - If the content type is not supported for preview, then a value of **false** is ignored, and - the attachment will be returned in the response. + **true** enables a web browser to download the file as an attachment. + **false** means a web browser may preview the file in a new tab or window. + + You can only set this parameter to **false** if the content type of the file is in the supported list; + for example, certain image files and PDF files. + + If the content type is not supported for preview, then a value of **false** is ignored, and + the attachment will be returned in the response. required: false default: true type: boolean @@ -1338,21 +1338,21 @@ paths: - nodes summary: Delete a node description: | - **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - - Deletes the node **nodeId**. - - If **nodeId** is a folder, then its children are also deleted. - - Deleted nodes move to the trashcan unless the **permanent** query parameter is **true** and the current user is the owner of the node or an admin. - - Deleting a node deletes it from its primary parent and also from any secondary parents. Peer associations are also deleted, where the deleted - node is either a source or target of an association. This applies recursively to any hierarchy of primary children of the deleted node. - - **Note:** If the node is not permanently deleted, and is later successfully restored to its former primary parent, then the primary - child association is restored. This applies recursively for any primary children. No other secondary child associations or - peer associations are restored for any of the nodes in the primary parent-child hierarchy of restored nodes, regardless of whether the original - associations were to nodes inside or outside the restored hierarchy. + **Note:** this endpoint is available in Alfresco 5.2 and newer versions. + + Deletes the node **nodeId**. + + If **nodeId** is a folder, then its children are also deleted. + + Deleted nodes move to the trashcan unless the **permanent** query parameter is **true** and the current user is the owner of the node or an admin. + + Deleting a node deletes it from its primary parent and also from any secondary parents. Peer associations are also deleted, where the deleted + node is either a source or target of an association. This applies recursively to any hierarchy of primary children of the deleted node. + + **Note:** If the node is not permanently deleted, and is later successfully restored to its former primary parent, then the primary + child association is restored. This applies recursively for any primary children. No other secondary child associations or + peer associations are restored for any of the nodes in the primary parent-child hierarchy of restored nodes, regardless of whether the original + associations were to nodes inside or outside the restored hierarchy. operationId: deleteNode parameters: - $ref: '#/parameters/nodeIdParam' @@ -2493,7 +2493,6 @@ paths: $ref: '#/definitions/Error' '/nodes/{nodeId}/calculateSize': post: - x-alfresco-since: "5.2" tags: - nodes summary: Calculate a folder size @@ -2541,7 +2540,6 @@ paths: schema: $ref: '#/definitions/Error' get: - x-alfresco-since: "5.2" tags: - nodes summary: Get the size of folder after initiating POST/calculate Endpoint. @@ -2577,7 +2575,6 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' - '/nodes/{nodeId}/secondary-children': post: x-alfresco-since: "5.2" @@ -4527,7 +4524,7 @@ paths: **nodeId** does not exist '412': description: | - Content is archived and is inaccessible + Content is archived and is inaccessible '501': description: The actual ContentStore implementation can't fulfil this request default: @@ -5807,45 +5804,45 @@ paths: - groups summary: List group memberships description: | - **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. - - Gets a list of group membership information for person **personId**. - - You can use the `-me-` string in place of `` to specify the currently authenticated user. - - You can use the **include** parameter to return additional information. - - You can use the **where** parameter to filter the returned groups by **isRoot**. For example, the following **where** - clause will return just the root groups: - - ``` - (isRoot=true) - ``` - - The **where** parameter can also be used to filter by ***zone***. This may be combined with isRoot to narrow - a result set even further. For example, the following where clause will only return groups belonging to the - `MY.ZONE` zone. - - ``` - where=(zones in ('MY.ZONE')) - ``` - - This may be combined with the isRoot filter, as shown below: - - ``` - where=(isRoot=false AND zones in ('MY.ZONE')) - ``` - - ***Note:*** restrictions include - * `AND` is the only supported operator when combining `isRoot` and `zones` filters - * Only one zone is supported by the filter - * The quoted zone name must be placed in parenthesis — a 400 error will result if these are omitted. - - - The default sort order for the returned list is for groups to be sorted by ascending displayName. - You can override the default by using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: - * id - * displayName + **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. + + Gets a list of group membership information for person **personId**. + + You can use the `-me-` string in place of `` to specify the currently authenticated user. + + You can use the **include** parameter to return additional information. + + You can use the **where** parameter to filter the returned groups by **isRoot**. For example, the following **where** + clause will return just the root groups: + + ``` + (isRoot=true) + ``` + + The **where** parameter can also be used to filter by ***zone***. This may be combined with isRoot to narrow + a result set even further. For example, the following where clause will only return groups belonging to the + `MY.ZONE` zone. + + ``` + where=(zones in ('MY.ZONE')) + ``` + + This may be combined with the isRoot filter, as shown below: + + ``` + where=(isRoot=false AND zones in ('MY.ZONE')) + ``` + + ***Note:*** restrictions include + * `AND` is the only supported operator when combining `isRoot` and `zones` filters + * Only one zone is supported by the filter + * The quoted zone name must be placed in parenthesis — a 400 error will result if these are omitted. + + + The default sort order for the returned list is for groups to be sorted by ascending displayName. + You can override the default by using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: + * id + * displayName operationId: listGroupMembershipsForPerson produces: - application/json @@ -6452,45 +6449,45 @@ paths: schema: $ref: '#/definitions/Error' '/sites/{siteId}/site-membership-requests/{inviteeId}/approve': - post: - tags: - - sites - summary: Approve a site membership request - description: | - Approve a site membership request. - operationId: approveSiteMembershipRequest - produces: - - application/json - parameters: - - $ref: '#/parameters/siteIdParam' - - $ref: '#/parameters/inviteeIdParam' - - in: body - name: siteMembershipApprovalBody - description: | - Accepting a request to join, optionally, allows assignment of a role to the user. - required: false - schema: - $ref: '#/definitions/SiteMembershipApprovalBody' - responses: - '200': - description: Successful response - '400': - description: | - Invalid parameter: value of **siteId** or **inviteeId** is invalid - '401': - description: Authentication failed - '403': - description: Current user does not have permission to approve membership request - '404': - description: | - **siteId** or **inviteeId** does not exist - '422': - description: | - Integrity exception or not allowed to approve membership request. - default: - description: Unexpected error - schema: - $ref: '#/definitions/Error' + post: + tags: + - sites + summary: Approve a site membership request + description: | + Approve a site membership request. + operationId: approveSiteMembershipRequest + produces: + - application/json + parameters: + - $ref: '#/parameters/siteIdParam' + - $ref: '#/parameters/inviteeIdParam' + - in: body + name: siteMembershipApprovalBody + description: | + Accepting a request to join, optionally, allows assignment of a role to the user. + required: false + schema: + $ref: '#/definitions/SiteMembershipApprovalBody' + responses: + '200': + description: Successful response + '400': + description: | + Invalid parameter: value of **siteId** or **inviteeId** is invalid + '401': + description: Authentication failed + '403': + description: Current user does not have permission to approve membership request + '404': + description: | + **siteId** or **inviteeId** does not exist + '422': + description: | + Integrity exception or not allowed to approve membership request. + default: + description: Unexpected error + schema: + $ref: '#/definitions/Error' '/sites/{siteId}/site-membership-requests/{inviteeId}/reject': post: tags: @@ -6771,9 +6768,9 @@ paths: - sites summary: List group membership for site description: | - **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions. - - Gets a list of group membership for site **siteId**. + **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions. + + Gets a list of group membership for site **siteId**. operationId: listSiteGroups produces: - application/json @@ -8134,7 +8131,7 @@ paths: ``` where=(isRoot=false AND displayName in ('MY.GROUP.NAME')) ``` - + ``` where=(zones in ('MY.ZONE') AND displayName in ('MY.GROUP.NAME')) ``` @@ -8675,7 +8672,7 @@ paths: parameters: - $ref: '#/parameters/auditApplicationIdParam' - $ref: '#/parameters/skipCountParam' - - $ref: '#/parameters/omitTotalItemsParam' + - $ref: '#/parameters/omitTotalItemsParam' - $ref: '#/parameters/orderByParam' - $ref: '#/parameters/maxItemsParam' - name: where @@ -8953,44 +8950,44 @@ paths: schema: $ref: '#/definitions/Error' '/action-definitions': - get: - x-alfresco-since: "5.2.2" - tags: - - actions - summary: Retrieve list of available actions - description: | - **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. - - Gets a list of all available actions - - The default sort order for the returned list is for actions to be sorted by ascending name. - You can override the default by using the **orderBy** parameter. - - You can use any of the following fields to order the results: - * name - * title - operationId: listActions - produces: - - application/json - parameters: - - $ref: '#/parameters/skipCountParam' - - $ref: '#/parameters/maxItemsParam' - - $ref: '#/parameters/orderByParam' - - $ref: '#/parameters/fieldsParam' - responses: - '200': - description: Successful response - schema: - $ref: '#/definitions/ActionDefinitionList' - '400': - description: | - Invalid parameter: value of **maxItems**, **skipCount** or **orderBy** is invalid - '401': - description: Authentication failed - default: - description: Unexpected error - schema: - $ref: '#/definitions/Error' + get: + x-alfresco-since: "5.2.2" + tags: + - actions + summary: Retrieve list of available actions + description: | + **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. + + Gets a list of all available actions + + The default sort order for the returned list is for actions to be sorted by ascending name. + You can override the default by using the **orderBy** parameter. + + You can use any of the following fields to order the results: + * name + * title + operationId: listActions + produces: + - application/json + parameters: + - $ref: '#/parameters/skipCountParam' + - $ref: '#/parameters/maxItemsParam' + - $ref: '#/parameters/orderByParam' + - $ref: '#/parameters/fieldsParam' + responses: + '200': + description: Successful response + schema: + $ref: '#/definitions/ActionDefinitionList' + '400': + description: | + Invalid parameter: value of **maxItems**, **skipCount** or **orderBy** is invalid + '401': + description: Authentication failed + default: + description: Unexpected error + schema: + $ref: '#/definitions/Error' '/action-definitions/{actionDefinitionId}': get: x-alfresco-since: "5.2.2" @@ -9265,7 +9262,7 @@ definitions: SiteContainerPaging: type: object required: - - list + - list properties: list: type: object @@ -9305,10 +9302,10 @@ definitions: role: type: string enum: - - SiteConsumer - - SiteCollaborator - - SiteContributor - - SiteManager + - SiteConsumer + - SiteCollaborator + - SiteContributor + - SiteManager id: type: string SiteMembershipBodyUpdate: @@ -9319,10 +9316,10 @@ definitions: role: type: string enum: - - SiteConsumer - - SiteCollaborator - - SiteContributor - - SiteManager + - SiteConsumer + - SiteCollaborator + - SiteContributor + - SiteManager SiteMemberPaging: type: object required: @@ -9776,8 +9773,8 @@ definitions: list: type: object required: - - pagination - - entries + - pagination + - entries properties: pagination: $ref: '#/definitions/Pagination' @@ -10092,8 +10089,8 @@ definitions: required: - target properties: - target: - type: object + target: + type: object FavoritePaging: type: object required: @@ -10412,8 +10409,8 @@ definitions: AssociationBody: type: object required: - - targetId - - assocType + - targetId + - assocType properties: targetId: type: string @@ -10432,8 +10429,8 @@ definitions: ChildAssociationBody: type: object required: - - childId - - assocType + - childId + - assocType properties: childId: type: string @@ -10474,8 +10471,8 @@ definitions: type: string default: ALLOWED enum: - - ALLOWED - - DENIED + - ALLOWED + - DENIED PermissionsInfo: type: object properties: @@ -10598,14 +10595,14 @@ definitions: type: string default: ALLOW_OWNER_CHANGES enum: - - ALLOW_OWNER_CHANGES - - FULL + - ALLOW_OWNER_CHANGES + - FULL lifetime: type: string default: PERSISTENT enum: - - PERSISTENT - - EPHEMERAL + - PERSISTENT + - EPHEMERAL NodePaging: type: object properties: @@ -10720,15 +10717,15 @@ definitions: Node: type: object required: - - id - - name - - nodeType - - isFolder - - isFile - - createdAt - - createdByUser - - modifiedAt - - modifiedByUser + - id + - name + - nodeType + - isFolder + - isFile + - createdAt + - createdByUser + - modifiedAt + - modifiedByUser properties: id: type: string @@ -11222,8 +11219,8 @@ definitions: createdByUser: $ref: '#/definitions/UserInfo' createdAt: - type: string - format: date-time + type: string + format: date-time values: type: object ActionConstraint: @@ -11319,12 +11316,12 @@ definitions: items: $ref: '#/definitions/ActionDefinition' ActionDefinitionEntry: - type: object - required: - - entry - properties: - entry: - $ref: '#/definitions/ActionDefinition' + type: object + required: + - entry + properties: + entry: + $ref: '#/definitions/ActionDefinition' ActionDefinition: type: object required: @@ -11517,8 +11514,8 @@ definitions: description: How to combine the clauses of this condition ("and" or "or") type: string enum: - - and - - or + - and + - or default: "and" compositeConditions: description: Nested list of composite clauses in this condition From 41c996a56504b657d20da1481dfe5ef6b9877fc9 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Wed, 19 Jun 2024 15:52:17 +0530 Subject: [PATCH 04/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- .../webapp/definitions/alfresco-core.yaml | 370 +++++++++--------- 1 file changed, 185 insertions(+), 185 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index af6b25f2..11de5b67 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -455,14 +455,14 @@ parameters: name: attachment in: query description: | - **true** enables a web browser to download the file as an attachment. - **false** means a web browser may preview the file in a new tab or window. - - You can only set this parameter to **false** if the content type of the file is in the supported list; - for example, certain image files and PDF files. - - If the content type is not supported for preview, then a value of **false** is ignored, and - the attachment will be returned in the response. + **true** enables a web browser to download the file as an attachment. + **false** means a web browser may preview the file in a new tab or window. + + You can only set this parameter to **false** if the content type of the file is in the supported list; + for example, certain image files and PDF files. + + If the content type is not supported for preview, then a value of **false** is ignored, and + the attachment will be returned in the response. required: false default: true type: boolean @@ -1338,21 +1338,21 @@ paths: - nodes summary: Delete a node description: | - **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - - Deletes the node **nodeId**. - - If **nodeId** is a folder, then its children are also deleted. - - Deleted nodes move to the trashcan unless the **permanent** query parameter is **true** and the current user is the owner of the node or an admin. - - Deleting a node deletes it from its primary parent and also from any secondary parents. Peer associations are also deleted, where the deleted - node is either a source or target of an association. This applies recursively to any hierarchy of primary children of the deleted node. - - **Note:** If the node is not permanently deleted, and is later successfully restored to its former primary parent, then the primary - child association is restored. This applies recursively for any primary children. No other secondary child associations or - peer associations are restored for any of the nodes in the primary parent-child hierarchy of restored nodes, regardless of whether the original - associations were to nodes inside or outside the restored hierarchy. + **Note:** this endpoint is available in Alfresco 5.2 and newer versions. + + Deletes the node **nodeId**. + + If **nodeId** is a folder, then its children are also deleted. + + Deleted nodes move to the trashcan unless the **permanent** query parameter is **true** and the current user is the owner of the node or an admin. + + Deleting a node deletes it from its primary parent and also from any secondary parents. Peer associations are also deleted, where the deleted + node is either a source or target of an association. This applies recursively to any hierarchy of primary children of the deleted node. + + **Note:** If the node is not permanently deleted, and is later successfully restored to its former primary parent, then the primary + child association is restored. This applies recursively for any primary children. No other secondary child associations or + peer associations are restored for any of the nodes in the primary parent-child hierarchy of restored nodes, regardless of whether the original + associations were to nodes inside or outside the restored hierarchy. operationId: deleteNode parameters: - $ref: '#/parameters/nodeIdParam' @@ -5804,45 +5804,45 @@ paths: - groups summary: List group memberships description: | - **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. - - Gets a list of group membership information for person **personId**. - - You can use the `-me-` string in place of `` to specify the currently authenticated user. - - You can use the **include** parameter to return additional information. - - You can use the **where** parameter to filter the returned groups by **isRoot**. For example, the following **where** - clause will return just the root groups: - - ``` - (isRoot=true) - ``` - - The **where** parameter can also be used to filter by ***zone***. This may be combined with isRoot to narrow - a result set even further. For example, the following where clause will only return groups belonging to the - `MY.ZONE` zone. - - ``` - where=(zones in ('MY.ZONE')) - ``` - - This may be combined with the isRoot filter, as shown below: - - ``` - where=(isRoot=false AND zones in ('MY.ZONE')) - ``` - - ***Note:*** restrictions include - * `AND` is the only supported operator when combining `isRoot` and `zones` filters - * Only one zone is supported by the filter - * The quoted zone name must be placed in parenthesis — a 400 error will result if these are omitted. - - - The default sort order for the returned list is for groups to be sorted by ascending displayName. - You can override the default by using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: - * id - * displayName + **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. + + Gets a list of group membership information for person **personId**. + + You can use the `-me-` string in place of `` to specify the currently authenticated user. + + You can use the **include** parameter to return additional information. + + You can use the **where** parameter to filter the returned groups by **isRoot**. For example, the following **where** + clause will return just the root groups: + + ``` + (isRoot=true) + ``` + + The **where** parameter can also be used to filter by ***zone***. This may be combined with isRoot to narrow + a result set even further. For example, the following where clause will only return groups belonging to the + `MY.ZONE` zone. + + ``` + where=(zones in ('MY.ZONE')) + ``` + + This may be combined with the isRoot filter, as shown below: + + ``` + where=(isRoot=false AND zones in ('MY.ZONE')) + ``` + + ***Note:*** restrictions include + * `AND` is the only supported operator when combining `isRoot` and `zones` filters + * Only one zone is supported by the filter + * The quoted zone name must be placed in parenthesis — a 400 error will result if these are omitted. + + + The default sort order for the returned list is for groups to be sorted by ascending displayName. + You can override the default by using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: + * id + * displayName operationId: listGroupMembershipsForPerson produces: - application/json @@ -6449,45 +6449,45 @@ paths: schema: $ref: '#/definitions/Error' '/sites/{siteId}/site-membership-requests/{inviteeId}/approve': - post: - tags: - - sites - summary: Approve a site membership request - description: | - Approve a site membership request. - operationId: approveSiteMembershipRequest - produces: - - application/json - parameters: - - $ref: '#/parameters/siteIdParam' - - $ref: '#/parameters/inviteeIdParam' - - in: body - name: siteMembershipApprovalBody - description: | - Accepting a request to join, optionally, allows assignment of a role to the user. - required: false - schema: - $ref: '#/definitions/SiteMembershipApprovalBody' - responses: - '200': - description: Successful response - '400': - description: | - Invalid parameter: value of **siteId** or **inviteeId** is invalid - '401': - description: Authentication failed - '403': - description: Current user does not have permission to approve membership request - '404': - description: | - **siteId** or **inviteeId** does not exist - '422': - description: | - Integrity exception or not allowed to approve membership request. - default: - description: Unexpected error - schema: - $ref: '#/definitions/Error' + post: + tags: + - sites + summary: Approve a site membership request + description: | + Approve a site membership request. + operationId: approveSiteMembershipRequest + produces: + - application/json + parameters: + - $ref: '#/parameters/siteIdParam' + - $ref: '#/parameters/inviteeIdParam' + - in: body + name: siteMembershipApprovalBody + description: | + Accepting a request to join, optionally, allows assignment of a role to the user. + required: false + schema: + $ref: '#/definitions/SiteMembershipApprovalBody' + responses: + '200': + description: Successful response + '400': + description: | + Invalid parameter: value of **siteId** or **inviteeId** is invalid + '401': + description: Authentication failed + '403': + description: Current user does not have permission to approve membership request + '404': + description: | + **siteId** or **inviteeId** does not exist + '422': + description: | + Integrity exception or not allowed to approve membership request. + default: + description: Unexpected error + schema: + $ref: '#/definitions/Error' '/sites/{siteId}/site-membership-requests/{inviteeId}/reject': post: tags: @@ -6768,9 +6768,9 @@ paths: - sites summary: List group membership for site description: | - **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions. - - Gets a list of group membership for site **siteId**. + **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions. + + Gets a list of group membership for site **siteId**. operationId: listSiteGroups produces: - application/json @@ -8131,7 +8131,7 @@ paths: ``` where=(isRoot=false AND displayName in ('MY.GROUP.NAME')) ``` - + ``` where=(zones in ('MY.ZONE') AND displayName in ('MY.GROUP.NAME')) ``` @@ -8950,44 +8950,44 @@ paths: schema: $ref: '#/definitions/Error' '/action-definitions': - get: - x-alfresco-since: "5.2.2" - tags: - - actions - summary: Retrieve list of available actions - description: | - **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. - - Gets a list of all available actions - - The default sort order for the returned list is for actions to be sorted by ascending name. - You can override the default by using the **orderBy** parameter. - - You can use any of the following fields to order the results: - * name - * title - operationId: listActions - produces: - - application/json - parameters: - - $ref: '#/parameters/skipCountParam' - - $ref: '#/parameters/maxItemsParam' - - $ref: '#/parameters/orderByParam' - - $ref: '#/parameters/fieldsParam' - responses: - '200': - description: Successful response - schema: - $ref: '#/definitions/ActionDefinitionList' - '400': - description: | - Invalid parameter: value of **maxItems**, **skipCount** or **orderBy** is invalid - '401': - description: Authentication failed - default: - description: Unexpected error - schema: - $ref: '#/definitions/Error' + get: + x-alfresco-since: "5.2.2" + tags: + - actions + summary: Retrieve list of available actions + description: | + **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. + + Gets a list of all available actions + + The default sort order for the returned list is for actions to be sorted by ascending name. + You can override the default by using the **orderBy** parameter. + + You can use any of the following fields to order the results: + * name + * title + operationId: listActions + produces: + - application/json + parameters: + - $ref: '#/parameters/skipCountParam' + - $ref: '#/parameters/maxItemsParam' + - $ref: '#/parameters/orderByParam' + - $ref: '#/parameters/fieldsParam' + responses: + '200': + description: Successful response + schema: + $ref: '#/definitions/ActionDefinitionList' + '400': + description: | + Invalid parameter: value of **maxItems**, **skipCount** or **orderBy** is invalid + '401': + description: Authentication failed + default: + description: Unexpected error + schema: + $ref: '#/definitions/Error' '/action-definitions/{actionDefinitionId}': get: x-alfresco-since: "5.2.2" @@ -9262,7 +9262,7 @@ definitions: SiteContainerPaging: type: object required: - - list + - list properties: list: type: object @@ -9302,10 +9302,10 @@ definitions: role: type: string enum: - - SiteConsumer - - SiteCollaborator - - SiteContributor - - SiteManager + - SiteConsumer + - SiteCollaborator + - SiteContributor + - SiteManager id: type: string SiteMembershipBodyUpdate: @@ -9316,10 +9316,10 @@ definitions: role: type: string enum: - - SiteConsumer - - SiteCollaborator - - SiteContributor - - SiteManager + - SiteConsumer + - SiteCollaborator + - SiteContributor + - SiteManager SiteMemberPaging: type: object required: @@ -9773,8 +9773,8 @@ definitions: list: type: object required: - - pagination - - entries + - pagination + - entries properties: pagination: $ref: '#/definitions/Pagination' @@ -10089,8 +10089,8 @@ definitions: required: - target properties: - target: - type: object + target: + type: object FavoritePaging: type: object required: @@ -10409,8 +10409,8 @@ definitions: AssociationBody: type: object required: - - targetId - - assocType + - targetId + - assocType properties: targetId: type: string @@ -10429,8 +10429,8 @@ definitions: ChildAssociationBody: type: object required: - - childId - - assocType + - childId + - assocType properties: childId: type: string @@ -10471,8 +10471,8 @@ definitions: type: string default: ALLOWED enum: - - ALLOWED - - DENIED + - ALLOWED + - DENIED PermissionsInfo: type: object properties: @@ -10595,14 +10595,14 @@ definitions: type: string default: ALLOW_OWNER_CHANGES enum: - - ALLOW_OWNER_CHANGES - - FULL + - ALLOW_OWNER_CHANGES + - FULL lifetime: type: string default: PERSISTENT enum: - - PERSISTENT - - EPHEMERAL + - PERSISTENT + - EPHEMERAL NodePaging: type: object properties: @@ -10717,15 +10717,15 @@ definitions: Node: type: object required: - - id - - name - - nodeType - - isFolder - - isFile - - createdAt - - createdByUser - - modifiedAt - - modifiedByUser + - id + - name + - nodeType + - isFolder + - isFile + - createdAt + - createdByUser + - modifiedAt + - modifiedByUser properties: id: type: string @@ -11219,8 +11219,8 @@ definitions: createdByUser: $ref: '#/definitions/UserInfo' createdAt: - type: string - format: date-time + type: string + format: date-time values: type: object ActionConstraint: @@ -11316,12 +11316,12 @@ definitions: items: $ref: '#/definitions/ActionDefinition' ActionDefinitionEntry: - type: object - required: - - entry - properties: - entry: - $ref: '#/definitions/ActionDefinition' + type: object + required: + - entry + properties: + entry: + $ref: '#/definitions/ActionDefinition' ActionDefinition: type: object required: @@ -11514,8 +11514,8 @@ definitions: description: How to combine the clauses of this condition ("and" or "or") type: string enum: - - and - - or + - and + - or default: "and" compositeConditions: description: Nested list of composite clauses in this condition From 8677fba4e50870cf64268a4b48e19017eece1b26 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Fri, 21 Jun 2024 12:23:10 +0530 Subject: [PATCH 05/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- src/main/webapp/definitions/alfresco-core.yaml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 11de5b67..aeea1630 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2542,7 +2542,7 @@ paths: get: tags: - nodes - summary: Get the size of folder after initiating POST/calculate Endpoint. + summary: Get the size of folder after initiating POST/calculateSize Endpoint. description: | ***Receiving the size*** @@ -10785,17 +10785,22 @@ definitions: properties: id: type: string + description: Provides the id for which POST/calculateSize has been initiated. size: type: string + description: Provides a folder size in bytes. calculatedAtTime: type: string + description: Provides the time when the calculating folder size will be completed. status: type: string + description: Provides a status that signifies the completion of the calculateSize mechanism. sizeAcknowledgedResponse: type: object properties: executionId: type: string + description: Provides nodeId indicating that the request has been acknowledged. ProbeEntry: type: object required: From f439d5cc0e1c52b6c9e73af69eaa10db26806e2f Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Fri, 21 Jun 2024 18:18:55 +0530 Subject: [PATCH 06/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- src/main/webapp/definitions/alfresco-core.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index aeea1630..c7d0afd7 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2529,6 +2529,9 @@ paths: description: Request Accepted schema: $ref: '#/definitions/sizeAcknowledgedResponse' + '400': + description: | + Invalid parameter: **nodeId** is not of Folder Type '401': description: Authentication failed '403': @@ -2565,6 +2568,9 @@ paths: description: Successful Response schema: $ref: '#/definitions/calculateSizeResponse' + '400': + description: | + Invalid parameter: **nodeId** is not of Folder Type '401': description: Authentication failed '403': From 4cce1f4b031332804fe657e8572cd55359e6e602 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Mon, 24 Jun 2024 10:16:08 +0530 Subject: [PATCH 07/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- src/main/webapp/definitions/alfresco-core.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index c7d0afd7..e475f72f 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -10798,6 +10798,9 @@ definitions: calculatedAtTime: type: string description: Provides the time when the calculating folder size will be completed. + numberOfFiles: + type: integer + description: Provides the number of files in the folder. status: type: string description: Provides a status that signifies the completion of the calculateSize mechanism. From bd022963fa7fb147c3fb76e659fc93d3ebfa09d8 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Tue, 25 Jun 2024 15:17:38 +0530 Subject: [PATCH 08/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- src/main/webapp/definitions/alfresco-core.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index e475f72f..2c89db8c 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2531,7 +2531,7 @@ paths: $ref: '#/definitions/sizeAcknowledgedResponse' '400': description: | - Invalid parameter: **nodeId** is not of Folder Type + Invalid parameter: value of **nodeId** is invalid '401': description: Authentication failed '403': @@ -2570,7 +2570,7 @@ paths: $ref: '#/definitions/calculateSizeResponse' '400': description: | - Invalid parameter: **nodeId** is not of Folder Type + Invalid parameter: value of **nodeId** is invalid '401': description: Authentication failed '403': From 58b79e21dc89dedf24144af415ba2a2482a31634 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Tue, 25 Jun 2024 18:56:25 +0530 Subject: [PATCH 09/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- src/main/webapp/definitions/alfresco-core.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 2c89db8c..531ab775 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2554,7 +2554,7 @@ paths: Below are the three stages, which reflect the status for the present execution ***nodeId***. ``` - NOT INITIATED: Not Iniated yet. + NOT-INITIATED: Not Initiated yet. IN-PROGRESS: Calculating execution is in progress. COMPLETED: Calculation has been done. ``` @@ -10807,7 +10807,7 @@ definitions: sizeAcknowledgedResponse: type: object properties: - executionId: + nodeId: type: string description: Provides nodeId indicating that the request has been acknowledged. ProbeEntry: From 2747ef97eea41144cc52840b7b5f90f09ac7f25a Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Fri, 28 Jun 2024 12:30:37 +0530 Subject: [PATCH 10/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- .../webapp/definitions/alfresco-core.yaml | 37 ++++++++----------- 1 file changed, 15 insertions(+), 22 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 531ab775..ed8de833 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -128,9 +128,7 @@ parameters: in: query description: | This assists in handling scenarios where ***large files*** or ***subfolders*** exist within a folder, - allowing the folder size determination mechanism to function in chunks. - - So that calculating the huge folder will be done efficiently. + allowing the folder size determination mechanism to function in chunks.So that calculating the huge folder will be done efficiently. If not supplied then the default value is 100. required: false type: integer @@ -2505,18 +2503,7 @@ paths: The response body will include the ```nodeId``` of the pending action, which can be used in a **GET/calculateSize** 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```. - Essentially, ```maxItems``` ***parameter*** is utilized for pagination purposes. - - By default, **results are limited to the first 100.** - Results can be restricted using "paging". For example: - - ```JSON - "paging": { - "maxItems": "50", - "skipCount": "28" - } - ``` - This assists in handling scenarios where large files or subfolders exist within a folder, allowing the folder size determination mechanism to function in chunks. + Here, We are taking ```maxItems``` ***parameter*** for splitting a large folder into smaller chunks to calculate efficiently and consolidating all size in single unit. operationId: calculateSize produces: @@ -2545,17 +2532,17 @@ paths: get: tags: - nodes - summary: Get the size of folder after initiating POST/calculateSize Endpoint. + summary: Get the result of a background job to calculate the size of a folder. description: | ***Receiving the size*** This endpoint takes ```nodeId``` as a path parameter and returns the result after executing above POST request. - Below are the three stages, which reflect the status for the present execution ***nodeId***. + The size calculation job can be in one of three states: ``` NOT-INITIATED: Not Initiated yet. - IN-PROGRESS: Calculating execution is in progress. + IN-PROGRESS: Calculation is in progress. COMPLETED: Calculation has been done. ``` operationId: getSize @@ -10794,16 +10781,22 @@ definitions: description: Provides the id for which POST/calculateSize has been initiated. size: type: string - description: Provides a folder size in bytes. - calculatedAtTime: + description: The folder size in bytes. + calculatedAt: type: string - description: Provides the time when the calculating folder size will be completed. + description: Provides the timestamp when the calculation of folder size is completed. numberOfFiles: type: integer description: Provides the number of files in the folder. status: type: string - description: Provides a status that signifies the completion of the calculateSize mechanism. + description: | + Provides a status that signifies the completion of the calculateSize mechanism. + ``` + NOT-INITIATED: Not Initiated yet. + IN-PROGRESS: Calculation is in progress. + COMPLETED: Calculation has been done. + ``` sizeAcknowledgedResponse: type: object properties: From be8fd6f01f0156c2249d3ad522354288e1db54c5 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Fri, 28 Jun 2024 12:47:54 +0530 Subject: [PATCH 11/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- src/main/webapp/definitions/alfresco-core.yaml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index ed8de833..75a8be8b 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -127,9 +127,7 @@ parameters: name: maxItems in: query description: | - This assists in handling scenarios where ***large files*** or ***subfolders*** exist within a folder, - allowing the folder size determination mechanism to function in chunks.So that calculating the huge folder will be done efficiently. - If not supplied then the default value is 100. + ```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 @@ -2503,7 +2501,7 @@ paths: The response body will include the ```nodeId``` of the pending action, which can be used in a **GET/calculateSize** 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*** for splitting a large folder into smaller chunks to calculate efficiently and consolidating all size in single unit. + 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. operationId: calculateSize produces: From c60dd43ed62ac2c0e4191fd574dd03a2cbad05c1 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Fri, 28 Jun 2024 17:38:37 +0530 Subject: [PATCH 12/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- src/main/webapp/definitions/alfresco-core.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 75a8be8b..3a9b36fb 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -123,6 +123,12 @@ parameters: description: The identifier of a target node. required: true type: string + nodeFolderIdParam: + name: nodeId + in: path + description: The identifier of a folder node. + required: true + type: string maxItemsForSizeParam: name: maxItems in: query From 86225e262261e151db5b8f7905c5b0255257b1ef Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Tue, 2 Jul 2024 13:30:18 +0530 Subject: [PATCH 13/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- src/main/webapp/definitions/alfresco-core.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 3a9b36fb..62c8ba74 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -137,6 +137,7 @@ parameters: required: false type: integer minimum: 1 + maximum: 1000 default: 100 nodeMinimalEntryIncludeParam: name: include @@ -10804,7 +10805,7 @@ definitions: sizeAcknowledgedResponse: type: object properties: - nodeId: + executionId: type: string description: Provides nodeId indicating that the request has been acknowledged. ProbeEntry: From 162d5f664a2f6e5c66dfbf526df67616de745c8d Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Tue, 2 Jul 2024 13:35:02 +0530 Subject: [PATCH 14/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- src/main/webapp/definitions/alfresco-core.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 62c8ba74..9169bd8c 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2521,15 +2521,15 @@ paths: description: Request Accepted schema: $ref: '#/definitions/sizeAcknowledgedResponse' - '400': - description: | - Invalid parameter: value of **nodeId** is invalid '401': 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: @@ -2560,15 +2560,15 @@ paths: description: Successful Response schema: $ref: '#/definitions/calculateSizeResponse' - '400': - description: | - Invalid parameter: value of **nodeId** is invalid '401': 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: From 8a4bd1edefbaa2efae883d9ee426a886447298fb Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Mon, 22 Jul 2024 12:09:22 +0530 Subject: [PATCH 15/29] [MNT-24127] Added Endpoint to Calculate Folder Size. --- src/main/webapp/definitions/alfresco-core.yaml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 9169bd8c..b92b73eb 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -129,6 +129,12 @@ parameters: description: The identifier of a folder node. required: true type: string + executedIdParam: + name: executionId + in: path + description: The identifier of a Execution Job. + required: true + type: string maxItemsForSizeParam: name: maxItems in: query @@ -2534,6 +2540,7 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' + '/nodes/{executionId}/calculateSize': get: tags: - nodes @@ -2554,7 +2561,7 @@ paths: produces: - application/json parameters: - - $ref: '#/parameters/nodeTargetIdParam' + - $ref: '#/parameters/executedIdParam' responses: '200': description: Successful Response From 13f03387e1722f3d2ebee5f6b64808bfe8700368 Mon Sep 17 00:00:00 2001 From: Mohit Singh Date: Tue, 23 Jul 2024 12:48:51 +0530 Subject: [PATCH 16/29] [feature/MNT-24127] AddedEndpointToCalculateTheFolderSize --- src/main/webapp/definitions/alfresco-core.yaml | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index b92b73eb..c66e1241 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2569,13 +2569,8 @@ paths: $ref: '#/definitions/calculateSizeResponse' '401': 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 + description: Searched **ExecutionId** does not exist default: description: Unexpected error schema: From a449659a1a547d7beca7aaebb4943d7afc5a7378 Mon Sep 17 00:00:00 2001 From: Mohit Singh Date: Wed, 31 Jul 2024 10:20:51 +0530 Subject: [PATCH 17/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Added Swagger endpoints to calculate folder size --- .../webapp/definitions/alfresco-core.yaml | 161 +++++++++--------- 1 file changed, 80 insertions(+), 81 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index c66e1241..05bf3424 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -129,12 +129,6 @@ parameters: description: The identifier of a folder node. required: true type: string - executedIdParam: - name: executionId - in: path - description: The identifier of a Execution Job. - required: true - type: string maxItemsForSizeParam: name: maxItems in: query @@ -2214,6 +2208,86 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' + '/nodes/{nodeId}/calculate-folder-size': + post: + tags: + - nodes + summary: Calculate a folder size + description: | + + This may be executed against a node specified by **nodeId** and this nodeId must be a valid node ID. + Furthermore, this POST endpoint will be executed **asynchronously** with a `202` HTTP response signifying that + the request has been accepted successfully. + + The response body will include the ```nodeId``` of the pending action, which can be used in a + **GET/calculateSize** 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. + + operationId: calculateSize + produces: + - application/json + parameters: + - $ref: '#/parameters/nodeTargetIdParam' + - $ref: '#/parameters/maxItemsForSizeParam' + responses: + '202': + description: Request Accepted + schema: + $ref: '#/definitions/sizeAcknowledgedResponse' + '401': + 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': + get: + tags: + - nodes + summary: Get the result of a background job to calculate the size of a folder. + description: | + ***Receiving the size*** + + This endpoint takes ```nodeId``` as a path parameter and returns the result after executing above POST request. + + The size calculation job can be in one of three states: + + ``` + NOT-INITIATED: Not Initiated yet. + IN-PROGRESS: Calculation is in progress. + COMPLETED: Calculation has been done. + ``` + operationId: getSize + produces: + - application/json + parameters: + - $ref: '#/parameters/nodeTargetIdParam' + responses: + '200': + description: Successful Response + schema: + $ref: '#/definitions/calculateSizeResponse' + '401': + 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}/renditions': post: x-alfresco-since: "5.2" @@ -2500,81 +2574,6 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' - '/nodes/{nodeId}/calculateSize': - post: - tags: - - nodes - summary: Calculate a folder size - description: | - - This may be executed against a node specified by **nodeId** and this nodeId must be a valid node ID. - Furthermore, this POST endpoint will be executed **asynchronously** with a `202` HTTP response signifying that - the request has been accepted successfully. - - The response body will include the ```nodeId``` of the pending action, which can be used in a - **GET/calculateSize** 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. - - operationId: calculateSize - produces: - - application/json - parameters: - - $ref: '#/parameters/nodeTargetIdParam' - - $ref: '#/parameters/maxItemsForSizeParam' - responses: - '202': - description: Request Accepted - schema: - $ref: '#/definitions/sizeAcknowledgedResponse' - '401': - 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/{executionId}/calculateSize': - get: - tags: - - nodes - summary: Get the result of a background job to calculate the size of a folder. - description: | - ***Receiving the size*** - - This endpoint takes ```nodeId``` as a path parameter and returns the result after executing above POST request. - - The size calculation job can be in one of three states: - - ``` - NOT-INITIATED: Not Initiated yet. - IN-PROGRESS: Calculation is in progress. - COMPLETED: Calculation has been done. - ``` - operationId: getSize - produces: - - application/json - parameters: - - $ref: '#/parameters/executedIdParam' - responses: - '200': - description: Successful Response - schema: - $ref: '#/definitions/calculateSizeResponse' - '401': - description: Authentication failed - '404': - description: Searched **ExecutionId** does not exist - default: - description: Unexpected error - schema: - $ref: '#/definitions/Error' '/nodes/{nodeId}/secondary-children': post: x-alfresco-since: "5.2" From 526085b2e25eb61cd57eeff3c480bee65a778ff3 Mon Sep 17 00:00:00 2001 From: Mohit Singh Date: Mon, 5 Aug 2024 17:54:55 +0530 Subject: [PATCH 18/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Added swagger endpoints to calculate & receive folder size --- src/main/webapp/definitions/alfresco-core.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 05bf3424..95be31a1 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -10782,9 +10782,9 @@ definitions: calculateSizeResponse: type: object properties: - id: + nodeId: type: string - description: Provides the id for which POST/calculateSize has been initiated. + description: Provides the nodeId for which POST/calculateSize has been initiated. size: type: string description: The folder size in bytes. @@ -10806,7 +10806,7 @@ definitions: sizeAcknowledgedResponse: type: object properties: - executionId: + nodeId: type: string description: Provides nodeId indicating that the request has been acknowledged. ProbeEntry: From 2ded532e6a84edf2dfc424b6ec7f47690d366f6d Mon Sep 17 00:00:00 2001 From: Mohit Singh Date: Tue, 6 Aug 2024 09:22:05 +0530 Subject: [PATCH 19/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Added swagger endpoints to calculate & receive folder size --- src/main/webapp/definitions/alfresco-core.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 95be31a1..ccc1fcfc 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2220,7 +2220,7 @@ 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/calculateSize** 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```. + **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. @@ -10784,7 +10784,7 @@ definitions: properties: nodeId: type: string - description: Provides the nodeId for which POST/calculateSize has been initiated. + description: Provides the nodeId for which POST/calculate-folder-size has been initiated. size: type: string description: The folder size in bytes. From f241a3166a27ac085cc88ff3fd6a7af7bd9a2e6d Mon Sep 17 00:00:00 2001 From: Mohit Singh Date: Wed, 7 Aug 2024 21:53:23 +0530 Subject: [PATCH 20/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Added swagger endpoints to calculate folder size --- .../webapp/definitions/alfresco-core.yaml | 25 +++---------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index ccc1fcfc..cb33f53d 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -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 @@ -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 @@ -2239,8 +2226,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 @@ -2248,7 +2233,7 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' - '/nodes/{nodeId}/get-folder-size': + '/nodes/{nodeId}/size': get: tags: - nodes @@ -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 @@ -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: From 1236919e23980031f50032c0beab748b9335c93f Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Thu, 22 Aug 2024 12:55:46 +0530 Subject: [PATCH 21/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Updated swagger endpoints to calculate and retrieve folder size --- .../webapp/definitions/alfresco-core.yaml | 57 +++++++------------ 1 file changed, 20 insertions(+), 37 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index cb33f53d..4b04ecd9 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2198,7 +2198,7 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' - '/nodes/{nodeId}/calculate-folder-size': + '/nodes/{nodeId}/request-size-details': post: tags: - nodes @@ -2209,48 +2209,19 @@ paths: Furthermore, this POST endpoint will be executed **asynchronously** with a `202` HTTP response signifying that the request has been accepted successfully. - The response body will include the ```nodeId``` of the pending action, which can be used in a - **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' - responses: - '202': - description: Request Accepted - schema: - $ref: '#/definitions/sizeAcknowledgedResponse' - '401': - description: Authentication failed - '403': - description: Current user does not have permission for **nodeId** - '422': - description: | - Invalid parameter: value of **nodeId** is invalid - default: - description: Unexpected error - schema: - $ref: '#/definitions/Error' - '/nodes/{nodeId}/size': - get: - tags: - - nodes - summary: Get the result of a background job to calculate the size of a folder. - description: | - ***Receiving the size*** - - This endpoint takes ```nodeId``` as a path parameter and returns the result after executing above POST request. + The response body (after calculating folder size) will include the ```nodeId``` of the pending/completed action, along with the ```the size of the node in bytes```. + + ***Receiving the size details*** The size calculation job can be in one of three states: - + ``` NOT-INITIATED: Not Initiated yet. IN-PROGRESS: Calculation is in progress. COMPLETED: Calculation has been done. ``` - operationId: getSize + + operationId: calculateSize produces: - application/json parameters: @@ -2260,6 +2231,10 @@ paths: description: Successful Response schema: $ref: '#/definitions/calculateSizeResponse' + '202': + description: Request Accepted + schema: + $ref: '#/definitions/sizeAcknowledgedResponse' '401': description: Authentication failed '403': @@ -10767,7 +10742,7 @@ definitions: properties: nodeId: type: string - description: Provides the nodeId for which POST/calculate-folder-size has been initiated. + description: Provides the nodeId for which POST/request-size-details has been initiated. size: type: string description: The folder size in bytes. @@ -10785,7 +10760,15 @@ definitions: NOT-INITIATED: Not Initiated yet. IN-PROGRESS: Calculation is in progress. COMPLETED: Calculation has been done. + ``` + nodeSizeDetailsBody: + type: object + required: + - folderName + properties: + folderName: + type: string sizeAcknowledgedResponse: type: object properties: From 32e6ef00b9367bcdd5a2b9a45aa186d474c3533d Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Thu, 22 Aug 2024 13:02:33 +0530 Subject: [PATCH 22/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Updated swagger endpoints to calculate and retrieve folder size --- src/main/webapp/definitions/alfresco-core.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 4b04ecd9..09583062 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2221,7 +2221,7 @@ paths: COMPLETED: Calculation has been done. ``` - operationId: calculateSize + operationId: calculateAndRetrieveSize produces: - application/json parameters: From 083b1b0d272bcc83bfd4591243a0800cf19f03d5 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Fri, 23 Aug 2024 12:12:17 +0530 Subject: [PATCH 23/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Updated swagger endpoints to calculate and retrieve folder size --- src/main/webapp/definitions/alfresco-core.yaml | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 09583062..b4ae0fd0 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2233,12 +2233,13 @@ paths: $ref: '#/definitions/calculateSizeResponse' '202': description: Request Accepted - schema: - $ref: '#/definitions/sizeAcknowledgedResponse' '401': description: Authentication failed '403': description: Current user does not have permission for **nodeId** + '404': + description: | + **nodeId** or **folderId** does not exist '422': description: | Invalid parameter: value of **nodeId** is invalid @@ -10769,12 +10770,6 @@ definitions: properties: folderName: type: string - sizeAcknowledgedResponse: - type: object - properties: - message: - type: string - description: Provides response indicating that the request has been acknowledged. ProbeEntry: type: object required: From 85297a2b5f15d02beb5ff412c22703cd11817d76 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Fri, 23 Aug 2024 16:11:08 +0530 Subject: [PATCH 24/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Updated swagger endpoints to calculate and retrieve folder size --- src/main/webapp/definitions/alfresco-core.yaml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index b4ae0fd0..a6998f56 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -10763,13 +10763,6 @@ definitions: COMPLETED: Calculation has been done. ``` - nodeSizeDetailsBody: - type: object - required: - - folderName - properties: - folderName: - type: string ProbeEntry: type: object required: From ba492a6dbf495bfd72257c6f96c7ec88e844c629 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Wed, 28 Aug 2024 17:22:25 +0530 Subject: [PATCH 25/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Updated swagger endpoints to calculate and retrieve folder size --- src/main/webapp/definitions/alfresco-core.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index a6998f56..3765737c 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2198,7 +2198,7 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' - '/nodes/{nodeId}/request-size-details': + '/nodes/{nodeId}/request-size-detail': post: tags: - nodes @@ -10743,7 +10743,7 @@ definitions: properties: nodeId: type: string - description: Provides the nodeId for which POST/request-size-details has been initiated. + description: Provides the nodeId for which POST/request-size-detail has been initiated. size: type: string description: The folder size in bytes. From 417181cbd04abad0b23f345102fa948a9879ccd3 Mon Sep 17 00:00:00 2001 From: kshah Date: Wed, 4 Sep 2024 01:46:32 +0530 Subject: [PATCH 26/29] size details api as per the relationship API framework --- .../webapp/definitions/alfresco-core.yaml | 79 +++++++++++++++---- 1 file changed, 64 insertions(+), 15 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 3765737c..32e729d7 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -123,6 +123,12 @@ parameters: description: The identifier of a target node. required: true type: string + jobIdParam: + name: jobId + in: path + description: The identifier of a job. + required: true + type: string nodeFolderIdParam: name: nodeId in: path @@ -2198,22 +2204,51 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' - '/nodes/{nodeId}/request-size-detail': + '/nodes/{nodeId}/size-details': post: tags: - nodes - summary: Calculate a folder size + summary: Accepts request to generate Node Size Details description: | This may be executed against a node specified by **nodeId** and this nodeId must be a valid node ID. Furthermore, this POST endpoint will be executed **asynchronously** with a `202` HTTP response signifying that the request has been accepted successfully. - The response body (after calculating folder size) will include the ```nodeId``` of the pending/completed action, along with the ```the size of the node in bytes```. - - ***Receiving the size details*** - - The size calculation job can be in one of three states: + The response body will include the ```jobId``` of the pending/completed action. + operationId: getNodeSizeDetailsRequest + produces: + - application/json + parameters: + - $ref: '#/parameters/nodeTargetIdParam' + responses: + '202': + description: Request Accepted + schema: + $ref: '#/definitions/sizeDetailsRequestResultEntry' + '401': + description: Authentication failed + '403': + description: Current user does not have permission for **nodeId** + '404': + description: | + **nodeId** or **folderId** does not exist + '422': + description: | + Invalid parameter: value of **nodeId** is invalid + default: + description: Unexpected error + schema: + $ref: '#/definitions/Error' + '/nodes/{nodeId}/size-details/{jobId}': + get: + tags: + - nodes + summary: Get the result of a background job to get the size of a node. + description: | + ***Receiving the size*** + This endpoint takes ```nodeId``` and ```jobId``` as the path parameters and returns the result after executing above GET request. + The size details job can be in one of three states: ``` NOT-INITIATED: Not Initiated yet. @@ -2221,25 +2256,21 @@ paths: COMPLETED: Calculation has been done. ``` - operationId: calculateAndRetrieveSize + operationId: getNodeSizeDetails produces: - application/json parameters: - $ref: '#/parameters/nodeTargetIdParam' + - $ref: '#/parameters/jobIdParam' responses: '200': description: Successful Response schema: - $ref: '#/definitions/calculateSizeResponse' - '202': - description: Request Accepted + $ref: '#/definitions/getNodeSizeDetailsResponse' '401': description: Authentication failed '403': description: Current user does not have permission for **nodeId** - '404': - description: | - **nodeId** or **folderId** does not exist '422': description: | Invalid parameter: value of **nodeId** is invalid @@ -10738,7 +10769,7 @@ definitions: $ref: '#/definitions/PermissionsInfo' definition: $ref: '#/definitions/Definition' - calculateSizeResponse: + getNodeSizeDetailsResponse: type: object properties: nodeId: @@ -10763,6 +10794,9 @@ definitions: COMPLETED: Calculation has been done. ``` + jobId: + type: string + description: Provides the getId for which POST/size-details has been initiated. ProbeEntry: type: object required: @@ -11371,6 +11405,21 @@ definitions: id: type: string description: The unique identifier of the action pending execution + sizeDetailsRequestResultEntry: + type: object + required: + - entry + properties: + entry: + $ref: '#/definitions/sizeDetailsRequestExecResult' + sizeDetailsRequestExecResult: + type: object + required: + - jobId + properties: + jobId: + type: string + description: The unique identifier of the size details execution request Definition: properties: properties: From 531616c885cac3e81be77d2f1fed2fef8d8fcc9f Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Wed, 4 Sep 2024 14:06:00 +0530 Subject: [PATCH 27/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Updated swagger endpoints to calculate and retrieve folder size --- src/main/webapp/definitions/alfresco-core.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 32e729d7..d580b4fc 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2271,6 +2271,9 @@ paths: description: Authentication failed '403': description: Current user does not have permission for **nodeId** + '404': + description: | + **nodeId** or **folderId** does not exist '422': description: | Invalid parameter: value of **nodeId** is invalid From 0af21822fc4b3755c0652b357c9d15352b591f5b Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Fri, 13 Sep 2024 12:10:57 +0530 Subject: [PATCH 28/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Updated swagger endpoints to calculate and retrieve folder size --- src/main/webapp/definitions/alfresco-core.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index d580b4fc..927f57b2 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -10775,10 +10775,10 @@ definitions: getNodeSizeDetailsResponse: type: object properties: - nodeId: + id: type: string - description: Provides the nodeId for which POST/request-size-detail has been initiated. - size: + description: Provides the nodeId for which POST/size-details has been initiated. + sizeInBytes: type: string description: The folder size in bytes. calculatedAt: From 87d62e7e1be433786b31d4d8672f7d3260b25b73 Mon Sep 17 00:00:00 2001 From: mohit-singh4 Date: Thu, 19 Sep 2024 11:18:42 +0530 Subject: [PATCH 29/29] [feature/MNT-24127-AddedEndpointToCalculateTheFolderSize] Updated swagger endpoints to calculate and retrieve folder size --- src/main/webapp/definitions/alfresco-core.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/webapp/definitions/alfresco-core.yaml b/src/main/webapp/definitions/alfresco-core.yaml index 927f57b2..d4e09277 100755 --- a/src/main/webapp/definitions/alfresco-core.yaml +++ b/src/main/webapp/definitions/alfresco-core.yaml @@ -2273,7 +2273,7 @@ paths: description: Current user does not have permission for **nodeId** '404': description: | - **nodeId** or **folderId** does not exist + **nodeId** or **jobId** does not exist '422': description: | Invalid parameter: value of **nodeId** is invalid