Skip to content
This repository was archived by the owner on Jun 11, 2025. It is now read-only.

Commit d52c074

Browse files
eromanoeromano
committed
minor update documentation
1 parent 37286b6 commit d52c074

File tree

5 files changed

+31
-25
lines changed

5 files changed

+31
-25
lines changed

‎README.md‎

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ Below you can find some common examples.
294294

295295
getNodeInfo(fileOrFolderId, opts)
296296

297-
>Get information for the File/Folder with the identifier nodeId.
297+
>Get information for the File/Folder with the identifier nodeId. The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- as NodeId
298298
299299
###Example
300300

@@ -316,6 +316,7 @@ getNodeChildren(fileOrFolderId, opts)
316316
>Minimal information for each child is returned by default.
317317
You can use the include parameter to return additional information.
318318
returns a promise with the Info about the children of the node if resolved and {error} if rejected.
319+
You can also use one of these well-known aliases: -my- , -shared- or -root- as NodeId
319320

320321
###Example
321322

@@ -332,10 +333,11 @@ this.alfrescoJsApi.nodes.getNodeChildren(folderNodeId).then(function (data) {
332333
```
333334
## Create Folder
334335

335-
createFolder(name, relativePath, nodeId, opts)
336+
createFolder(name, relativePath, nodeIdParentFolder, opts)
336337

337338
>createFolder return a promise that is resolved if the folder is created and {error} if rejected.
338-
339+
You can also use one of these well-known aliases: -my- , -shared- or -root- as nodeIdParentFolder
340+
339341
###Example
340342

341343
```javascript
@@ -366,8 +368,9 @@ this.alfrescoJsApi.nodes.createFolder('newFolderName', 'folderA/folderB', parent
366368

367369
**CreateFolder With Auto Rename**
368370

369-
createFolderAutoRename(name, relativePath, nodeId, opts)
371+
createFolderAutoRename(name, relativePath, nodeIdParentFolder, opts)
370372
>is the same of createFolder(name, relativePath, nodeId, {autoRename: true}) is just syntactic sugar
373+
You can also use one of these well-known aliases: -my- , -shared- or -root- as nodeIdParentFolder
371374

372375
###Example
373376

@@ -599,11 +602,14 @@ executeWebScript(httpMethod, scriptPath, scriptArgs, contextRoot, servicePath)
599602
> Anatomy of a Web Script URI **http(s)://(host):(port)/(contextPath)/(servicePath)/(scriptPath)?(scriptArgs)**
600603
A Web Script is simply a service bound to a URI which responds to HTTP methods such as GET, POST, PUT and DELETE. While using the same underlying code, there are broadly two kinds of Web Scripts.
601604

602-
* **httpMethod** possible value GET, POST, PUT and DELETE
603-
* **scriptPath** path to Web Script (as defined by Web Script)
604-
* **scriptArgs** arguments to pass to Web Script
605-
* **contextRoot** path where application is deployed default value 'alfresco'
606-
* **servicePath** path where Web Script service is mapped default value 'service'
605+
###Parameters
606+
Name | Description
607+
------------- | -------------
608+
**httpMethod** | possible value GET, POST, PUT and DELETE
609+
**scriptPath** |path to Web Script (as defined by Web Script)
610+
**scriptArgs** |arguments to pass to Web Script
611+
**contextRoot** |path where application is deployed default value 'alfresco'
612+
**servicePath** |path where Web Script service is mapped default value 'service'
607613

608614
```javascript
609615

‎src/alfresco-core-rest-api/docs/ChangesApi.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ apiInstance.addNode(nodeId, nodeBody, opts).then(function(data) {
214214

215215
Name | Type | Description | Notes
216216
------------- | ------------- | ------------- | -------------
217-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
217+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
218218
**nodeBody** | [**NodeBody1**](NodeBody1.md)| The node information to create. |
219219
**autoRename** | **Boolean**| If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix. | [optional]
220220
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
@@ -405,7 +405,7 @@ apiInstance.copyNode(nodeId, copyBody, opts).then(function(data) {
405405

406406
Name | Type | Description | Notes
407407
------------- | ------------- | ------------- | -------------
408-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
408+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
409409
**copyBody** | [**CopyBody**](CopyBody.md)| The targetParentId and, optionally, a new name. |
410410
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
411411
**fields** | [**[String]**](String.md)| A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
@@ -466,7 +466,7 @@ apiInstance.createRendition(nodeId, renditionBody).then(function() {
466466

467467
Name | Type | Description | Notes
468468
------------- | ------------- | ------------- | -------------
469-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
469+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
470470
**renditionBody** | [**RenditionBody**](RenditionBody.md)| The rendition "id". |
471471

472472
### Return type
@@ -1072,7 +1072,7 @@ apiInstance.getNode(nodeId, , opts).then(function(data) {
10721072

10731073
Name | Type | Description | Notes
10741074
------------- | ------------- | ------------- | -------------
1075-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
1075+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
10761076
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
10771077
**relativePath** | **String**| If specified, returns information on the node resolved by this path. The path is relative to the specified **nodeId** | [optional]
10781078
**fields** | [**[String]**](String.md)| A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
@@ -1174,7 +1174,7 @@ apiInstance.getNodeChildren(nodeId, , opts).then(function(data) {
11741174

11751175
Name | Type | Description | Notes
11761176
------------- | ------------- | ------------- | -------------
1177-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
1177+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
11781178
**skipCount** | **Integer**| The number of entities that exist in the collection before those included in this list. | [optional]
11791179
**maxItems** | **Integer**| The maximum number of items to return in the list. | [optional]
11801180
**orderBy** | **String**| If not specified then default sort is for folders to be sorted before files, and by ascending name i.e. "orderBy=isFolder DESC,name ASC". This default can be completely overridden by specifying a specific orderBy consisting of one, two or three comma-separated list of properties (with optional ASCending or DESCending), for example, specifying “CorderBy=name DESC“D would return a mixed folder/file list. The following properties can be used to order the results: * isFolder * name * mimeType * nodeType * sizeInBytes * modifiedAt * createdAt * modifiedByUser * createdByUser | [optional]
@@ -2049,7 +2049,7 @@ apiInstance.moveNode(nodeId, moveBody, opts).then(function(data) {
20492049

20502050
Name | Type | Description | Notes
20512051
------------- | ------------- | ------------- | -------------
2052-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
2052+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
20532053
**moveBody** | [**MoveBody**](MoveBody.md)| The targetParentId and, optionally, a new name. |
20542054
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
20552055
**fields** | [**[String]**](String.md)| A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
@@ -2440,7 +2440,7 @@ apiInstance.updateNode(nodeId, nodeBody, opts).then(function(data) {
24402440

24412441
Name | Type | Description | Notes
24422442
------------- | ------------- | ------------- | -------------
2443-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
2443+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
24442444
**nodeBody** | [**NodeBody**](NodeBody.md)| The node information to update. |
24452445
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
24462446
**fields** | [**[String]**](String.md)| A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]

‎src/alfresco-core-rest-api/docs/ChildAssociationsApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ this.alfrescoJsApi.core.childAssociationsApi.addNode(nodeId, nodeBody, opts).the
133133

134134
Name | Type | Description | Notes
135135
------------- | ------------- | ------------- | -------------
136-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
136+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
137137
**nodeBody** | [**NodeBody1**](NodeBody1.md)| The node information to create. |
138138
**autoRename** | **Boolean**| If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix. | [optional]
139139
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
@@ -319,7 +319,7 @@ this.alfrescoJsApi.core.childAssociationsApi.getNodeChildren(nodeId, , opts).the
319319

320320
Name | Type | Description | Notes
321321
------------- | ------------- | ------------- | -------------
322-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
322+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
323323
**skipCount** | **Integer**| The number of entities that exist in the collection before those included in this list. | [optional]
324324
**maxItems** | **Integer**| The maximum number of items to return in the list. | [optional]
325325
**orderBy** | **String**| If not specified then default sort is for folders to be sorted before files, and by ascending name i.e. "orderBy=isFolder DESC,name ASC". This default can be completely overridden by specifying a specific orderBy consisting of one, two or three comma-separated list of properties (with optional ASCending or DESCending), for example, specifying “CorderBy=name DESC“D would return a mixed folder/file list. The following properties can be used to order the results:* isFolder * name * mimeType * nodeType * sizeInBytes * modifiedAt * createdAt * modifiedByUser * createdByUser | [optional]
@@ -522,7 +522,7 @@ this.alfrescoJsApi.core.childAssociationsApi.moveNode(nodeId, moveBody, opts).th
522522

523523
Name | Type | Description | Notes
524524
------------- | ------------- | ------------- | -------------
525-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
525+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
526526
**moveBody** | [**MoveBody**](MoveBody.md)| The targetParentId and, optionally, a new name. |
527527
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
528528
**fields** | [**[String]**](String.md)| A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]

‎src/alfresco-core-rest-api/docs/NodesApi.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ this.alfrescoJsApi.core.nodesApi.copyNode(nodeId, copyBody, opts).then(function(
193193

194194
Name | Type | Description | Notes
195195
------------- | ------------- | ------------- | -------------
196-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
196+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
197197
**copyBody** | [**CopyBody**](CopyBody.md)| The targetParentId and, optionally, a new name. |
198198
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
199199
**fields** | [**[String]**](String.md)| A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
@@ -452,7 +452,7 @@ this.alfrescoJsApi.core.nodesApi.getNode(nodeId, , opts).then(function(data) {
452452

453453
Name | Type | Description | Notes
454454
------------- | ------------- | ------------- | -------------
455-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
455+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
456456
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
457457
**relativePath** | **String**| If specified, returns information on the node resolved by this path. The path is relative to the specified **nodeId** | [optional]
458458
**fields** | [**[String]**](String.md)| A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
@@ -545,7 +545,7 @@ this.alfrescoJsApi.core.nodesApi.getNodeChildren(nodeId, , opts).then(function(d
545545

546546
Name | Type | Description | Notes
547547
------------- | ------------- | ------------- | -------------
548-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
548+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
549549
**skipCount** | **Integer**| The number of entities that exist in the collection before those included in this list. | [optional]
550550
**maxItems** | **Integer**| The maximum number of items to return in the list. | [optional]
551551
**orderBy** | **String**| If not specified then default sort is for folders to be sorted before files, and by ascending name i.e. "orderBy=isFolder DESC,name ASC". This default can be completely overridden by specifying a specific orderBy consisting of one, two or three comma-separated list of properties (with optional ASCending or DESCending), for example, specifying “CorderBy=name DESC“D would return a mixed folder/file list. The following properties can be used to order the results: * isFolder * name * mimeType * nodeType * sizeInBytes * modifiedAt * createdAt * modifiedByUser * createdByUser | [optional]
@@ -616,7 +616,7 @@ this.alfrescoJsApi.core.nodesApi.moveNode(nodeId, moveBody, opts).then(function(
616616

617617
Name | Type | Description | Notes
618618
------------- | ------------- | ------------- | -------------
619-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
619+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
620620
**moveBody** | [**MoveBody**](MoveBody.md)| The targetParentId and, optionally, a new name. |
621621
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
622622
**fields** | [**[String]**](String.md)| A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]
@@ -835,7 +835,7 @@ this.alfrescoJsApi.core.nodesApi.updateNode(nodeId, nodeBody, opts).then(functio
835835

836836
Name | Type | Description | Notes
837837
------------- | ------------- | ------------- | -------------
838-
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: *-my-*-shared-*-root- |
838+
**nodeId** | **String**| The identifier of a node. You can also use one of these well-known aliases: -my- , -shared- or -root- |
839839
**nodeBody** | [**NodeBody**](NodeBody.md)| The node information to update. |
840840
**include** | [**[String]**](String.md)| Returns additional information about the node. The following optional fields can be requested: * path * isLink * allowableOperations | [optional]
841841
**fields** | [**[String]**](String.md)| A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. | [optional]

0 commit comments

Comments
 (0)