Skip to content

Commit cf52d96

Browse files
ViacheslavKlimovViacheslavKlimov
committed
Flatten model docs with inline referenced types
1 parent d9b1560 commit cf52d96

File tree

1,398 files changed

+150397
-0
lines changed

Some content is hidden

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

1,398 files changed

+150397
-0
lines changed

‎generate-client.sh‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,21 @@ else
254254
fi
255255

256256
if [ "$DRY_RUN" = false ]; then
257+
# Flatten model docs (inline referenced types for self-contained reading)
258+
if command -v python3 >/dev/null 2>&1; then
259+
if [ "$EDITION" = "all" ]; then
260+
for e in "${EDITIONS[@]}"; do
261+
echo "Flattening docs for $e..."
262+
python3 "$SCRIPT_DIR/scripts/flatten_docs.py" "$SCRIPT_DIR/$e/docs"
263+
done
264+
else
265+
echo "Flattening docs for $EDITION..."
266+
python3 "$SCRIPT_DIR/scripts/flatten_docs.py" "$SCRIPT_DIR/$EDITION/docs"
267+
fi
268+
else
269+
echo "Warning: python3 not found — skipping docs flattening"
270+
fi
271+
257272
# Resolve mvn: prefer M2_HOME/MAVEN_HOME, fall back to PATH
258273
if [ -n "${M2_HOME:-}" ] && [ -x "$M2_HOME/bin/mvn" ]; then
259274
MVN="$M2_HOME/bin/mvn"

‎paas/docs/AccountTwoFaSettings.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,35 @@ Account Two-Factor Authentication Settings
1313

1414

1515

16+
## Referenced Types
17+
18+
#### TwoFaAccountConfig
19+
| Name | Type | Description | Notes |
20+
|------|------|-------------|-------|
21+
| useByDefault | Boolean | | [optional] |
22+
| providerType | String | | |
23+
24+
#### BackupCodeTwoFaAccountConfig *(extends TwoFaAccountConfig, providerType=`BACKUP_CODE`)*
25+
| Name | Type | Description | Notes |
26+
|------|------|-------------|-------|
27+
| codes | Set<String> | | |
28+
| codesLeft | Integer | | [optional] |
29+
30+
#### EmailTwoFaAccountConfig *(extends TwoFaAccountConfig, providerType=`EMAIL`)*
31+
| Name | Type | Description | Notes |
32+
|------|------|-------------|-------|
33+
| email | String | | |
34+
35+
#### SmsTwoFaAccountConfig *(extends TwoFaAccountConfig, providerType=`SMS`)*
36+
| Name | Type | Description | Notes |
37+
|------|------|-------------|-------|
38+
| phoneNumber | String | | |
39+
40+
#### TotpTwoFaAccountConfig *(extends TwoFaAccountConfig, providerType=`TOTP`)*
41+
| Name | Type | Description | Notes |
42+
|------|------|-------------|-------|
43+
| authUrl | String | | |
44+
1645
---
1746

1847
### Conventions

‎paas/docs/AdminSettings.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@ A JSON value representing the Mail Settings.
1717

1818

1919

20+
## Referenced Types
21+
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.
23+
24+
#### EntityType (enum)
25+
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total)
26+
2027
---
2128

2229
### Conventions

‎paas/docs/AdminSettingsId.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@
1212

1313

1414

