[ACS-5946] aps documentation enhancements

src/api/activiti-rest-api/api/systemProperties.api.ts

@@ -22,16 +22,16 @@ import { BaseApi } from './base.api';
 import { throwIfNotDefined } from '../../../assert';
 
 /**
-* SystemPropertiesApi service.
-* @module SystempropertiesApi
-*/
+ * SystemPropertiesApi service.
+ * @module SystemPropertiesApi
+ */
 export class SystemPropertiesApi extends BaseApi {
     /**
-    * Get global date format
-    *
-    * @param tenantId tenantId
-    * @return Promise<GlobalDateFormatRepresentation>
-    */
+     * Get global date format
+     *
+     * @param tenantId tenantId
+     * @return Promise<GlobalDateFormatRepresentation>
+     */
     getGlobalDateFormat(tenantId: number): Promise<GlobalDateFormatRepresentation> {
         throwIfNotDefined(tenantId, 'tenantId');
 
@@ -47,11 +47,11 @@ export class SystemPropertiesApi extends BaseApi {
     }
 
     /**
-    * Get password validation constraints
-    *
-    * @param tenantId tenantId
-    * @return Promise<PasswordValidationConstraints>
-    */
+     * Get password validation constraints
+     *
+     * @param tenantId tenantId
+     * @return Promise<PasswordValidationConstraints>
+     */
     getPasswordValidationConstraints(tenantId: number): Promise<PasswordValidationConstraints> {
         throwIfNotDefined(tenantId, 'tenantId');
 
@@ -67,12 +67,12 @@ export class SystemPropertiesApi extends BaseApi {
     }
 
     /**
-    * Retrieve system properties
-    *
-    * Typical value is AllowInvolveByEmail
-    *
-    * @return Promise<SystemPropertiesRepresentation>
-    */
+     * Retrieve system properties
+     *
+     * Typical value is AllowInvolveByEmail
+     *
+     * @return Promise<SystemPropertiesRepresentation>
+     */
     getProperties(): Promise<SystemPropertiesRepresentation> {
         return this.get({
             path: '/api/enterprise/system/properties',
@@ -81,11 +81,11 @@ export class SystemPropertiesApi extends BaseApi {
     }
 
     /**
-    * Get involved users who can edit forms
-    *
-    * @param tenantId tenantId
-    * @return Promise<boolean>
-    */
+     * Get involved users who can edit forms
+     *
+     * @param tenantId tenantId
+     * @return Promise<boolean>
+     */
     involvedUsersCanEditForms(tenantId: number): Promise<boolean> {
         throwIfNotDefined(tenantId, 'tenantId');
 
@@ -98,5 +98,4 @@ export class SystemPropertiesApi extends BaseApi {
             pathParams
         });
     }
-
 }

src/api/activiti-rest-api/docs/AboutApi.md

@@ -2,39 +2,29 @@
 
 All URIs are relative to */activiti-app/api*
 
-| Method                                         | HTTP request                    | Description                 |
-|------------------------------------------------|---------------------------------|-----------------------------|
-| [**getAppVersion**](AboutApi.md#getAppVersion) | **GET** /enterprise/app-version | Get server type and version |
+| Method                          | HTTP request                    | Description                 |
+|---------------------------------|---------------------------------|-----------------------------|
+| [getAppVersion](#getAppVersion) | **GET** /enterprise/app-version | Get server type and version |
 
 
-<a name="getAppVersion"></a>
-# **getAppVersion**
-> { [key: string]: string; } getAppVersion()
+# getAppVersion
 
 Get server type and version
 
-Provides information about the running Alfresco Process Services Suite. The response payload object has the properties type, majorVersion, minorVersion, revisionVersion and edition.
+Provides information about the running Alfresco Process Services Suite. 
+The response payload object has the properties type, majorVersion, minorVersion, revisionVersion and edition.
+
+**Return type**: **Map<string, string>**
 
 **Example**
 
 ```javascript
-import AboutApi from 'AboutApi';
-import { AlfrescoApi } from '@alfresco/js-api';
+import { AlfrescoApi, AboutApi } from '@alfresco/js-api';
 
-const alfrescoApi = new AlfrescoApi({
-    hostEcm: 'http://127.0.0.1:8080'
-});
-
-const aboutApi = new AboutApi(this.alfrescoApi);
+const alfrescoApi = new AlfrescoApi(/*..*/);
+const aboutApi = new AboutApi(alfrescoApi);
 
 aboutApi.getAppVersion().then((data) => {
   console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
 });
-
 ```
-
-
-**Return type**: **Map<string, string>**
-

src/api/activiti-rest-api/docs/AccountIntegrationApi.md

@@ -0,0 +1,56 @@
+# AccountIntegrationApi
+
+All URIs are relative to */activiti-app/api*
+
+| Method                      | HTTP request                            | Description                           |
+|-----------------------------|-----------------------------------------|---------------------------------------|
+| [getAccounts](#getAccounts) | **GET** /enterprise/account/integration | Retrieve external account information |
+
+# **getAccounts**
+
+Retrieve external account information
+
+Accounts are used to integrate with third party apps and clients
+
+**Return type**: [ResultListDataRepresentationAccountRepresentation](#ResultListDataRepresentationAccountRepresentation)
+
+**Example**
+
+```javascript
+import { AlfrescoApi, AccountIntegrationApi } from '@alfresco/js-api';
+
+const alfrescoApi = new AlfrescoApi(/*..*/);
+const accountIntegrationApi = new AccountIntegrationApi(alfrescoApi);
+
+accountIntegrationApi.getAccounts().then((data) => {
+    console.log('API called successfully. Returned data: ' + data);
+});
+```
+
+# Models
+
+## ResultListDataRepresentationAccountRepresentation
+
+**Properties**
+
+| Name  | Type                                              |
+|-------|---------------------------------------------------|
+| data  | [AccountRepresentation[]](#AccountRepresentation) |
+| size  | number                                            |
+| start | number                                            |
+| total | number                                            |
+
+
+## AccountRepresentation
+
+**Properties**
+
+| Name             | Type    |
+|------------------|---------|
+| authorizationUrl | string  |
+| authorized       | boolean |
+| metaDataAllowed  | boolean |
+| name             | string  |
+| serviceId        | string  |
+
+