Skip to content

Commit 26cf245

Browse files
AbdulboisAbdulbois
authored
Merge pull request #576 from zigbee-alliance/#575-Rename-field-of-Model-entity
#575 Rename CommissionerRemoteUiFlowUrl to ManagedAclExtensionRequestFlowUrl
2 parents e54ad99 + c71d560 commit 26cf245

File tree

34 files changed

+1179
-319
lines changed

34 files changed

+1179
-319
lines changed

‎docs/static/openapi.yml

+609-6
Large diffs are not rendered by default.

‎docs/transactions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ Not all fields can be edited (see `EDIT_MODEL`).
208208
- commissioningModeInitialStepsInstruction: `optional(string)` - commissioningModeInitialStepsInstruction SHALL contain text which relates to specific values of CommissioningModeInitialStepsHint. Certain values of CommissioningModeInitialStepsHint, as defined in the Pairing Hint Table, indicate a Pairing Instruction (PI) dependency, and for these values the commissioningModeInitialStepsInstruction SHALL be set
209209
- commissioningModeSecondaryStepsHint: `optional(uint32)` - commissioningModeSecondaryStepsHint SHALL identify a hint for steps that can be used to put into commissioning mode a device that has already been commissioned. This field is a bitmap with values defined in the Pairing Hint Table. For example, a value of 4 (bit 2 is set) indicates that a device that has already been commissioned will require the user to visit a current CHIP Administrator to put the device into commissioning mode.
210210
- commissioningModeSecondaryStepInstruction: `optional(string)` - commissioningModeSecondaryStepInstruction SHALL contain text which relates to specific values of commissioningModeSecondaryStepsHint. Certain values of commissioningModeSecondaryStepsHint, as defined in the Pairing Hint Table, indicate a Pairing Instruction (PI) dependency, and for these values the commissioningModeSecondaryStepInstruction SHALL be set
211-
- commissionerRemoteUiFlowURL `optional(string)` - commissionerRemoteUiFlowURL SHALL identify URL to show a custom flow UI for the commissioner
211+
- managedAclExtensionRequestFlowUrl `optional(string)` - managedAclExtensionRequestFlowUrl SHALL identify a vendor-specific URL that can be used to request additional access to what is currently provided by the optional ManagedACL attribute
212212
- userManualURL: `optional(string)` - URL that contains product specific web page that contains user manual for the device model.
213213
- supportURL: `optional(string)` - URL that contains product specific web page that contains support details for the device model.
214214
- productURL: `optional(string)` - URL that contains product specific web page that contains details for the device model.
@@ -255,7 +255,7 @@ All non-edited fields remain the same.
255255
- commissioningCustomFlowURL: `optional(string)` - commissioningCustomFlowURL SHALL identify a vendor specific commissioning URL for the device model when the commissioningCustomFlow field is set to '2'
256256
- commissioningModeInitialStepsInstruction: `optional(string)` - commissioningModeInitialStepsInstruction SHALL contain text which relates to specific values of CommissioningModeInitialStepsHint. Certain values of CommissioningModeInitialStepsHint, as defined in the Pairing Hint Table, indicate a Pairing Instruction (PI) dependency, and for these values the commissioningModeInitialStepsInstruction SHALL be set
257257
- commissioningModeSecondaryStepInstruction: `optional(string)` - commissioningModeSecondaryStepInstruction SHALL contain text which relates to specific values of commissioningModeSecondaryStepsHint. Certain values of commissioningModeSecondaryStepsHint, as defined in the Pairing Hint Table, indicate a Pairing Instruction (PI) dependency, and for these values the commissioningModeSecondaryStepInstruction SHALL be set
258-
- commissionerRemoteUiFlowURL `optional(string)` - commissionerRemoteUiFlowURL SHALL identify URL to show a custom flow UI for the commissioner
258+
- managedAclExtensionRequestFlowUrl `optional(string)` - managedAclExtensionRequestFlowUrl SHALL identify a vendor-specific URL that can be used to request additional access to what is currently provided by the optional ManagedACL attribute
259259
- userManualURL: `optional(string)` - URL that contains product specific web page that contains user manual for the device model.
260260
- supportURL: `optional(string)` - URL that contains product specific web page that contains support details for the device model.
261261
- productURL: `optional(string)` - URL that contains product specific web page that contains details for the device model.