15+
## Referenced Types
16+
17+
> **EntityId types** (`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.
18+
19+
#### EntityType (enum)
20+
`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (52 values total)
21+
1522
---
1623

1724
### Conventions

‎paas/docs/AffectedTenantAdministratorsFilter.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,51 @@
1212

1313

1414

15+
## Referenced Types
16+
17+
#### UsersFilter
18+
| Name | Type | Description | Notes |
19+
|------|------|-------------|-------|
20+
| type | String | | |
21+
22+
#### AffectedUserFilter *(extends UsersFilter, type=`AFFECTED_USER`)*
23+
*See UsersFilter for properties.*
24+
25+
#### AllUsersFilter *(extends UsersFilter, type=`ALL_USERS`)*
26+
*See UsersFilter for properties.*
27+
28+
#### CustomerUsersFilter *(extends UsersFilter, type=`CUSTOMER_USERS`)*
29+
| Name | Type | Description | Notes |
30+
|------|------|-------------|-------|
31+
| customerId | UUID | | |
32+
33+
#### OriginatorEntityOwnerUsersFilter *(extends UsersFilter, type=`ORIGINATOR_ENTITY_OWNER_USERS`)*
34+
*See UsersFilter for properties.*
35+
36+
#### SystemAdministratorsFilter *(extends UsersFilter, type=`SYSTEM_ADMINISTRATORS`)*
37+
*See UsersFilter for properties.*
38+
39+
#### TenantAdministratorsFilter *(extends UsersFilter, type=`TENANT_ADMINISTRATORS`)*
40+
| Name | Type | Description | Notes |
41+
|------|------|-------------|-------|
42+
| tenantsIds | Set<UUID> | | [optional] |
43+
| tenantProfilesIds | Set<UUID> | | [optional] |
44+
45+
#### UserGroupListFilter *(extends UsersFilter, type=`USER_GROUP_LIST`)*
46+
| Name | Type | Description | Notes |
47+
|------|------|-------------|-------|
48+
| groupsIds | List<UUID> | | |
49+
50+
#### UserListFilter *(extends UsersFilter, type=`USER_LIST`)*
51+
| Name | Type | Description | Notes |
52+
|------|------|-------------|-------|
53+
| usersIds | List<UUID> | | |
54+
55+
#### UserRoleFilter *(extends UsersFilter, type=`USER_ROLE`)*
56+
| Name | Type | Description | Notes |
57+
|------|------|-------------|-------|
58+
| rolesIds | List<UUID> | | |
59+
1560
---
1661

1762
### Conventions

‎paas/docs/AffectedUserFilter.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,51 @@
1212

1313

1414

15+
## Referenced Types
16+
17+
#### UsersFilter
18+
| Name | Type | Description | Notes |
19+
|------|------|-------------|-------|
20+
| type | String | | |
21+
22+
#### AffectedTenantAdministratorsFilter *(extends UsersFilter, type=`AFFECTED_TENANT_ADMINISTRATORS`)*
23+
*See UsersFilter for properties.*
24+
25+
#### AllUsersFilter *(extends UsersFilter, type=`ALL_USERS`)*
26+
*See UsersFilter for properties.*
27+
28+
#### CustomerUsersFilter *(extends UsersFilter, type=`CUSTOMER_USERS`)*
29+
| Name | Type | Description | Notes |
30+
|------|------|-------------|-------|
31+
| customerId | UUID | | |
32+
33+
#### OriginatorEntityOwnerUsersFilter *(extends UsersFilter, type=`ORIGINATOR_ENTITY_OWNER_USERS`)*
34+
*See UsersFilter for properties.*
35+
36+
#### SystemAdministratorsFilter *(extends UsersFilter, type=`SYSTEM_ADMINISTRATORS`)*
37+
*See UsersFilter for properties.*
38+
39+
#### TenantAdministratorsFilter *(extends UsersFilter, type=`TENANT_ADMINISTRATORS`)*
40+
| Name | Type | Description | Notes |
41+
|------|------|-------------|-------|
42+
| tenantsIds | Set<UUID> | | [optional] |
43+
| tenantProfilesIds | Set<UUID> | | [optional] |
44+
45+
#### UserGroupListFilter *(extends UsersFilter, type=`USER_GROUP_LIST`)*
46+
| Name | Type | Description | Notes |
47+
|------|------|-------------|-------|
48+
| groupsIds | List<UUID> | | |
49+
50+
#### UserListFilter *(extends UsersFilter, type=`USER_LIST`)*
51+
| Name | Type | Description | Notes |
52+
|------|------|-------------|-------|
53+
| usersIds | List<UUID> | | |
54+
55+
#### UserRoleFilter *(extends UsersFilter, type=`USER_ROLE`)*
56+
| Name | Type | Description | Notes |
57+
|------|------|-------------|-------|
58+
| rolesIds | List<UUID> | | |
59+
1560
---
1661

1762
### Conventions

‎paas/docs/AggFunctionInput.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@
1313

1414

1515

16+
## Referenced Types
17+
18+
#### AggInput
19+
| Name | Type | Description | Notes |
20+
|------|------|-------------|-------|
21+
| type | String | | |
22+
23+
#### AggKeyInput *(extends AggInput, type=`key`)*
24+
| Name | Type | Description | Notes |
25+
|------|------|-------------|-------|
26+
| key | String | | [optional] |
27+
1628
---
1729

1830
### Conventions

‎paas/docs/AggInput.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@
1111

1212

1313

14+
## Subtypes
15+
16+
#### AggFunctionInput *(type=`function`)*
17+
| Name | Type | Description | Notes |
18+
|------|------|-------------|-------|
19+
| function | String | | [optional] |
20+
21+
#### AggKeyInput *(type=`key`)*
22+
| Name | Type | Description | Notes |
23+
|------|------|-------------|-------|
24+
| key | String | | [optional] |
25+
1426
---
1527

1628
### Conventions

‎paas/docs/AggInterval.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,57 @@
1111

1212

1313

14+
## Subtypes
15+
16+
#### CustomInterval *(type=`CUSTOM`)*
17+
| Name | Type | Description | Notes |
18+
|------|------|-------------|-------|
19+
| tz | String | | |
20+
| offsetSec | Long | | [optional] |
21+
| durationSec | Long | | |
22+
23+
#### DayInterval *(type=`DAY`)*
24+
| Name | Type | Description | Notes |
25+
|------|------|-------------|-------|
26+
| tz | String | | |
27+
| offsetSec | Long | | [optional] |
28+
29+
#### HourInterval *(type=`HOUR`)*
30+
| Name | Type | Description | Notes |
31+
|------|------|-------------|-------|
32+
| tz | String | | |
33+
| offsetSec | Long | | [optional] |
34+
35+
#### MonthInterval *(type=`MONTH`)*
36+
| Name | Type | Description | Notes |
37+
|------|------|-------------|-------|
38+
| tz | String | | |
39+
| offsetSec | Long | | [optional] |
40+
41+
#### QuarterInterval *(type=`QUARTER`)*
42+
| Name | Type | Description | Notes |
43+
|------|------|-------------|-------|
44+
| tz | String | | |
45+
| offsetSec | Long | | [optional] |
46+
47+
#### WeekInterval *(type=`WEEK`)*
48+
| Name | Type | Description | Notes |
49+
|------|------|-------------|-------|
50+
| tz | String | | |
51+
| offsetSec | Long | | [optional] |
52+
53+
#### WeekSunSatInterval *(type=`WEEK_SUN_SAT`)*
54+
| Name | Type | Description | Notes |
55+
|------|------|-------------|-------|
56+
| tz | String | | |
57+
| offsetSec | Long | | [optional] |
58+
59+
#### YearInterval *(type=`YEAR`)*
60+
| Name | Type | Description | Notes |
61+
|------|------|-------------|-------|
62+
| tz | String | | |
63+
| offsetSec | Long | | [optional] |
64+
1465
---
1566

1667
### Conventions

‎paas/docs/AggKeyInput.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@
1313

1414

1515

16+
## Referenced Types
17+
18+
#### AggInput
19+
| Name | Type | Description | Notes |
20+
|------|------|-------------|-------|
21+
| type | String | | |
22+
23+
#### AggFunctionInput *(extends AggInput, type=`function`)*
24+
| Name | Type | Description | Notes |
25+
|------|------|-------------|-------|
26+
| function | String | | [optional] |
27+
1628
---
1729

1830
### Conventions

0 commit comments

Comments
 (0)