diff --git a/ce/docs/AvailableEntityKeys.md b/ce/docs/AvailableEntityKeys.md index c672c797..27f004da 100644 --- a/ce/docs/AvailableEntityKeys.md +++ b/ce/docs/AvailableEntityKeys.md @@ -10,8 +10,8 @@ Contains unique time series and attribute key names discovered from entities mat | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | **entityTypes** | **Set\** | Set of entity types found among the matched entities. | | -| **timeseries** | **Set\** | | | -| **attribute** | **Set\** | | | +| **timeseries** | **Set\** | List of unique time series key names available on the matched entities. | | +| **attribute** | **Set\** | List of unique attribute key names available on the matched entities. | | diff --git a/ce/docs/AvailableEntityKeysV2.md b/ce/docs/AvailableEntityKeysV2.md index 0582f2aa..32d0a470 100644 --- a/ce/docs/AvailableEntityKeysV2.md +++ b/ce/docs/AvailableEntityKeysV2.md @@ -10,7 +10,7 @@ Contains unique time series and attribute key names discovered from entities mat | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | **entityTypes** | **Set\** | Set of entity types found among the matched entities. | | -| **timeseries** | **List\** | | [optional] | +| **timeseries** | **List\** | List of unique time series keys available on the matched entities, sorted alphabetically. Omitted when timeseries keys were not requested. | [optional] | | **attributes** | **Map\\>** | Map of attribute scope to the list of unique attribute keys available on the matched entities. Only scopes supported by the matched entity types are included. Omitted when attribute keys were not requested or when none of the requested scopes apply to the matched entity types. | [optional] | diff --git a/ce/docs/EntityDataDiff.md b/ce/docs/EntityDataDiff.md index 2c00b6e0..d52da586 100644 --- a/ce/docs/EntityDataDiff.md +++ b/ce/docs/EntityDataDiff.md @@ -74,7 +74,7 @@ #### WidgetsBundleExportData *(extends EntityExportData, entityType=`WIDGETS_BUNDLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| widgets | List | | [optional] | +| widgets | List | List of widgets in the bundle | [optional] | | fqns | List | | [optional] | #### WidgetTypeExportData *(extends EntityExportData, entityType=`WIDGET_TYPE`)* diff --git a/ce/docs/EntityExportData.md b/ce/docs/EntityExportData.md index 12a8e3be..25314497 100644 --- a/ce/docs/EntityExportData.md +++ b/ce/docs/EntityExportData.md @@ -68,7 +68,7 @@ Base export container for ThingsBoard entities #### WidgetsBundleExportData *(entityType=`WIDGETS_BUNDLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| widgets | List | | [optional] | +| widgets | List | List of widgets in the bundle | [optional] | | fqns | List | | [optional] | #### WidgetTypeExportData *(entityType=`WIDGET_TYPE`)* diff --git a/ce/docs/TbChatRequest.md b/ce/docs/TbChatRequest.md index 661a548e..d06ce178 100644 --- a/ce/docs/TbChatRequest.md +++ b/ce/docs/TbChatRequest.md @@ -18,7 +18,7 @@ #### TbUserMessage | Name | Type | Description | Notes | |------|------|-------------|-------| -| contents | List | | | +| contents | List | A list of content parts that make up the complete user prompt | | #### AiModelConfig | Name | Type | Description | Notes | diff --git a/ce/docs/TbUserMessage.md b/ce/docs/TbUserMessage.md index 6349a182..b2ce1ca0 100644 --- a/ce/docs/TbUserMessage.md +++ b/ce/docs/TbUserMessage.md @@ -7,7 +7,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **contents** | **List\** | | | +| **contents** | **List\** | A list of content parts that make up the complete user prompt | | diff --git a/ce/docs/WidgetsBundleExportData.md b/ce/docs/WidgetsBundleExportData.md index 165f59db..a78fea0b 100644 --- a/ce/docs/WidgetsBundleExportData.md +++ b/ce/docs/WidgetsBundleExportData.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **widgets** | **List\** | | [optional] | +| **widgets** | **List\** | List of widgets in the bundle | [optional] | | **fqns** | **List\** | | [optional] | diff --git a/ce/spec/openapi.json b/ce/spec/openapi.json index 1969a62a..8d696472 100644 --- a/ce/spec/openapi.json +++ b/ce/spec/openapi.json @@ -85011,6 +85011,7 @@ }, "timeseries": { "type": "array", + "description": "List of unique time series key names available on the matched entities.", "items": { "type": "string", "example": "temperature", @@ -85020,6 +85021,7 @@ }, "attribute": { "type": "array", + "description": "List of unique attribute key names available on the matched entities.", "items": { "type": "string", "example": "serialNumber", @@ -85052,6 +85054,7 @@ }, "timeseries": { "type": "array", + "description": "List of unique time series keys available on the matched entities, sorted alphabetically.\nOmitted when timeseries keys were not requested.", "items": { "$ref": "#/components/schemas/KeyInfo" } @@ -99631,6 +99634,7 @@ "properties": { "contents": { "type": "array", + "description": "A list of content parts that make up the complete user prompt", "items": { "$ref": "#/components/schemas/TbContent" }, @@ -101793,6 +101797,7 @@ "properties": { "widgets": { "type": "array", + "description": "List of widgets in the bundle", "items": { "$ref": "#/components/schemas/JsonNode" } diff --git a/ce/src/main/java/org/thingsboard/client/model/AvailableEntityKeys.java b/ce/src/main/java/org/thingsboard/client/model/AvailableEntityKeys.java index caaa4068..329cfdbd 100644 --- a/ce/src/main/java/org/thingsboard/client/model/AvailableEntityKeys.java +++ b/ce/src/main/java/org/thingsboard/client/model/AvailableEntityKeys.java @@ -109,7 +109,7 @@ public AvailableEntityKeys addTimeseriesItem(String timeseriesItem) { } /** - * Get timeseries + * List of unique time series key names available on the matched entities. * @return timeseries */ @Nonnull @@ -142,7 +142,7 @@ public AvailableEntityKeys addAttributeItem(String attributeItem) { } /** - * Get attribute + * List of unique attribute key names available on the matched entities. * @return attribute */ @Nonnull diff --git a/ce/src/main/java/org/thingsboard/client/model/AvailableEntityKeysV2.java b/ce/src/main/java/org/thingsboard/client/model/AvailableEntityKeysV2.java index 61df0e32..a18c2339 100644 --- a/ce/src/main/java/org/thingsboard/client/model/AvailableEntityKeysV2.java +++ b/ce/src/main/java/org/thingsboard/client/model/AvailableEntityKeysV2.java @@ -115,7 +115,7 @@ public AvailableEntityKeysV2 addTimeseriesItem(KeyInfo timeseriesItem) { } /** - * Get timeseries + * List of unique time series keys available on the matched entities, sorted alphabetically. Omitted when timeseries keys were not requested. * @return timeseries */ @Nullable diff --git a/ce/src/main/java/org/thingsboard/client/model/TbUserMessage.java b/ce/src/main/java/org/thingsboard/client/model/TbUserMessage.java index 18fbe31a..b9999f8e 100644 --- a/ce/src/main/java/org/thingsboard/client/model/TbUserMessage.java +++ b/ce/src/main/java/org/thingsboard/client/model/TbUserMessage.java @@ -65,7 +65,7 @@ public TbUserMessage addContentsItem(TbContent contentsItem) { } /** - * Get contents + * A list of content parts that make up the complete user prompt * @return contents */ @Nonnull diff --git a/ce/src/main/java/org/thingsboard/client/model/WidgetsBundleExportData.java b/ce/src/main/java/org/thingsboard/client/model/WidgetsBundleExportData.java index a544c3ad..de785786 100644 --- a/ce/src/main/java/org/thingsboard/client/model/WidgetsBundleExportData.java +++ b/ce/src/main/java/org/thingsboard/client/model/WidgetsBundleExportData.java @@ -87,7 +87,7 @@ public WidgetsBundleExportData addWidgetsItem(com.fasterxml.jackson.databind.Jso } /** - * Get widgets + * List of widgets in the bundle * @return widgets */ @Nullable