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:
75
lib/js-api/src/api/activiti-rest-api/docs/DataSourcesApi.md
Normal file
75
lib/js-api/src/api/activiti-rest-api/docs/DataSourcesApi.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# DataSourcesApi
|
||||
|
||||
All URIs are relative to */activiti-app/api*
|
||||
|
||||
| Method | HTTP request | Description |
|
||||
|-----------------------------------|-----------------------------------------|------------------|
|
||||
| [getDataSources](#getDataSources) | **GET** /enterprise/editor/data-sources | Get data sources |
|
||||
|
||||
# getDataSources
|
||||
|
||||
Get data sources
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type |
|
||||
|----------|--------|
|
||||
| tenantId | number |
|
||||
|
||||
**Return type**: [ResultListDataRepresentationDataSourceRepresentation](#ResultListDataRepresentationDataSourceRepresentation)
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
import { AlfrescoApi, DataSourcesApi } from '@alfresco/js-api';
|
||||
|
||||
const alfrescoApi = new AlfrescoApi(/*..*/);
|
||||
const dataSourcesApi = new DataSourcesApi(alfrescoApi);
|
||||
|
||||
const opts = {
|
||||
tenantId: 789
|
||||
};
|
||||
|
||||
datasourcesApi.getDataSources(opts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
});
|
||||
```
|
||||
|
||||
# Models
|
||||
|
||||
## ResultListDataRepresentationDataSourceRepresentation
|
||||
|
||||
**Properties**
|
||||
|
||||
| Name | Type |
|
||||
|-------|---------------------------------------------------------|
|
||||
| data | [DataSourceRepresentation[]](#DataSourceRepresentation) |
|
||||
| size | number |
|
||||
| start | number |
|
||||
| total | number |
|
||||
|
||||
## DataSourceRepresentation
|
||||
|
||||
**Properties**
|
||||
|
||||
| Name | Type |
|
||||
|----------|-------------------------------------------------------------------|
|
||||
| config | [DataSourceConfigRepresentation](#DataSourceConfigRepresentation) |
|
||||
| id | number |
|
||||
| name | string |
|
||||
| tenantId | number |
|
||||
|
||||
## DataSourceConfigRepresentation
|
||||
|
||||
**Properties**
|
||||
|
||||
| Name | Type |
|
||||
|-------------|--------|
|
||||
| driverClass | string |
|
||||
| jdbcUrl | string |
|
||||
| password | string |
|
||||
| username | string |
|
||||
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user