‎integration_tests/cli/model-demo.sh

+7-7
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ test_divider
6060
productLabel="Device #1"
6161
schema_version_0=0
6262
schema_version_2=2
63-
commissionerRemoteUiFlowURL="https://commissionerRemoteUiFlowURL.dclmodel"
63+
managedAclExtensionRequestFlowUrl="https://managedAclExtensionRequestFlowUrl.dclmodel"
6464
echo "Add Model with VID: $vid PID: $pid"
65-
result=$(echo "test1234" | dcld tx model add-model --vid=$vid --pid=$pid --deviceTypeID=1 --productName=TestProduct --productLabel="$productLabel" --partNumber=1 --commissioningCustomFlow=0 --commissionerRemoteUiFlowURL="$commissionerRemoteUiFlowURL" --schemaVersion=$schema_version_2 --from=$vendor_account --yes)
65+
result=$(echo "test1234" | dcld tx model add-model --vid=$vid --pid=$pid --deviceTypeID=1 --productName=TestProduct --productLabel="$productLabel" --partNumber=1 --commissioningCustomFlow=0 --managedAclExtensionRequestFlowUrl="$managedAclExtensionRequestFlowUrl" --schemaVersion=$schema_version_2 --from=$vendor_account --yes)
6666
result=$(get_txn_result "$result")
6767
check_response "$result" "\"code\": 0"
6868
echo "$result"
@@ -84,7 +84,7 @@ check_response "$result" "\"vid\": $vid"
8484
check_response "$result" "\"pid\": $pid"
8585
check_response "$result" "\"productLabel\": \"$productLabel\""
8686
check_response "$result" "\"schemaVersion\": $schema_version_2"
87-
check_response "$result" "\"commissionerRemoteUiFlowUrl\": \"$commissionerRemoteUiFlowURL\""
87+
check_response "$result" "\"managedAclExtensionRequestFlowUrl\": \"$managedAclExtensionRequestFlowUrl\""
8888
echo "$result"
8989

9090
echo "Get Model with VID: $vid_with_pids PID: $pid"
@@ -130,12 +130,12 @@ echo "$result"
130130

131131
test_divider
132132

133-
echo "Update Model with VID: ${vid} PID: ${pid} with new description, commissionerRemoteUiFlowURL and commissioningModeInitialStepsHint"
133+
echo "Update Model with VID: ${vid} PID: ${pid} with new description, managedAclExtensionRequestFlowUrl and commissioningModeInitialStepsHint"
134134
description="New Device Description"
135135
schema_version_3=3
136-
newCommissionerRemoteUiFlowURL="https://commissionerRemoteUiFlowURL.dclmodel.updated"
136+
newManagedAclExtensionRequestFlowUrl="https://managedAclExtensionRequestFlowUrl.dclmodel.updated"
137137
newCommissioningModeInitialStepsHint=8
138-
result=$(echo "test1234" | dcld tx model update-model --vid=$vid --pid=$pid --from $vendor_account --yes --productLabel "$description" --schemaVersion=$schema_version_3 --commissionerRemoteUiFlowURL="$newCommissionerRemoteUiFlowURL" --commissioningModeInitialStepsHint="$newCommissioningModeInitialStepsHint")
138+
result=$(echo "test1234" | dcld tx model update-model --vid=$vid --pid=$pid --from $vendor_account --yes --productLabel "$description" --schemaVersion=$schema_version_3 --managedAclExtensionRequestFlowUrl="$newManagedAclExtensionRequestFlowUrl" --commissioningModeInitialStepsHint="$newCommissioningModeInitialStepsHint")
139139
result=$(get_txn_result "$result")
140140
check_response "$result" "\"code\": 0"
141141
echo "$result"
@@ -156,7 +156,7 @@ check_response "$result" "\"vid\": $vid"
156156
check_response "$result" "\"pid\": $pid"
157157
check_response "$result" "\"productLabel\": \"$description\""
158158
check_response "$result" "\"schemaVersion\": $schema_version_3"
159-
check_response "$result" "\"commissionerRemoteUiFlowUrl\": \"$newCommissionerRemoteUiFlowURL\""
159+
check_response "$result" "\"managedAclExtensionRequestFlowUrl\": \"$newManagedAclExtensionRequestFlowUrl\""
160160
check_response "$result" "\"commissioningModeInitialStepsHint\": $newCommissioningModeInitialStepsHint"
161161
echo "$result"
162162

