dendi-wang/thingsboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #3366 from ChantsovaEkaterina/improvement/service-completion

Browse Source 
Improvement/service completion - services arguments and descriptions correction
This commit is contained in:
Igor Kulikov 2020-08-26 09:54:46 +03:00 committed by GitHub
commit d166be02ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 133 additions and 142 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
ui-ngx/src/app/shared/models/ace/service-completion.models.ts
View File

@ -32,7 +32,7 @@ export const pageDataHref = '<a href="https://github.com/thingsboard/thingsboard
export const deviceInfoHref = '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/shared/models/device.models.ts#L33">DeviceInfo</a>'; export const deviceInfoHref = '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/shared/models/device.models.ts#L33">DeviceInfo</a>';
export const assetInfoHref = '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/shared/models/asset.models.ts#L32">AssetInfo</a>' export const assetInfoHref = '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/shared/models/asset.models.ts#L32">AssetInfo</a>';
export const entityViewInfoHref = '<a href = "https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/shared/models/entity-view.models.ts#L47">EntityViewInfo</a>'; export const entityViewInfoHref = '<a href = "https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/shared/models/entity-view.models.ts#L47">EntityViewInfo</a>';
@ -84,15 +84,15 @@ export const stateParamsHref = '<a href="https://github.com/thingsboard/thingsbo
export const aliasInfoHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/core/api/widget-api.models.ts#L88">Alias info</a>'; export const aliasInfoHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/core/api/widget-api.models.ts#L88">Alias info</a>';
export const entityAliasFilterHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/shared/models/alias.models.ts#L134">Entity alias filter</a>' export const entityAliasFilterHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/shared/models/alias.models.ts#L134">Entity alias filter</a>';
export const entityAliasFilterResultHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/shared/models/alias.models.ts#L158">Entity alias filter result</a>' export const entityAliasFilterResultHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/shared/models/alias.models.ts#L158">Entity alias filter result</a>';
export const importEntityDataHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/shared/models/entity.models.ts#L28">Import entity data</a>' export const importEntityDataHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/shared/models/entity.models.ts#L28">Import entity data</a>';
export const importEntitiesResultInfoHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/shared/models/entity.models.ts#L42">Import entities result info</a>' export const importEntitiesResultInfoHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/shared/models/entity.models.ts#L42">Import entities result info</a>';
export const customDialogComponentHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/modules/home/components/widget/dialog/custom-dialog.component.ts#L48">CustomDialogComponent</a>' export const customDialogComponentHref = '<a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/modules/home/components/widget/dialog/custom-dialog.component.ts#L48">CustomDialogComponent</a>';
export const pageLinkArg: FunctionArg = { export const pageLinkArg: FunctionArg = {
name: 'pageLink', name: 'pageLink',
@ -135,21 +135,20 @@ export function observableArrayReturnType(objectType: string): FunctionArgType {
}; };
} }
export function observableBaseDataReturnType(objectType: string): FunctionArgType { export function observableBaseDataReturnType(): FunctionArgType {
return { return {
type: `Observable&lt;${baseDataHref}&lt;${objectType}&gt;&gt;`, type: `Observable&lt;${baseDataHref}&lt;${entityIdHref}&gt;&gt;`,
description: `An <code>Observable</code> of page result as a <code>${baseDataHref}</code> holding array of <code>${objectType}</code> objects.` description: `An <code>Observable</code> of <code>${baseDataHref}</code> object.`
}; };
} }
export function observableArrayBaseDataReturnType(objectType: string): FunctionArgType { export function observableArrayBaseDataReturnType(): FunctionArgType {
return { return {
type: `Observable&lt;Array&lt;${baseDataHref}&lt;${objectType}&gt;&gt;&gt;`, type: `Observable&lt;Array&lt;${baseDataHref}&lt;${entityIdHref}&gt;&gt;&gt;`,
description: `An <code>Observable</code> of page result as a <code>${baseDataHref}</code> holding array of <code>${objectType}</code> objects.` description: `An <code>Observable</code> of array of <code>${baseDataHref}</code> objects.`
}; };
} }
export function observablePageDataReturnType(objectType: string): FunctionArgType { export function observablePageDataReturnType(objectType: string): FunctionArgType {
return { return {
type: `Observable&lt;${pageDataHref}&lt;${objectType}&gt;&gt;`, type: `Observable&lt;${pageDataHref}&lt;${objectType}&gt;&gt;`,
@ -157,8 +156,6 @@ export function observablePageDataReturnType(objectType: string): FunctionArgTyp
}; };
} }
export const serviceCompletions: TbEditorCompletions = { export const serviceCompletions: TbEditorCompletions = {
deviceService: { deviceService: {
description: 'Device Service API<br>' + description: 'Device Service API<br>' +
@ -362,7 +359,7 @@ export const serviceCompletions: TbEditorCompletions = {
type: '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/core/http/asset.service.ts#L29">AssetService</a>', type: '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/core/http/asset.service.ts#L29">AssetService</a>',
children: { children: {
getTenantAssetInfos: { getTenantAssetInfos: {
description: 'Get tenant asset', description: 'Get tenant assets',
meta: 'function', meta: 'function',
args: [ args: [
pageLinkArg, pageLinkArg,
@ -530,7 +527,7 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Get entity view info by id', description: 'Get entity view info by id',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityViewId', type: 'string', description: 'Id of the entities view'}, {name: 'entityViewId', type: 'string', description: 'Id of the entity view'},
requestConfigArg requestConfigArg
], ],
return: observableReturnType(entityViewInfoHref) return: observableReturnType(entityViewInfoHref)
@ -575,7 +572,7 @@ export const serviceCompletions: TbEditorCompletions = {
meta: 'function', meta: 'function',
args: [ args: [
{name: 'customerId', type: 'string', description: 'Id of the customer'}, {name: 'customerId', type: 'string', description: 'Id of the customer'},
{name: 'entityViewId', type: 'string', description: 'Id of the entity viewId'}, {name: 'entityViewId', type: 'string', description: 'Id of the entity view'},
requestConfigArg requestConfigArg
], ],
return: observableReturnType(entityViewHref) return: observableReturnType(entityViewHref)
@ -596,7 +593,7 @@ export const serviceCompletions: TbEditorCompletions = {
{ {
name: 'query', name: 'query',
type: '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/shared/models/asset.models.ts#L37">AssetSearchQuery</a>', type: '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/shared/models/asset.models.ts#L37">AssetSearchQuery</a>',
description: 'Asset search query object' description: 'Entity view search query object'
}, },
requestConfigArg requestConfigArg
], ],
@ -655,7 +652,7 @@ export const serviceCompletions: TbEditorCompletions = {
type: '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/core/http/dashboard.service.ts#L32">DashboardService</a>', type: '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/core/http/dashboard.service.ts#L32">DashboardService</a>',
children: { children: {
getTenantDashboards: { getTenantDashboards: {
description: 'Get tenant dashboard', description: 'Get tenant dashboards',
meta: 'function', meta: 'function',
args: [ args: [
pageLinkArg, pageLinkArg,
@ -664,16 +661,17 @@ export const serviceCompletions: TbEditorCompletions = {
return: observablePageDataReturnType(dashboardInfoHref) return: observablePageDataReturnType(dashboardInfoHref)
}, },
getTenantDashboardsByTenantId: { getTenantDashboardsByTenantId: {
description: 'Get tenant dashboards by id', description: 'Get dashboards by tenant id',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'tenantId', type: 'string', description: 'Id of the tenant'}, {name: 'tenantId', type: 'string', description: 'Id of the tenant'},
pageLinkArg pageLinkArg,
requestConfigArg
], ],
return: observablePageDataReturnType(dashboardInfoHref) return: observablePageDataReturnType(dashboardInfoHref)
}, },
getCustomerDashboards: { getCustomerDashboards: {
description: 'Get customer dashboard by id', description: 'Get dashboards by customer id',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'customerId', type: 'string', description: 'Id of the customer'}, {name: 'customerId', type: 'string', description: 'Id of the customer'},
@ -713,7 +711,7 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Delete dashboard by id', description: 'Delete dashboard by id',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'dashboardId', type: 'string', description: 'Id of the entity view'}, {name: 'dashboardId', type: 'string', description: 'Id of the dashboard'},
requestConfigArg requestConfigArg
], ],
return: observableVoid() return: observableVoid()
@ -729,7 +727,7 @@ export const serviceCompletions: TbEditorCompletions = {
return: observableReturnType(dashboardHref) return: observableReturnType(dashboardHref)
}, },
unassignDashboardFromCustomer: { unassignDashboardFromCustomer: {
description: 'Unassign dashboard from any customer', description: 'Unassign dashboard from specific customer',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'customerId', type: 'string', description: 'Id of the customer'}, {name: 'customerId', type: 'string', description: 'Id of the customer'},
@ -757,7 +755,7 @@ export const serviceCompletions: TbEditorCompletions = {
return: observableReturnType(dashboardHref) return: observableReturnType(dashboardHref)
}, },
updateDashboardCustomers: { updateDashboardCustomers: {
description: 'Update dashboard by id', description: 'Update customers assigned to dashboard by ids',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'dashboardId', type: 'string', description: 'Id of the dashboard'}, {name: 'dashboardId', type: 'string', description: 'Id of the dashboard'},
@ -767,7 +765,7 @@ export const serviceCompletions: TbEditorCompletions = {
return: observableReturnType(dashboardHref) return: observableReturnType(dashboardHref)
}, },
addDashboardCustomers: { addDashboardCustomers: {
description: 'Add dashboard customers by ids', description: 'Assign (Add) customers to dashboard by ids',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'dashboardId', type: 'string', description: 'Id of the dashboard'}, {name: 'dashboardId', type: 'string', description: 'Id of the dashboard'},
@ -777,14 +775,14 @@ export const serviceCompletions: TbEditorCompletions = {
return: observableReturnType(dashboardHref) return: observableReturnType(dashboardHref)
}, },
removeDashboardCustomers: { removeDashboardCustomers: {
description: 'Remove dashboard customers dy ids', description: 'Unassign (Remove) customers from dashboard by ids',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'dashboardId', type: 'string', description: 'Id of the dashboard'}, {name: 'dashboardId', type: 'string', description: 'Id of the dashboard'},
{name: 'customerIds', type: `Array&lt;string&gt;`, description: 'Id of the customers'}, {name: 'customerIds', type: `Array&lt;string&gt;`, description: 'Id of the customers'},
requestConfigArg requestConfigArg
], ],
return: observableArrayReturnType(dashboardHref) return: observableReturnType(dashboardHref)
}, },
getPublicDashboardLink: { getPublicDashboardLink: {
description: 'Get public dashboard link', description: 'Get public dashboard link',
@ -798,7 +796,7 @@ export const serviceCompletions: TbEditorCompletions = {
} }
}, },
getServerTimeDiff: { getServerTimeDiff: {
description: 'remove dashboard customers ', description: 'Get time difference',
meta: 'function', meta: 'function',
args: [ args: [
], ],
@ -835,7 +833,7 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Get customer users by id', description: 'Get customer users by id',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'customerId', type: 'string', description: 'id of the customer'}, {name: 'customerId', type: 'string', description: 'Id of the customer'},
pageLinkArg, pageLinkArg,
requestConfigArg requestConfigArg
], ],
@ -845,7 +843,7 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Get user by id', description: 'Get user by id',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'userId', type: 'string', description: 'id of the user'}, {name: 'userId', type: 'string', description: 'Id of the user'},
requestConfigArg requestConfigArg
], ],
return: observableReturnType(userHref) return: observableReturnType(userHref)
@ -855,6 +853,7 @@ export const serviceCompletions: TbEditorCompletions = {
meta: 'function', meta: 'function',
args: [ args: [
{name: 'user', type: userHref, description: 'User object to save'}, {name: 'user', type: userHref, description: 'User object to save'},
{name: 'sendActivationMail', type: 'boolean', description: 'Send activation email', optional: true},
requestConfigArg requestConfigArg
], ],
return: observableReturnType(userHref) return: observableReturnType(userHref)
@ -876,7 +875,7 @@ export const serviceCompletions: TbEditorCompletions = {
{name: 'userCredentialsEnabled', type: 'boolean', description: 'User credentials enabled'}, {name: 'userCredentialsEnabled', type: 'boolean', description: 'User credentials enabled'},
requestConfigArg requestConfigArg
], ],
return: observableReturnType(userHref) return: observableReturnTypeVariable('any')
}, },
getActivationLink: { getActivationLink: {
description: 'Get activation link by id', description: 'Get activation link by id',
@ -928,8 +927,7 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Delete relations by entity id', description: 'Delete relations by entity id',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityId', type: entityIdHref, description: 'Id to the entity'}, {name: 'entityId', type: entityIdHref, description: 'Entity Id'},
{name: 'relationType', type: 'string', description: 'Relation type'},
requestConfigArg requestConfigArg
], ],
return: observableVoid() return: observableVoid()
@ -1005,7 +1003,7 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Find by query', description: 'Find by query',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'query', type: entityRelationsQueryHref, description: 'Query'}, {name: 'query', type: entityRelationsQueryHref, description: 'Entity relations query'},
requestConfigArg requestConfigArg
], ],
return: observableArrayReturnType(entityRelationHref) return: observableArrayReturnType(entityRelationHref)
@ -1014,7 +1012,7 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Find info by query', description: 'Find info by query',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'query', type: entityRelationsQueryHref, description: 'Query'}, {name: 'query', type: entityRelationsQueryHref, description: 'Entity relations query'},
requestConfigArg requestConfigArg
], ],
return: observableArrayReturnType(entityRelationInfoHref) return: observableArrayReturnType(entityRelationInfoHref)
@ -1032,7 +1030,7 @@ export const serviceCompletions: TbEditorCompletions = {
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityId', type: entityIdHref, description: 'Id of the entity'}, {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
{name: 'attributeScope', type: attributeScopeHref, description: 'Atribute scope'}, {name: 'attributeScope', type: attributeScopeHref, description: 'Attribute scope'},
{name: 'keys', type: `Array&lt;string&gt;`, description: 'Array of the keys'}, {name: 'keys', type: `Array&lt;string&gt;`, description: 'Array of the keys'},
requestConfigArg requestConfigArg
], ],
@ -1043,8 +1041,8 @@ export const serviceCompletions: TbEditorCompletions = {
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityId', type: entityIdHref, description: 'Id of the entity'}, {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
{name: 'attributeScope', type: attributeScopeHref, description: 'Atribute scope'}, {name: 'attributeScope', type: attributeScopeHref, description: 'Attribute scope'},
{name: 'attributes', type: `array&lt;${attributeDataHref}&gt;`, description: 'Array of the attributes'}, {name: 'attributes', type: `array&lt;${attributeDataHref}&gt;`, description: 'Array of the attributes data'},
requestConfigArg requestConfigArg
], ],
return: observableReturnTypeVariable('any') return: observableReturnTypeVariable('any')
@ -1054,7 +1052,7 @@ export const serviceCompletions: TbEditorCompletions = {
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityId', type: entityIdHref, description: 'Id of the entity'}, {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
{name: 'timeseries', type: `Array&lt;${attributeDataHref}&gt;>`, description: 'Array of the timeseries'}, {name: 'timeseries', type: `Array&lt;${attributeDataHref}&gt;>`, description: 'Array of the timeseries data'},
{name: 'deleteAllDataForKeys', type: 'boolean', optional: true, description: 'Delete all data for keys'}, {name: 'deleteAllDataForKeys', type: 'boolean', optional: true, description: 'Delete all data for keys'},
requestConfigArg requestConfigArg
], ],
@ -1066,7 +1064,7 @@ export const serviceCompletions: TbEditorCompletions = {
args: [ args: [
{name: 'entityId', type: entityIdHref, description: 'Id of the entity'}, {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
{name: 'attributeScope', type: attributeScopeHref, description: 'Attribute scope'}, {name: 'attributeScope', type: attributeScopeHref, description: 'Attribute scope'},
{name: 'attributes', type: 'Array&lt;${attributeDataHref}&gt;>', description: 'Array of the attributes'}, {name: 'attributes', type: 'Array&lt;${attributeDataHref}&gt;>', description: 'Array of the attributes data'},
requestConfigArg requestConfigArg
], ],
return: observableReturnTypeVariable('any') return: observableReturnTypeVariable('any')
@ -1077,7 +1075,7 @@ export const serviceCompletions: TbEditorCompletions = {
args: [ args: [
{name: 'entityId', type: entityIdHref, description: 'Id of the entity'}, {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
{name: 'timeseriesScope', type: 'string', description: 'Timeseries scope'}, {name: 'timeseriesScope', type: 'string', description: 'Timeseries scope'},
{name: 'timeseries', type: `Array&lt;attributeDataHref&gt;`, description: 'Array of the timeseries'}, {name: 'timeseries', type: `Array&lt;attributeDataHref&gt;`, description: 'Array of the timeseries data'},
requestConfigArg requestConfigArg
], ],
return: observableReturnTypeVariable('any') return: observableReturnTypeVariable('any')
@ -1098,7 +1096,7 @@ export const serviceCompletions: TbEditorCompletions = {
{name: 'entityId', type: 'string', description: 'Id of the entity'}, {name: 'entityId', type: 'string', description: 'Id of the entity'},
requestConfigArg requestConfigArg
], ],
return:observableBaseDataReturnType(entityIdHref) return: observableBaseDataReturnType()
}, },
getEntities: { getEntities: {
description: 'Get entities by ids', description: 'Get entities by ids',
@ -1108,26 +1106,25 @@ export const serviceCompletions: TbEditorCompletions = {
{name: 'entityIds', type: `Array&lt;string&gt;`, description: 'Ids of the entities'}, {name: 'entityIds', type: `Array&lt;string&gt;`, description: 'Ids of the entities'},
requestConfigArg requestConfigArg
], ],
return:observableArrayBaseDataReturnType(entityIdHref) return: observableArrayBaseDataReturnType()
}, },
getEntitiesByNameFilter: { getEntitiesByNameFilter: {
description: 'Get entities by name filter', description: 'Get entities by name filter',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityType', type: entityTypeHref, description: 'Entity type'}, {name: 'entityType', type: entityTypeHref, description: 'Entity type'},
{name: 'entityNameFilter', type: 'string', description: 'Name filter of the entity'}, {name: 'entityNameFilter', type: 'string', description: 'Name filter for the entity'},
{name: 'pageSize', type: 'number', description: 'Size of the page'}, {name: 'pageSize', type: 'number', description: 'Size of the page'},
{name: 'subType', type: 'string', optional: true, description: 'Subtype'}, {name: 'subType', type: 'string', optional: true, description: 'Subtype'},
requestConfigArg requestConfigArg
], ],
return:observableArrayBaseDataReturnType(entityIdHref) return: observableArrayBaseDataReturnType()
}, },
findEntityDataByQuery: { findEntityDataByQuery: {
description: 'Find entity data by query', description: 'Find entity data by query',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'query', type: entityDataQueryHref, description: 'Query'}, {name: 'query', type: entityDataQueryHref, description: 'Entity data query'},
requestConfigArg requestConfigArg
], ],
return: observablePageDataReturnType(entityDataHref) return: observablePageDataReturnType(entityDataHref)
@ -1136,7 +1133,7 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Find alarm data by query', description: 'Find alarm data by query',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'query', type: alarmDataQueryHref, description: 'Query'}, {name: 'query', type: alarmDataQueryHref, description: 'Alarm data query'},
requestConfigArg requestConfigArg
], ],
return: observablePageDataReturnType(alarmDataHref) return: observablePageDataReturnType(alarmDataHref)
@ -1145,28 +1142,26 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Find entity infos by filter and name', description: 'Find entity infos by filter and name',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'filter', type: entityFilterHref, description: 'Filter of the entity'}, {name: 'filter', type: entityFilterHref, description: 'Filter for the entities'},
{name: 'searchText', type: 'string', description: 'Search text'}, {name: 'searchText', type: 'string', description: 'Search text'},
requestConfigArg requestConfigArg
], ],
return: observablePageDataReturnType(entityInfoHref) return: observablePageDataReturnType(entityInfoHref)
}, },
findSingleEntityInfoByEntityFilter: { findSingleEntityInfoByEntityFilter: {
description: 'Find single entity infos by filter of the entity ', description: 'Find single entity infos by filter',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'filter', type: entityFilterHref, description: 'Filter of the entity'}, {name: 'filter', type: entityFilterHref, description: 'Filter for the entity'},
{name: 'searchText', type: 'string', description: 'search text'},
requestConfigArg requestConfigArg
], ],
return: observableReturnType(entityInfoHref) return: observableReturnType(entityInfoHref)
}, },
getAliasFilterTypesByEntityTypes: { getAliasFilterTypesByEntityTypes: {
description: 'Get alias filter types by entity type', description: 'Get alias filter types by entity types',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityTypes', type:`Array&lt;${entityTypeHref}|${aliasEntityTypeHref}&gt;`, description: 'Entity types'}, {name: 'entityTypes', type: `Array&lt;${entityTypeHref}|${aliasEntityTypeHref}&gt;`, description: 'Entity types'}
{name: 'searchText', type: 'string', description: 'Search text'}
], ],
return: { return: {
type: `Array&lt;${aliasFilterTypeHref}$gt;`, type: `Array&lt;${aliasFilterTypeHref}$gt;`,
@ -1174,7 +1169,7 @@ export const serviceCompletions: TbEditorCompletions = {
} }
}, },
filterAliasByEntityTypes: { filterAliasByEntityTypes: {
description: 'Filter alias by entity type', description: 'Filter alias by entity types',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityAlias', type: entityAliasHref, description: 'Alias of the entity'}, {name: 'entityAlias', type: entityAliasHref, description: 'Alias of the entity'},
@ -1186,7 +1181,7 @@ export const serviceCompletions: TbEditorCompletions = {
} }
}, },
prepareAllowedEntityTypesList: { prepareAllowedEntityTypesList: {
description: 'Prepare allowed types of the entity list', description: 'Prepare allowed entity types list',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'allowedEntityTypes', type: `Array&lt;${entityTypeHref}|${aliasEntityTypeHref}&gt;`, description: 'Entity types'}, {name: 'allowedEntityTypes', type: `Array&lt;${entityTypeHref}|${aliasEntityTypeHref}&gt;`, description: 'Entity types'},
@ -1201,19 +1196,18 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Get entity keys by id', description: 'Get entity keys by id',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityId', type:entityIdHref, description: 'id of the entity'}, {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
{name: 'query', type:'string', description: 'Query'}, {name: 'query', type: 'string', description: 'Key name starts with'},
{name: 'type', type:dataKeyTypeHref, description: 'Query'}, {name: 'type', type: dataKeyTypeHref, description: 'Datakey type'},
requestConfigArg requestConfigArg
], ],
return: { return: {
type: `Observable&lt;Array&lt;string&gt;&gt;`, type: `Observable&lt;Array&lt;string&gt;&gt;`,
description:`An <code>Observable</code> of <code>string</code> variable.` description: `An <code>Observable</code> of array of <code>string</code> variables.`
} }
// observableArrayReturnType('string')
}, },
createDatasourcesFromSubscriptionsInfo: { createDatasourcesFromSubscriptionsInfo: {
description: 'Create database from subscriptions info', description: 'Create datasources from subscriptions info',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'subscriptionsInfo', type: 'array<subscriptionInfoHref>', description: 'Subscriptions info'} {name: 'subscriptionsInfo', type: 'array<subscriptionInfoHref>', description: 'Subscriptions info'}
@ -1238,7 +1232,7 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Resolve alias', description: 'Resolve alias',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityAlias', type:entityAliasHref, description: 'Alias of the entity'}, {name: 'entityAlias', type: entityAliasHref, description: 'Entity alias'},
{name: 'stateParams', type: stateParamsHref, description: 'State params'}, {name: 'stateParams', type: stateParamsHref, description: 'State params'},
], ],
return: observableReturnType(aliasInfoHref) return: observableReturnType(aliasInfoHref)
@ -1256,17 +1250,16 @@ export const serviceCompletions: TbEditorCompletions = {
description: 'Check entity alias', description: 'Check entity alias',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityAlias', type:entityAliasHref, description: 'Alias of the entity'}, {name: 'entityAlias', type: entityAliasHref, description: 'Entity alias'},
], ],
return: observableReturnTypeVariable('boolean') return: observableReturnTypeVariable('boolean')
// observableReturnType('boolean')
}, },
saveEntityParameters: { saveEntityParameters: {
description: 'Save entity parameters', description: 'Save entity parameters',
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityType', type: entityTypeHref, description: 'Entity type'}, {name: 'entityType', type: entityTypeHref, description: 'Entity type'},
{name: 'entityData', type:importEntityDataHref, description: 'Data of the entity'}, {name: 'entityData', type: importEntityDataHref, description: 'Entity data'},
{name: 'update', type: 'boolean', description: 'Update'}, {name: 'update', type: 'boolean', description: 'Update'},
requestConfigArg requestConfigArg
], ],
@ -1277,12 +1270,10 @@ export const serviceCompletions: TbEditorCompletions = {
meta: 'function', meta: 'function',
args: [ args: [
{name: 'entityId', type: entityIdHref, description: 'Id of the entity'}, {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
{name: 'entityData', type:importEntityDataHref, description: 'Data of the entity'}, {name: 'entityData', type: importEntityDataHref, description: 'Entity data'},
requestConfigArg requestConfigArg
], ],
return: observableReturnTypeVariable('any') return: observableReturnTypeVariable('any')
// observableReturnType('any')
}, },
} }
}, },
@ -1359,7 +1350,7 @@ export const serviceCompletions: TbEditorCompletions = {
args: [ args: [
{name: 'template', type: 'string', description: 'Template'}, {name: 'template', type: 'string', description: 'Template'},
{name: 'controller', type: customDialogComponentHref, description: 'Controller'}, {name: 'controller', type: customDialogComponentHref, description: 'Controller'},
{name: 'data', type:'any', description: 'Data'}, {name: 'data', type: 'any', description: 'Data', optional: true},
], ],
return: observableReturnTypeVariable('any') return: observableReturnTypeVariable('any')
}, },
@ -1389,4 +1380,4 @@ export const serviceCompletions: TbEditorCompletions = {
meta: 'service', meta: 'service',
type: '<a href="https://angular.io/api/platform-browser/DomSanitizer">DomSanitizer</a>' type: '<a href="https://angular.io/api/platform-browser/DomSanitizer">DomSanitizer</a>'
} }
} };