mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[PRODENG-211] integrate JS-API with monorepo (part 1) (#9081)
* integrate JS-API with monorepo * [ci:force] fix token issue [ci:force] migrate docs folder [ci:force] clean personal tokens * [ci:force] gha workflow support * [ci:force] npm publish target * fix js-api test linting * [ci:force] fix test linting, mocks, https scheme * [ci:force] fix https scheme * [ci:force] typescript mappings * [ci:force] update scripts * lint fixes * linting fixes * fix linting * [ci:force] linting fixes * linting fixes * [ci:force] remove js-api upstream and corresponding scripts * [ci:force] jsdoc fixes * fix jsdoc linting * [ci:force] jsdoc fixes * [ci:force] jsdoc fixes * jsdoc fixes * jsdoc fixes * jsdoc fixes * [ci:force] fix jsdoc * [ci:force] reduce code duplication * replace 'chai' expect with node.js assert * replace 'chai' expect with node.js assert * [ci:force] remove chai and chai-spies for js-api testing * [ci:force] cleanup and fix imports * [ci:force] fix linting * [ci:force] fix unit test * [ci:force] fix sonar linting findings * [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle) * [ci:force] switch activiti api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch search api models to interfaces * [ci:force] switch content api models to interfaces where applicable
This commit is contained in:
Denys Vuika
GitHub
158
lib/js-api/src/api/content-rest-api/docs/NetworksApi.md
Normal file
158
lib/js-api/src/api/content-rest-api/docs/NetworksApi.md
Normal file
@@ -0,0 +1,158 @@
|
||||
# NetworksApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
|-------------------------------------------------|-------------------------------------------------|-------------------------|
|
||||
| [getNetwork](#getNetwork) | **GET** /networks/{networkId} | Get a network |
|
||||
| [getNetworkForPerson](#getNetworkForPerson) | **GET** /people/{personId}/networks/{networkId} | Get network information |
|
||||
| [listNetworksForPerson](#listNetworksForPerson) | **GET** /people/{personId}/networks | List network membership |
|
||||
|
||||
## getNetwork
|
||||
|
||||
Get a network
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|---------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **networkId** | string | The identifier of a network. |
|
||||
| opts.fields | string[] | 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. |
|
||||
|
||||
**Return type**: [PersonNetworkEntry](#PersonNetworkEntry)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, NetworksApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*..*/);
|
||||
const networksApi = new NetworksApi(alfrescoApi);
|
||||
const opts = {};
|
||||
|
||||
networksApi.getNetwork(`<networkId>`, opts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
## getNetworkForPerson
|
||||
|
||||
Get network information
|
||||
|
||||
You can use the `-me-` string in place of <personId> to specify the currently authenticated user.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
|---------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **personId** | string | The identifier of a person. |
|
||||
| **networkId** | string | The identifier of a network. |
|
||||
| fields | string[] | 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. |
|
||||
|
||||
**Return type**: [PersonNetworkEntry](#PersonNetworkEntry)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, NetworksApi} from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*..*/);
|
||||
const networksApi = new NetworksApi(alfrescoApi);
|
||||
|
||||
const opts = {};
|
||||
|
||||
networksApi.getNetworkForPerson(`<personId>`, `<networkId>`, opts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
## listNetworksForPerson
|
||||
|
||||
List network membership
|
||||
|
||||
You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|
|
||||
| **personId** | string | The identifier of a person. |
|
||||
| opts.skipCount | number | The number of entities that exist in the collection before those included in this list. If not supplied then the default value is 0. | default to 0 |
|
||||
| opts.maxItems | number | The maximum number of items to return in the list. If not supplied then the default value is 100. | default to 100 |
|
||||
| opts.fields | string[] | 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. | |
|
||||
|
||||
**Return type**: [PersonNetworkPaging](#PersonNetworkPaging)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, NetworksApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*..*/);
|
||||
const networksApi = new NetworksApi(alfrescoApi);
|
||||
|
||||
const opts = {};
|
||||
|
||||
networksApi.listNetworksForPerson(`<personId>`, opts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# Models
|
||||
|
||||
## PersonNetworkEntry
|
||||
|
||||
**Properties**
|
||||
|
||||
| Name | Type |
|
||||
|-------|---------------------------------|
|
||||
| entry | [PersonNetwork](#PersonNetwork) |
|
||||
|
||||
## PersonNetworkPaging
|
||||
|
||||
**Properties**
|
||||
|
||||
| Name | Type |
|
||||
|------|-----------------------------------------------------|
|
||||
| list | [PersonNetworkPagingList](#PersonNetworkPagingList) |
|
||||
|
||||
|
||||
## PersonNetworkPagingList
|
||||
|
||||
**Properties**
|
||||
|
||||
| Name | Type |
|
||||
|------------|---------------------------------------------|
|
||||
| pagination | [Pagination](Pagination.md) |
|
||||
| entries | [PersonNetworkEntry[]](#PersonNetworkEntry) |
|
||||
|
||||
|
||||
## PersonNetwork
|
||||
|
||||
**Properties**
|
||||
|
||||
| Name | Type | Description |
|
||||
|-------------------|---------------------------------|---------------------------|
|
||||
| **id** | string | This network's unique id |
|
||||
| homeNetwork | boolean | Is this the home network? |
|
||||
| **isEnabled** | boolean | |
|
||||
| createdAt | Date | |
|
||||
| paidNetwork | boolean | |
|
||||
| subscriptionLevel | string | |
|
||||
| quotas | [NetworkQuota[]](#NetworkQuota) | |
|
||||
|
||||
### PersonNetwork.SubscriptionLevelEnum
|
||||
|
||||
* `Free` (value: `'Free'`)
|
||||
* `Standard` (value: `'Standard'`)
|
||||
* `Enterprise` (value: `'Enterprise'`)
|
||||
|
||||
## NetworkQuota
|
||||
|
||||
**Properties**
|
||||
|
||||
| Name | Type |
|
||||
|-----------|--------|
|
||||
| **id** | string |
|
||||
| **limit** | number |
|
||||
| **usage** | number |
|
||||
Reference in New Issue
Block a user