‎proto/zigbeealliance/distributedcomplianceledger/dclauth/grant.proto

+1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ message Grant {
99
string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
1010
int64 time = 2; // number of nanoseconds elapsed since January 1, 1970 UTC
1111
string info = 3;
12+
uint32 schemaVersion = 4;
1213
}
1314

‎proto/zigbeealliance/distributedcomplianceledger/dclupgrade/grant.proto

+1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ message Grant {
99
string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
1010
int64 time = 2; // number of nanoseconds elapsed since January 1, 1970 UTC
1111
string info = 3;
12+
uint32 schemaVersion = 4;
1213
}
1314

‎proto/zigbeealliance/distributedcomplianceledger/model/model.proto

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ message Model {
2525
int32 lsfRevision = 17;
2626
string creator = 18 [(cosmos_proto.scalar) = "cosmos.AddressString"];
2727
uint32 schemaVersion = 19;
28-
string commissionerRemoteUiFlowUrl = 20;
28+
string managedAclExtensionRequestFlowUrl = 20;
2929
}
3030

‎proto/zigbeealliance/distributedcomplianceledger/model/product.proto

+1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ message Product {
88
int32 pid = 1;
99
string name = 2;
1010
string partNumber = 3;
11+
uint32 schemaVersion = 4;
1112
}

‎proto/zigbeealliance/distributedcomplianceledger/model/tx.proto

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ message MsgCreateModel {
4141
string productUrl = 16 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
4242
string lsfUrl = 17 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
4343
uint32 schemaVersion = 18 [(gogoproto.moretags) = "validate:\"gte=0,lte=65535\""];
44-
string commissionerRemoteUiFlowUrl = 19 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
44+
string managedAclExtensionRequestFlowUrl = 19 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
4545
}
4646
message MsgCreateModelResponse {}
4747

@@ -62,7 +62,7 @@ message MsgUpdateModel {
6262
string lsfUrl = 13 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
6363
int32 lsfRevision = 14 [(gogoproto.moretags) = "validate:\"gte=0,lte=65535\""];
6464
uint32 schemaVersion = 15 [(gogoproto.moretags) = "validate:\"gte=0,lte=65535\""];
65-
string commissionerRemoteUiFlowUrl = 16 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
65+
string managedAclExtensionRequestFlowUrl = 16 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
6666
uint32 commissioningModeInitialStepsHint = 17;
6767
}
6868
message MsgUpdateModelResponse {}

‎proto/zigbeealliance/distributedcomplianceledger/pki/grant.proto

+1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ message Grant {
99
string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
1010
int64 time = 2; // number of nanoseconds elapsed since January 1, 1970 UTC
1111
string info = 3;
12+
uint32 schemaVersion = 4;
1213
}
1314

‎proto/zigbeealliance/distributedcomplianceledger/validator/grant.proto

+1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@ message Grant {
99
string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
1010
int64 time = 2; // number of nanoseconds elapsed since January 1, 1970 UTC
1111
string info = 3;
12+
uint32 schemaVersion = 4;
1213
}

‎ts-client/zigbeealliance.distributedcomplianceledger.dclauth/rest.ts

+3
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ export interface DclauthGrant {
3131
*/
3232
time?: string;
3333
info?: string;
34+
35+
/** @format int64 */
36+
schemaVersion?: number;
3437
}
3538

3639
export type DclauthMsgApproveAddAccountResponse = object;

‎ts-client/zigbeealliance.distributedcomplianceledger.dclauth/types/zigbeealliance/distributedcomplianceledger/dclauth/grant.ts

+11-1
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ export interface Grant {
99
/** number of nanoseconds elapsed since January 1, 1970 UTC */
1010
time: number;
1111
info: string;
12+
schemaVersion: number;
1213
}
1314

1415
function createBaseGrant(): Grant {
15-
return { address: "", time: 0, info: "" };
16+
return { address: "", time: 0, info: "", schemaVersion: 0 };
1617
}
1718

