Commit 156f7d6ae74d6172f80e94c164948ffc4daf3c06

Authored by Chantsova Ekaterina
1 parent 74dd5fbb

Correct mistakes in descriptions

... ... @@ -362,7 +362,7 @@ export const serviceCompletions: TbEditorCompletions = {
362 362 type: '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/core/http/asset.service.ts#L29">AssetService</a>',
363 363 children: {
364 364 getTenantAssetInfos: {
365   - description: 'Get tenant asset',
  365 + description: 'Get tenant assets',
366 366 meta: 'function',
367 367 args: [
368 368 pageLinkArg,
... ... @@ -530,7 +530,7 @@ export const serviceCompletions: TbEditorCompletions = {
530 530 description: 'Get entity view info by id',
531 531 meta: 'function',
532 532 args: [
533   - {name: 'entityViewId', type: 'string', description: 'Id of the entities view'},
  533 + {name: 'entityViewId', type: 'string', description: 'Id of the entity view'},
534 534 requestConfigArg
535 535 ],
536 536 return: observableReturnType(entityViewInfoHref)
... ... @@ -575,7 +575,7 @@ export const serviceCompletions: TbEditorCompletions = {
575 575 meta: 'function',
576 576 args: [
577 577 {name: 'customerId', type: 'string', description: 'Id of the customer'},
578   - {name: 'entityViewId', type: 'string', description: 'Id of the entity viewId'},
  578 + {name: 'entityViewId', type: 'string', description: 'Id of the entity view'},
579 579 requestConfigArg
580 580 ],
581 581 return: observableReturnType(entityViewHref)
... ... @@ -596,7 +596,7 @@ export const serviceCompletions: TbEditorCompletions = {
596 596 {
597 597 name: 'query',
598 598 type: '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/shared/models/asset.models.ts#L37">AssetSearchQuery</a>',
599   - description: 'Asset search query object'
  599 + description: 'Entity view search query object'
600 600 },
601 601 requestConfigArg
602 602 ],
... ... @@ -655,7 +655,7 @@ export const serviceCompletions: TbEditorCompletions = {
655 655 type: '<a href="https://github.com/thingsboard/thingsboard/blob/13e6b10b7ab830e64d31b99614a9d95a1a25928a/ui-ngx/src/app/core/http/dashboard.service.ts#L32">DashboardService</a>',
656 656 children: {
657 657 getTenantDashboards: {
658   - description: 'Get tenant dashboard',
  658 + description: 'Get tenant dashboards',
659 659 meta: 'function',
660 660 args: [
661 661 pageLinkArg,
... ... @@ -664,7 +664,7 @@ export const serviceCompletions: TbEditorCompletions = {
664 664 return: observablePageDataReturnType(dashboardInfoHref)
665 665 },
666 666 getTenantDashboardsByTenantId: {
667   - description: 'Get tenant dashboards by id',
  667 + description: 'Get dashboards by tenant id',
668 668 meta: 'function',
669 669 args: [
670 670 {name: 'tenantId', type: 'string', description: 'Id of the tenant'},
... ... @@ -673,7 +673,7 @@ export const serviceCompletions: TbEditorCompletions = {
673 673 return: observablePageDataReturnType(dashboardInfoHref)
674 674 },
675 675 getCustomerDashboards: {
676   - description: 'Get customer dashboard by id',
  676 + description: 'Get dashboards by customer id',
677 677 meta: 'function',
678 678 args: [
679 679 {name: 'customerId', type: 'string', description: 'Id of the customer'},
... ... @@ -713,7 +713,7 @@ export const serviceCompletions: TbEditorCompletions = {
713 713 description: 'Delete dashboard by id',
714 714 meta: 'function',
715 715 args: [
716   - {name: 'dashboardId', type: 'string', description: 'Id of the entity view'},
  716 + {name: 'dashboardId', type: 'string', description: 'Id of the dashboard'},
717 717 requestConfigArg
718 718 ],
719 719 return: observableVoid()
... ... @@ -757,7 +757,7 @@ export const serviceCompletions: TbEditorCompletions = {
757 757 return: observableReturnType(dashboardHref)
758 758 },
759 759 updateDashboardCustomers: {
760   - description: 'Update dashboard by id',
  760 + description: 'Update customers assigned to dashboard by ids',
761 761 meta: 'function',
762 762 args: [
763 763 {name: 'dashboardId', type: 'string', description: 'Id of the dashboard'},
... ... @@ -767,7 +767,7 @@ export const serviceCompletions: TbEditorCompletions = {
767 767 return: observableReturnType(dashboardHref)
768 768 },
769 769 addDashboardCustomers: {
770   - description: 'Add dashboard customers by ids',
  770 + description: 'Assign (Add) customers to dashboard by ids',
771 771 meta: 'function',
772 772 args: [
773 773 {name: 'dashboardId', type: 'string', description: 'Id of the dashboard'},
... ... @@ -777,7 +777,7 @@ export const serviceCompletions: TbEditorCompletions = {
777 777 return: observableReturnType(dashboardHref)
778 778 },
779 779 removeDashboardCustomers: {
780   - description: 'Remove dashboard customers dy ids',
  780 + description: 'Unassign (Remove) customers from dashboard by ids',
781 781 meta: 'function',
782 782 args: [
783 783 {name: 'dashboardId', type: 'string', description: 'Id of the dashboard'},
... ... @@ -798,7 +798,7 @@ export const serviceCompletions: TbEditorCompletions = {
798 798 }
799 799 },
800 800 getServerTimeDiff: {
801   - description: 'remove dashboard customers ',
  801 + description: 'Get time difference',
802 802 meta: 'function',
803 803 args: [
804 804 ],
... ... @@ -822,7 +822,7 @@ export const serviceCompletions: TbEditorCompletions = {
822 822 return: observablePageDataReturnType(userHref)
823 823 },
824 824 getTenantAdmins: {
825   - description: 'Get tenant admins by id',
  825 + description: 'Get tenant admins by id',
826 826 meta: 'function',
827 827 args: [
828 828 {name: 'tenantId', type: 'string', description: 'Id of the tenant'},
... ... @@ -832,10 +832,10 @@ export const serviceCompletions: TbEditorCompletions = {
832 832 return: observablePageDataReturnType(userHref)
833 833 },
834 834 getCustomerUsers: {
835   - description: 'Get customer users by id',
  835 + description: 'Get customer users by id',
836 836 meta: 'function',
837 837 args: [
838   - {name: 'customerId', type: 'string', description: 'id of the customer'},
  838 + {name: 'customerId', type: 'string', description: 'Id of the customer'},
839 839 pageLinkArg,
840 840 requestConfigArg
841 841 ],
... ... @@ -845,7 +845,7 @@ export const serviceCompletions: TbEditorCompletions = {
845 845 description: 'Get user by id',
846 846 meta: 'function',
847 847 args: [
848   - {name: 'userId', type: 'string', description: 'id of the user'},
  848 + {name: 'userId', type: 'string', description: 'Id of the user'},
849 849 requestConfigArg
850 850 ],
851 851 return: observableReturnType(userHref)
... ... @@ -928,7 +928,7 @@ export const serviceCompletions: TbEditorCompletions = {
928 928 description: 'Delete relations by entity id',
929 929 meta: 'function',
930 930 args: [
931   - {name: 'entityId', type: entityIdHref, description: 'Id to the entity'},
  931 + {name: 'entityId', type: entityIdHref, description: 'Entity Id'},
932 932 {name: 'relationType', type: 'string', description: 'Relation type'},
933 933 requestConfigArg
934 934 ],
... ... @@ -1005,7 +1005,7 @@ export const serviceCompletions: TbEditorCompletions = {
1005 1005 description: 'Find by query',
1006 1006 meta: 'function',
1007 1007 args: [
1008   - {name: 'query', type: entityRelationsQueryHref, description: 'Query'},
  1008 + {name: 'query', type: entityRelationsQueryHref, description: 'Entity relations query'},
1009 1009 requestConfigArg
1010 1010 ],
1011 1011 return: observableArrayReturnType(entityRelationHref)
... ... @@ -1014,7 +1014,7 @@ export const serviceCompletions: TbEditorCompletions = {
1014 1014 description: 'Find info by query',
1015 1015 meta: 'function',
1016 1016 args: [
1017   - {name: 'query', type: entityRelationsQueryHref, description: 'Query'},
  1017 + {name: 'query', type: entityRelationsQueryHref, description: 'Entity relations query'},
1018 1018 requestConfigArg
1019 1019 ],
1020 1020 return: observableArrayReturnType(entityRelationInfoHref)
... ... @@ -1032,7 +1032,7 @@ export const serviceCompletions: TbEditorCompletions = {
1032 1032 meta: 'function',
1033 1033 args: [
1034 1034 {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
1035   - {name: 'attributeScope', type: attributeScopeHref, description: 'Atribute scope'},
  1035 + {name: 'attributeScope', type: attributeScopeHref, description: 'Attribute scope'},
1036 1036 {name: 'keys', type: `Array&lt;string&gt;`, description: 'Array of the keys'},
1037 1037 requestConfigArg
1038 1038 ],
... ... @@ -1043,7 +1043,7 @@ export const serviceCompletions: TbEditorCompletions = {
1043 1043 meta: 'function',
1044 1044 args: [
1045 1045 {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
1046   - {name: 'attributeScope', type: attributeScopeHref, description: 'Atribute scope'},
  1046 + {name: 'attributeScope', type: attributeScopeHref, description: 'Attribute scope'},
1047 1047 {name: 'attributes', type: `array&lt;${attributeDataHref}&gt;`, description: 'Array of the attributes'},
1048 1048 requestConfigArg
1049 1049 ],
... ... @@ -1115,7 +1115,7 @@ export const serviceCompletions: TbEditorCompletions = {
1115 1115 meta: 'function',
1116 1116 args: [
1117 1117 {name: 'entityType', type: entityTypeHref, description: 'Entity type'},
1118   - {name: 'entityNameFilter', type: 'string', description: 'Name filter of the entity'},
  1118 + {name: 'entityNameFilter', type: 'string', description: 'Name filter for the entity'},
1119 1119 {name: 'pageSize', type: 'number', description: 'Size of the page'},
1120 1120 {name: 'subType', type: 'string', optional: true, description: 'Subtype'},
1121 1121 requestConfigArg
... ... @@ -1126,8 +1126,7 @@ export const serviceCompletions: TbEditorCompletions = {
1126 1126 description: 'Find entity data by query',
1127 1127 meta: 'function',
1128 1128 args: [
1129   - {name: 'query', type: entityDataQueryHref, description: 'Query'},
1130   -
  1129 + {name: 'query', type: entityDataQueryHref, description: 'Entity data query'},
1131 1130 requestConfigArg
1132 1131 ],
1133 1132 return: observablePageDataReturnType(entityDataHref)
... ... @@ -1136,7 +1135,7 @@ export const serviceCompletions: TbEditorCompletions = {
1136 1135 description: 'Find alarm data by query',
1137 1136 meta: 'function',
1138 1137 args: [
1139   - {name: 'query', type: alarmDataQueryHref, description: 'Query'},
  1138 + {name: 'query', type: alarmDataQueryHref, description: 'Alarm data query'},
1140 1139 requestConfigArg
1141 1140 ],
1142 1141 return: observablePageDataReturnType(alarmDataHref)
... ... @@ -1145,24 +1144,24 @@ export const serviceCompletions: TbEditorCompletions = {
1145 1144 description: 'Find entity infos by filter and name',
1146 1145 meta: 'function',
1147 1146 args: [
1148   - {name: 'filter', type: entityFilterHref, description: 'Filter of the entity'},
  1147 + {name: 'filter', type: entityFilterHref, description: 'Filter for the entities'},
1149 1148 {name: 'searchText', type: 'string', description: 'Search text'},
1150 1149 requestConfigArg
1151 1150 ],
1152 1151 return: observablePageDataReturnType(entityInfoHref)
1153 1152 },
1154 1153 findSingleEntityInfoByEntityFilter: {
1155   - description: 'Find single entity infos by filter of the entity ',
  1154 + description: 'Find single entity infos by filter',
1156 1155 meta: 'function',
1157 1156 args: [
1158   - {name: 'filter', type: entityFilterHref, description: 'Filter of the entity'},
1159   - {name: 'searchText', type: 'string', description: 'search text'},
  1157 + {name: 'filter', type: entityFilterHref, description: 'Filter for the entity'},
  1158 + {name: 'searchText', type: 'string', description: 'Search text'},
1160 1159 requestConfigArg
1161 1160 ],
1162 1161 return: observableReturnType(entityInfoHref)
1163 1162 },
1164 1163 getAliasFilterTypesByEntityTypes: {
1165   - description: 'Get alias filter types by entity type',
  1164 + description: 'Get alias filter types by entity types',
1166 1165 meta: 'function',
1167 1166 args: [
1168 1167 {name: 'entityTypes', type: `Array&lt;${entityTypeHref}|${aliasEntityTypeHref}&gt;`, description: 'Entity types'},
... ... @@ -1174,7 +1173,7 @@ export const serviceCompletions: TbEditorCompletions = {
1174 1173 }
1175 1174 },
1176 1175 filterAliasByEntityTypes: {
1177   - description: 'Filter alias by entity type',
  1176 + description: 'Filter alias by entity types',
1178 1177 meta: 'function',
1179 1178 args: [
1180 1179 {name: 'entityAlias', type: entityAliasHref, description: 'Alias of the entity'},
... ... @@ -1186,7 +1185,7 @@ export const serviceCompletions: TbEditorCompletions = {
1186 1185 }
1187 1186 },
1188 1187 prepareAllowedEntityTypesList: {
1189   - description: 'Prepare allowed types of the entity list',
  1188 + description: 'Prepare allowed entity types list',
1190 1189 meta: 'function',
1191 1190 args: [
1192 1191 {name: 'allowedEntityTypes', type: `Array&lt;${entityTypeHref}|${aliasEntityTypeHref}&gt;`, description: 'Entity types'},
... ... @@ -1201,19 +1200,18 @@ export const serviceCompletions: TbEditorCompletions = {
1201 1200 description: 'Get entity keys by id',
1202 1201 meta: 'function',
1203 1202 args: [
1204   - {name: 'entityId', type: entityIdHref, description: 'id of the entity'},
1205   - {name: 'query', type: 'string', description: 'Query'},
1206   - {name: 'type', type: dataKeyTypeHref, description: 'Query'},
  1203 + {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
  1204 + {name: 'query', type: 'string', description: 'Key name starts with'},
  1205 + {name: 'type', type: dataKeyTypeHref, description: 'Datakey type'},
1207 1206 requestConfigArg
1208 1207 ],
1209 1208 return: {
1210 1209 type: `Observable&lt;Array&lt;string&gt;&gt;`,
1211   - description: `An <code>Observable</code> of <code>string</code> variable.`
  1210 + description: `An <code>Observable</code> of array of <code>string</code> variables.`
1212 1211 }
1213   - // observableArrayReturnType('string')
1214 1212 },
1215 1213 createDatasourcesFromSubscriptionsInfo: {
1216   - description: 'Create database from subscriptions info',
  1214 + description: 'Create datasources from subscriptions info',
1217 1215 meta: 'function',
1218 1216 args: [
1219 1217 {name: 'subscriptionsInfo', type: 'array<subscriptionInfoHref>', description: 'Subscriptions info'}
... ... @@ -1238,7 +1236,7 @@ export const serviceCompletions: TbEditorCompletions = {
1238 1236 description: 'Resolve alias',
1239 1237 meta: 'function',
1240 1238 args: [
1241   - {name: 'entityAlias', type: entityAliasHref, description: 'Alias of the entity'},
  1239 + {name: 'entityAlias', type: entityAliasHref, description: 'Entity alias'},
1242 1240 {name: 'stateParams', type: stateParamsHref, description: 'State params'},
1243 1241 ],
1244 1242 return: observableReturnType(aliasInfoHref)
... ... @@ -1256,17 +1254,16 @@ export const serviceCompletions: TbEditorCompletions = {
1256 1254 description: 'Check entity alias',
1257 1255 meta: 'function',
1258 1256 args: [
1259   - {name: 'entityAlias', type: entityAliasHref, description: 'Alias of the entity'},
  1257 + {name: 'entityAlias', type: entityAliasHref, description: 'Entity alias'},
1260 1258 ],
1261 1259 return: observableReturnTypeVariable('boolean')
1262   - // observableReturnType('boolean')
1263 1260 },
1264 1261 saveEntityParameters: {
1265 1262 description: 'Save entity parameters',
1266 1263 meta: 'function',
1267 1264 args: [
1268 1265 {name: 'entityType', type: entityTypeHref, description: 'Entity type'},
1269   - {name: 'entityData', type: importEntityDataHref, description: 'Data of the entity'},
  1266 + {name: 'entityData', type: importEntityDataHref, description: 'Entity data'},
1270 1267 {name: 'update', type: 'boolean', description: 'Update'},
1271 1268 requestConfigArg
1272 1269 ],
... ... @@ -1277,12 +1274,10 @@ export const serviceCompletions: TbEditorCompletions = {
1277 1274 meta: 'function',
1278 1275 args: [
1279 1276 {name: 'entityId', type: entityIdHref, description: 'Id of the entity'},
1280   - {name: 'entityData', type: importEntityDataHref, description: 'Data of the entity'},
  1277 + {name: 'entityData', type: importEntityDataHref, description: 'Entity data'},
1281 1278 requestConfigArg
1282 1279 ],
1283 1280 return: observableReturnTypeVariable('any')
1284   -
1285   - // observableReturnType('any')
1286 1281 },
1287 1282 }
1288 1283 },
... ...