From fd205badc4f59809bb6625fd5b7e3eef5ffa6d35 Mon Sep 17 00:00:00 2001 From: "swapnil.verma" Date: Fri, 6 Dec 2024 17:44:59 +0530 Subject: [PATCH] [MNT-24575] Added documentation --- docs/core/services/nodes-api.service.md | 9 +++++++++ .../src/api/content-rest-api/docs/JobIdBody.md | 7 +++++++ .../src/api/content-rest-api/docs/JobIdBodyEntry.md | 7 +++++++ .../src/api/content-rest-api/docs/SizeDetails.md | 12 ++++++++++++ .../api/content-rest-api/docs/SizeDetailsEntry.md | 7 +++++++ 5 files changed, 42 insertions(+) create mode 100644 lib/js-api/src/api/content-rest-api/docs/JobIdBody.md create mode 100644 lib/js-api/src/api/content-rest-api/docs/JobIdBodyEntry.md create mode 100644 lib/js-api/src/api/content-rest-api/docs/SizeDetails.md create mode 100644 lib/js-api/src/api/content-rest-api/docs/SizeDetailsEntry.md diff --git a/docs/core/services/nodes-api.service.md b/docs/core/services/nodes-api.service.md index ce6ef9582de..82beb830e6c 100644 --- a/docs/core/services/nodes-api.service.md +++ b/docs/core/services/nodes-api.service.md @@ -89,6 +89,15 @@ Accesses and manipulates ACS document nodes using their node IDs. - _nodeId:_ `string` - ID of the target node - _options:_ `{ includeSource?: boolean; } & NodesIncludeQuery & ContentPagingQuery` - Optional parameters supported by JS-API - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Hold[]`](../../../lib/js-api/src/api/gs-core-rest-api/docs/Hold.md)`>` - List of assigned holds +- **initiateFolderSizeCalculation**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`JobIdBodyEntry`](../../../lib/js-api/src/api/content-rest-api/docs/JobIdBodyEntry.md)`>`
+ Initiate a new request to calculate folder size. + - _nodeId:_ `string` - ID of the target node + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`JobIdBodyEntry`](../../../lib/js-api/src/api/content-rest-api/docs/JobIdBodyEntry.md)`>` - Job id which can be used to track request status +- **getFolderSizeInfo**(nodeId: `string`, jobId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SizeDetailsEntry`](../../../lib/js-api/src/api/content-rest-api/docs/SizeDetailsEntry.md)`>`
+ Gets the size of a folder. + - _nodeId:_ `string` - ID of the target node + - _jobId:_ `string` - ID of the job started by the `initiateFolderSizeCalculation` request + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SizeDetailsEntry`](../../../lib/js-api/src/api/content-rest-api/docs/SizeDetailsEntry.md)`>` - Details of the folder ## Details diff --git a/lib/js-api/src/api/content-rest-api/docs/JobIdBody.md b/lib/js-api/src/api/content-rest-api/docs/JobIdBody.md new file mode 100644 index 00000000000..a7e3900d903 --- /dev/null +++ b/lib/js-api/src/api/content-rest-api/docs/JobIdBody.md @@ -0,0 +1,7 @@ +# JobIdBody + +## Properties + + Name | Type | Description | Notes +-----------|--------|---------------------------------------------------------------------------------------|------------------- + **jobId** | string | Id of the job that can be used to track the status of folder size calculation request | [default to null] diff --git a/lib/js-api/src/api/content-rest-api/docs/JobIdBodyEntry.md b/lib/js-api/src/api/content-rest-api/docs/JobIdBodyEntry.md new file mode 100644 index 00000000000..c90bf91177a --- /dev/null +++ b/lib/js-api/src/api/content-rest-api/docs/JobIdBodyEntry.md @@ -0,0 +1,7 @@ +# JobIdBodyEntry + +**Properties** + +| Name | Type | +|-----------|---------------------------| +| **entry** | [JobIdBody](JobIdBody.md) | diff --git a/lib/js-api/src/api/content-rest-api/docs/SizeDetails.md b/lib/js-api/src/api/content-rest-api/docs/SizeDetails.md new file mode 100644 index 00000000000..8e865fa6858 --- /dev/null +++ b/lib/js-api/src/api/content-rest-api/docs/SizeDetails.md @@ -0,0 +1,12 @@ +# Size Details + +## Properties + + Name | Type | Description | Notes +-------------------|--------|-----------------------------------------------------------------------------|------------------- + **id** | string | | [default to null] + **sizeInBytes** | string | Size of the folder in bytes | [default to null] + **calculatedAt** | string | Timestamp of when the folder size was calculated | [default to null] + **numberOfFiles** | number | Number of files present within the folder | [default to null] + **status** | string | Status of the request. Can be 'NOT-INITIATED', 'IN-PROGRESS' or 'COMPLETED' | [default to null] + **jobId** | string | The job ID which was used to track down the folder details | [default to null] diff --git a/lib/js-api/src/api/content-rest-api/docs/SizeDetailsEntry.md b/lib/js-api/src/api/content-rest-api/docs/SizeDetailsEntry.md new file mode 100644 index 00000000000..5ac215ff886 --- /dev/null +++ b/lib/js-api/src/api/content-rest-api/docs/SizeDetailsEntry.md @@ -0,0 +1,7 @@ +# SizeDetailsEntry + +**Properties** + +| Name | Type | +|-----------|-------------------------------| +| **entry** | [SizeDetails](SizeDetails.md) |