1819
export const Grant = {
@@ -26,6 +27,9 @@ export const Grant = {
2627
if (message.info !== "") {
2728
writer.uint32(26).string(message.info);
2829
}
30+
if (message.schemaVersion !== 0) {
31+
writer.uint32(32).uint32(message.schemaVersion);
32+
}
2933
return writer;
3034
},
3135

@@ -45,6 +49,9 @@ export const Grant = {
4549
case 3:
4650
message.info = reader.string();
4751
break;
52+
case 4:
53+
message.schemaVersion = reader.uint32();
54+
break;
4855
default:
4956
reader.skipType(tag & 7);
5057
break;
@@ -58,6 +65,7 @@ export const Grant = {
5865
address: isSet(object.address) ? String(object.address) : "",
5966
time: isSet(object.time) ? Number(object.time) : 0,
6067
info: isSet(object.info) ? String(object.info) : "",
68+
schemaVersion: isSet(object.schemaVersion) ? Number(object.schemaVersion) : 0,
6169
};
6270
},
6371

@@ -66,6 +74,7 @@ export const Grant = {
6674
message.address !== undefined && (obj.address = message.address);
6775
message.time !== undefined && (obj.time = Math.round(message.time));
6876
message.info !== undefined && (obj.info = message.info);
77+
message.schemaVersion !== undefined && (obj.schemaVersion = Math.round(message.schemaVersion));
6978
return obj;
7079
},
7180

@@ -74,6 +83,7 @@ export const Grant = {
7483
message.address = object.address ?? "";
7584
message.time = object.time ?? 0;
7685
message.info = object.info ?? "";
86+
message.schemaVersion = object.schemaVersion ?? 0;
7787
return message;
7888
},
7989
};

‎ts-client/zigbeealliance.distributedcomplianceledger.dclupgrade/rest.ts

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ export interface DclupgradeGrant {
1818
*/
1919
time?: string;
2020
info?: string;
21+
22+
/** @format int64 */
23+
schemaVersion?: number;
2124
}
2225

2326
export type DclupgradeMsgApproveUpgradeResponse = object;

‎ts-client/zigbeealliance.distributedcomplianceledger.dclupgrade/types/zigbeealliance/distributedcomplianceledger/dclupgrade/grant.ts

+11-1
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ export interface Grant {
99
/** number of nanoseconds elapsed since January 1, 1970 UTC */
1010
time: number;
1111
info: string;
12+
schemaVersion: number;
1213
}
1314

1415
function createBaseGrant(): Grant {
15-
return { address: "", time: 0, info: "" };
16+
return { address: "", time: 0, info: "", schemaVersion: 0 };
1617
}
1718

1819
export const Grant = {
@@ -26,6 +27,9 @@ export const Grant = {
2627
if (message.info !== "") {
2728
writer.uint32(26).string(message.info);
2829
}
30+
if (message.schemaVersion !== 0) {
31+
writer.uint32(32).uint32(message.schemaVersion);
32+
}
2933
return writer;
3034
},
3135

@@ -45,6 +49,9 @@ export const Grant = {
4549
case 3:
4650
message.info = reader.string();
4751
break;
52+
case 4:
53+
message.schemaVersion = reader.uint32();
54+
break;
4855
default:
4956
reader.skipType(tag & 7);
5057
break;
@@ -58,6 +65,7 @@ export const Grant = {
5865
address: isSet(object.address) ? String(object.address) : "",
5966
time: isSet(object.time) ? Number(object.time) : 0,
6067
info: isSet(object.info) ? String(object.info) : "",
68+
schemaVersion: isSet(object.schemaVersion) ? Number(object.schemaVersion) : 0,
6169
};
6270
},
6371

@@ -66,6 +74,7 @@ export const Grant = {
6674
message.address !== undefined && (obj.address = message.address);
6775
message.time !== undefined && (obj.time = Math.round(message.time));
6876
message.info !== undefined && (obj.info = message.info);
77+
message.schemaVersion !== undefined && (obj.schemaVersion = Math.round(message.schemaVersion));
6978
return obj;
7079
},
7180

@@ -74,6 +83,7 @@ export const Grant = {
7483
message.address = object.address ?? "";
7584
message.time = object.time ?? 0;
7685
message.info = object.info ?? "";
86+
message.schemaVersion = object.schemaVersion ?? 0;
7787
return message;
7888
},
7989
};

