Skip to content

Commit ad2faf9

Browse files
ViacheslavKlimovViacheslavKlimov
authored
Merge pull request #78 from thingsboard/auto/update-paas-client-master
Update PAAS OpenAPI spec in master (from develop/4.4)
2 parents db49ac1 + 0ac3ac1 commit ad2faf9

584 files changed

Lines changed: 77124 additions & 21901 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎paas/docs/AdminSettings.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ A JSON value representing the Mail Settings.
1919

2020
## Referenced Types
2121

22-
> **EntityId types** (`AdminSettingsId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BillingCustomerId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CouponId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `ProductId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `SubscriptionAddonId`, `SubscriptionId`, `SubscriptionPlanId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entityType: EntityType, id: UUID}` — all EntityId subtypes share this structure.
22+
> **EntityId types** (`AdminSettingsId`, `AgentAppEventId`, `AgentAppProfileId`, `AgentAppUnitId`, `AgentApplicationId`, `AgentBulkActionId`, `AgentId`, `AgentProfileId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BillingCustomerId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CouponId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `ProductId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `SubscriptionAddonId`, `SubscriptionId`, `SubscriptionPlanId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entityType: EntityType, id: UUID}` — all EntityId subtypes share this structure.
2323

2424
#### EntityType (enum)
25-
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total)
25+
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (59 values total)
2626

2727
---
2828

‎paas/docs/AdminSettingsId.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
> **EntityId**: `{entityType: EntityType, id: UUID}` — base type for all entity identifiers.
1818
1919
#### EntityType (enum)
20-
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total)
20+
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (59 values total)
2121

2222
---
2323

