Skip to content

Commit

Permalink
[MNT-24575] Added documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
swapnil-verma-gl committed Dec 6, 2024
1 parent c7559ed commit fd205ba
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/core/services/nodes-api.service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)`>`<br/>
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)`>`<br/>
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

Expand Down
7 changes: 7 additions & 0 deletions lib/js-api/src/api/content-rest-api/docs/JobIdBody.md
Original file line number Diff line number Diff line change
@@ -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]
7 changes: 7 additions & 0 deletions lib/js-api/src/api/content-rest-api/docs/JobIdBodyEntry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# JobIdBodyEntry

**Properties**

| Name | Type |
|-----------|---------------------------|
| **entry** | [JobIdBody](JobIdBody.md) |
12 changes: 12 additions & 0 deletions lib/js-api/src/api/content-rest-api/docs/SizeDetails.md
Original file line number Diff line number Diff line change
@@ -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]
7 changes: 7 additions & 0 deletions lib/js-api/src/api/content-rest-api/docs/SizeDetailsEntry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# SizeDetailsEntry

**Properties**

| Name | Type |
|-----------|-------------------------------|
| **entry** | [SizeDetails](SizeDetails.md) |

0 comments on commit fd205ba

Please sign in to comment.