‎ts-client/zigbeealliance.distributedcomplianceledger.model/rest.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface DistributedcomplianceledgermodelModel {
4444

4545
/** @format int64 */
4646
schemaVersion?: number;
47-
commissionerRemoteUiFlowUrl?: string;
47+
managedAclExtensionRequestFlowUrl?: string;
4848
}
4949

5050
export interface DistributedcomplianceledgermodelModelVersion {
@@ -121,6 +121,9 @@ export interface ModelProduct {
121121
pid?: number;
122122
name?: string;
123123
partNumber?: string;
124+
125+
/** @format int64 */
126+
schemaVersion?: number;
124127
}
125128

126129
export interface ModelQueryAllModelResponse {

‎ts-client/zigbeealliance.distributedcomplianceledger.model/types/zigbeealliance/distributedcomplianceledger/model/model.ts

+10-10
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface Model {
2323
lsfRevision: number;
2424
creator: string;
2525
schemaVersion: number;
26-
commissionerRemoteUiFlowUrl: string;
26+
managedAclExtensionRequestFlowUrl: string;
2727
}
2828

2929
function createBaseModel(): Model {
@@ -47,7 +47,7 @@ function createBaseModel(): Model {
4747
lsfRevision: 0,
4848
creator: "",
4949
schemaVersion: 0,
50-
commissionerRemoteUiFlowUrl: "",
50+
managedAclExtensionRequestFlowUrl: "",
5151
};
5252
}
5353

@@ -110,8 +110,8 @@ export const Model = {
110110
if (message.schemaVersion !== 0) {
111111
writer.uint32(152).uint32(message.schemaVersion);
112112
}
113-
if (message.commissionerRemoteUiFlowUrl !== "") {
114-
writer.uint32(162).string(message.commissionerRemoteUiFlowUrl);
113+
if (message.managedAclExtensionRequestFlowUrl !== "") {
114+
writer.uint32(162).string(message.managedAclExtensionRequestFlowUrl);
115115
}
116116
return writer;
117117
},
@@ -181,7 +181,7 @@ export const Model = {
181181
message.schemaVersion = reader.uint32();
182182
break;
183183
case 20:
184-
message.commissionerRemoteUiFlowUrl = reader.string();
184+
message.managedAclExtensionRequestFlowUrl = reader.string();
185185
break;
186186
default:
187187
reader.skipType(tag & 7);
@@ -222,8 +222,8 @@ export const Model = {
222222
lsfRevision: isSet(object.lsfRevision) ? Number(object.lsfRevision) : 0,
223223
creator: isSet(object.creator) ? String(object.creator) : "",
224224
schemaVersion: isSet(object.schemaVersion) ? Number(object.schemaVersion) : 0,
225-
commissionerRemoteUiFlowUrl: isSet(object.commissionerRemoteUiFlowUrl)
226-
? String(object.commissionerRemoteUiFlowUrl)
225+
managedAclExtensionRequestFlowUrl: isSet(object.managedAclExtensionRequestFlowUrl)
226+
? String(object.managedAclExtensionRequestFlowUrl)
227227
: "",
228228
};
229229
},
@@ -255,8 +255,8 @@ export const Model = {
255255
message.lsfRevision !== undefined && (obj.lsfRevision = Math.round(message.lsfRevision));
256256
message.creator !== undefined && (obj.creator = message.creator);
257257
message.schemaVersion !== undefined && (obj.schemaVersion = Math.round(message.schemaVersion));
258-
message.commissionerRemoteUiFlowUrl !== undefined
259-
&& (obj.commissionerRemoteUiFlowUrl = message.commissionerRemoteUiFlowUrl);
258+
message.managedAclExtensionRequestFlowUrl !== undefined
259+
&& (obj.managedAclExtensionRequestFlowUrl = message.managedAclExtensionRequestFlowUrl);
260260
return obj;
261261
},
262262

@@ -281,7 +281,7 @@ export const Model = {
281281
message.lsfRevision = object.lsfRevision ?? 0;
282282
message.creator = object.creator ?? "";
283283
message.schemaVersion = object.schemaVersion ?? 0;
284-
message.commissionerRemoteUiFlowUrl = object.commissionerRemoteUiFlowUrl ?? "";
284+
message.managedAclExtensionRequestFlowUrl = object.managedAclExtensionRequestFlowUrl ?? "";
285285
return message;
286286
},
287287
};

0 commit comments

Comments
 (0)