‎paas/docs/Agent.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
2+
# Agent
3+
4+
`org.thingsboard.client.model.Agent`
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
| **id** | **AgentId** | JSON object with the Agent Id. Specify this field to update the Agent. Referencing non-existing Agent Id will cause error. Omit this field to create new Agent. | [optional] |
11+
| **createdTime** | **Long** | Timestamp of the agent creation, in milliseconds | [optional] [readonly] |
12+
| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | | [optional] |
13+
| **tenantId** | **TenantId** | JSON object with Tenant Id. Use 'assignAgentToTenant' to change the Tenant Id. | [optional] [readonly] |
14+
| **customerId** | **CustomerId** | JSON object with Customer Id. | [optional] [readonly] |
15+
| **name** | **String** | Unique Agent Name in scope of Tenant | |
16+
| **description** | **String** | Agent description | [optional] |
17+
| **routingKey** | **String** | Agent routing key used for authentication | |
18+
| **secret** | **String** | Agent secret used for authentication | |
19+
| **agentProfileId** | **AgentProfileId** | JSON object with Agent Profile Id. Nullable. | [optional] |
20+
| **version** | **Long** | | [optional] |
21+
| **ownerId** | **EntityId** | JSON object with Customer or Tenant Id | [optional] [readonly] |
22+
23+
24+
25+
## Referenced Types
26+
27+
> **EntityId types** (`AdminSettingsId`, `AgentAppEventId`, `AgentAppProfileId`, `AgentAppUnitId`, `AgentApplicationId`, `AgentBulkActionId`, `AgentId`, `AgentProfileId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BillingCustomerId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CouponId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `ProductId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `SubscriptionAddonId`, `SubscriptionId`, `SubscriptionPlanId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entityType: EntityType, id: UUID}` — all EntityId subtypes share this structure.
28+
29+
#### EntityType (enum)
30+
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (59 values total)
31+
32+
---
33+
34+
### Conventions
35+
36+
- **Package:** `org.thingsboard.client.model`
37+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
38+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
39+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
40+

‎paas/docs/AgentAppArgument.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
2+
# AgentAppArgument
3+
4+
`org.thingsboard.client.model.AgentAppArgument`
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
| **name** | **String** | Argument name, referenced in the compose as ${tb.<name>}. | [optional] |
11+
| **sourceType** | **AgentAppArgumentSource** | Source entity the value is resolved from. | [optional] |
12+
| **sourceEntityId** | **EntityId** | Concrete source entity id. Required when sourceType references a specific entity (DEVICE, ASSET, CUSTOMER, EDGE); ignored for the context-derived sources. | [optional] |
13+
| **valueType** | **AgentAppArgumentValueType** | Whether the value is read from an attribute or the latest telemetry. | [optional] |
14+
| **scope** | **AttributeScope** | Attribute scope. Applicable only when valueType is ATTRIBUTE. Defaults to SERVER_SCOPE. | [optional] |
15+
| **key** | **String** | Attribute or latest telemetry key to read. | [optional] |
16+
| **defaultValue** | **String** | Optional fallback value used when the source has no value for the key. | [optional] |
17+
| **format** | **AgentAppArgumentFormat** | How the resolved value is injected into the compose: STRING (quoted) or JSON (raw, for arrays/objects/numbers when the placeholder is the whole value). Defaults to STRING. | [optional] |
18+
19+
20+
21+
## Referenced Types
22+
23+
> **EntityId types** (`AdminSettingsId`, `AgentAppEventId`, `AgentAppProfileId`, `AgentAppUnitId`, `AgentApplicationId`, `AgentBulkActionId`, `AgentId`, `AgentProfileId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BillingCustomerId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CouponId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `ProductId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `SubscriptionAddonId`, `SubscriptionId`, `SubscriptionPlanId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entityType: EntityType, id: UUID}` — all EntityId subtypes share this structure.
24+
25+
#### AgentAppArgumentSource (enum)
26+
`AGENT` | `OWNER` | `RELATED_ENTITY` | `TENANT` | `DEVICE` | `ASSET` | `CUSTOMER` | `EDGE`
27+
28+
#### AgentAppArgumentValueType (enum)
29+
`ATTRIBUTE` | `LATEST_TELEMETRY`
30+
31+
#### AttributeScope (enum)
32+
`CLIENT_SCOPE` | `SERVER_SCOPE` | `SHARED_SCOPE`
33+
34+
#### AgentAppArgumentFormat (enum)
35+
`STRING` | `JSON`
36+
37+
#### EntityType (enum)
38+
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (59 values total)
39+
40+
---
41+
42+
### Conventions
43+
44+
- **Package:** `org.thingsboard.client.model`
45+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
46+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
47+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
48+

‎paas/docs/AgentAppArgumentFormat.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# AgentAppArgumentFormat
3+
4+
`org.thingsboard.client.model.AgentAppArgumentFormat`
5+
6+
## Enum Values
7+
8+
9+
* `STRING` (value: `"STRING"`)
10+
11+
* `JSON` (value: `"JSON"`)
12+
13+
14+
15+
---
16+
17+
### Conventions
18+
19+
- **Package:** `org.thingsboard.client.model`
20+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
21+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
22+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
23+

‎paas/docs/AgentAppArgumentSource.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
# AgentAppArgumentSource
3+
4+
`org.thingsboard.client.model.AgentAppArgumentSource`
5+
6+
## Enum Values
7+
8+
9+
* `AGENT` (value: `"AGENT"`)
10+
11+
* `OWNER` (value: `"OWNER"`)
12+
13+
* `RELATED_ENTITY` (value: `"RELATED_ENTITY"`)
14+
15+
* `TENANT` (value: `"TENANT"`)
16+
17+
* `DEVICE` (value: `"DEVICE"`)
18+
19+
* `ASSET` (value: `"ASSET"`)
20+
21+
* `CUSTOMER` (value: `"CUSTOMER"`)
22+
23+
* `EDGE` (value: `"EDGE"`)
24+
25+
26+
27+
---
28+
29+
### Conventions
30+
31+
- **Package:** `org.thingsboard.client.model`
32+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
33+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
34+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
35+

‎paas/docs/AgentAppArgumentValueType.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# AgentAppArgumentValueType
3+
4+
`org.thingsboard.client.model.AgentAppArgumentValueType`
5+
6+
## Enum Values
7+
8+
9+
* `ATTRIBUTE` (value: `"ATTRIBUTE"`)
10+
11+
* `LATEST_TELEMETRY` (value: `"LATEST_TELEMETRY"`)
12+
13+
14+
15+
---
16+
17+
### Conventions
18+
19+
- **Package:** `org.thingsboard.client.model`
20+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
21+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
22+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
23+

‎paas/docs/AgentAppConfig.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
2+
# AgentAppConfig
3+
4+
`org.thingsboard.client.model.AgentAppConfig`
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
| **arguments** | **List\<AgentAppArgument\>** | | [optional] |
11+
| **edgeRoutingKey** | **String** | | [optional] |
12+
| **type** | **AgentAppConfigType** | | [optional] |
13+
14+
15+
16+
## Referenced Types
17+
18+
> **EntityId types** (`AdminSettingsId`, `AgentAppEventId`, `AgentAppProfileId`, `AgentAppUnitId`, `AgentApplicationId`, `AgentBulkActionId`, `AgentId`, `AgentProfileId`, `AiModelId`, `AlarmId`, `ApiKeyId`, `ApiUsageStateId`, `AssetId`, `AssetProfileId`, `BillingCustomerId`, `BlobEntityId`, `CalculatedFieldId`, `ConverterId`, `CouponId`, `CustomerId`, `DashboardId`, `DeviceId`, `DeviceProfileId`, `DomainId`, `EdgeId`, `EntityGroupId`, `EntityViewId`, `GroupPermissionId`, `IntegrationId`, `JobId`, `MobileAppBundleId`, `MobileAppId`, `NotificationId`, `NotificationRequestId`, `NotificationRuleId`, `NotificationTargetId`, `NotificationTemplateId`, `OAuth2ClientId`, `OtaPackageId`, `ProductId`, `QueueId`, `QueueStatsId`, `ReportId`, `ReportTemplateId`, `RoleId`, `RpcId`, `RuleChainId`, `RuleNodeId`, `SchedulerEventId`, `SecretId`, `SubscriptionAddonId`, `SubscriptionId`, `SubscriptionPlanId`, `TbResourceId`, `TenantId`, `TenantProfileId`, `UserId`, `WidgetTypeId`, `WidgetsBundleId`, etc.): `{entityType: EntityType, id: UUID}` — all EntityId subtypes share this structure.
19+
20+
#### AgentAppArgument
21+
| Name | Type | Description | Notes |
22+
|------|------|-------------|-------|
23+
| name | String | Argument name, referenced in the compose as ${tb.<name>}. | [optional] |
24+
| sourceType | AgentAppArgumentSource | Source entity the value is resolved from. | [optional] |
25+
| sourceEntityId | EntityId | Concrete source entity id. Required when sourceType references a specific entity (DEVICE, ASSET, CUSTOMER, EDGE); ignored for the context-derived sources. | [optional] |
26+
| valueType | AgentAppArgumentValueType | Whether the value is read from an attribute or the latest telemetry. | [optional] |
27+
| scope | AttributeScope | Attribute scope. Applicable only when valueType is ATTRIBUTE. Defaults to SERVER_SCOPE. | [optional] |
28+
| key | String | Attribute or latest telemetry key to read. | [optional] |
29+
| defaultValue | String | Optional fallback value used when the source has no value for the key. | [optional] |
30+
| format | AgentAppArgumentFormat | How the resolved value is injected into the compose: STRING (quoted) or JSON (raw, for arrays/objects/numbers when the placeholder is the whole value). Defaults to STRING. | [optional] |
31+
32+
#### AgentAppConfigType (enum)
33+
`DOCKER_COMPOSE`
34+
35+
#### AgentAppArgumentSource (enum)
36+
`AGENT` | `OWNER` | `RELATED_ENTITY` | `TENANT` | `DEVICE` | `ASSET` | `CUSTOMER` | `EDGE`
37+
38+
#### AgentAppArgumentValueType (enum)
39+
`ATTRIBUTE` | `LATEST_TELEMETRY`
40+
41+
#### AttributeScope (enum)
42+
`CLIENT_SCOPE` | `SERVER_SCOPE` | `SHARED_SCOPE`
43+
44+
#### AgentAppArgumentFormat (enum)
45+
`STRING` | `JSON`
46+
47+
#### EntityType (enum)
48+
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (59 values total)
49+
50+
---
51+
52+
### Conventions
53+
54+
- **Package:** `org.thingsboard.client.model`
55+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
56+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
57+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
58+

‎paas/docs/AgentAppConfigType.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
# AgentAppConfigType
3+
4+
`org.thingsboard.client.model.AgentAppConfigType`
5+
6+
## Enum Values
7+
8+
9+
* `DOCKER_COMPOSE` (value: `"DOCKER_COMPOSE"`)
10+
11+
12+
13+
---
14+
15+
### Conventions
16+
17+
- **Package:** `org.thingsboard.client.model`
18+
- **Getter pattern:** `get<PropertyName>()` — e.g., `getId()`, `getName()`
19+
- **Setter pattern:** `set<PropertyName>(value)` — e.g., `setId(value)`, `setName(value)`
20+
- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions
21+

0 commit comments

Comments
 (0)