Merge pull request #576 from zigbee-alliance/#575-Rename-field-of-Mod…

…el-entity #575 Rename CommissionerRemoteUiFlowUrl to ManagedAclExtensionRequestFlowUrl
zigbee-alliance · Jun 5, 2024 · 26cf245 · 26cf245
2 parents e54ad99 + c71d560
commit 26cf245
Show file tree

Hide file tree

Showing 34 changed files with 1,179 additions and 319 deletions.
diff --git a/docs/static/openapi.yml b/docs/static/openapi.yml
diff --git a/docs/transactions.md b/docs/transactions.md
@@ -208,7 +208,7 @@ Not all fields can be edited (see `EDIT_MODEL`).
   - 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
   - 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.
   - 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
-  - commissionerRemoteUiFlowURL `optional(string)` - commissionerRemoteUiFlowURL SHALL identify URL to show a custom flow UI for the commissioner
+  - 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
   - userManualURL: `optional(string)` - URL that contains product specific web page that contains user manual for the device model.
   - supportURL: `optional(string)` - URL that contains product specific web page that contains support details for the device model.
   - 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.
   - commissioningCustomFlowURL: `optional(string)` - commissioningCustomFlowURL SHALL identify a vendor specific commissioning URL for the device model when the commissioningCustomFlow field is set to '2'
   - 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
   - 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
-  - commissionerRemoteUiFlowURL `optional(string)` - commissionerRemoteUiFlowURL SHALL identify URL to show a custom flow UI for the commissioner
+  - 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
   - userManualURL: `optional(string)` - URL that contains product specific web page that contains user manual for the device model.
   - supportURL: `optional(string)` - URL that contains product specific web page that contains support details for the device model.
   - productURL: `optional(string)` - URL that contains product specific web page that contains details for the device model.  

diff --git a/integration_tests/cli/model-demo.sh b/integration_tests/cli/model-demo.sh
@@ -60,9 +60,9 @@ test_divider
 productLabel="Device #1"
 schema_version_0=0
 schema_version_2=2
-commissionerRemoteUiFlowURL="https://commissionerRemoteUiFlowURL.dclmodel"
+managedAclExtensionRequestFlowUrl="https://managedAclExtensionRequestFlowUrl.dclmodel"
 echo "Add Model with VID: $vid PID: $pid"
-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)
+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)
 result=$(get_txn_result "$result")
 check_response "$result" "\"code\": 0"
 echo "$result"
@@ -84,7 +84,7 @@ check_response "$result" "\"vid\": $vid"
 check_response "$result" "\"pid\": $pid"
 check_response "$result" "\"productLabel\": \"$productLabel\""
 check_response "$result" "\"schemaVersion\": $schema_version_2"
-check_response "$result" "\"commissionerRemoteUiFlowUrl\": \"$commissionerRemoteUiFlowURL\""
+check_response "$result" "\"managedAclExtensionRequestFlowUrl\": \"$managedAclExtensionRequestFlowUrl\""
 echo "$result"
 
 echo "Get Model with VID: $vid_with_pids PID: $pid"
@@ -130,12 +130,12 @@ echo "$result"
 
 test_divider
 
-echo "Update Model with VID: ${vid} PID: ${pid} with new description, commissionerRemoteUiFlowURL and commissioningModeInitialStepsHint"
+echo "Update Model with VID: ${vid} PID: ${pid} with new description, managedAclExtensionRequestFlowUrl and commissioningModeInitialStepsHint"
 description="New Device Description"
 schema_version_3=3
-newCommissionerRemoteUiFlowURL="https://commissionerRemoteUiFlowURL.dclmodel.updated"
+newManagedAclExtensionRequestFlowUrl="https://managedAclExtensionRequestFlowUrl.dclmodel.updated"
 newCommissioningModeInitialStepsHint=8
-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")
+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")
 result=$(get_txn_result "$result")
 check_response "$result" "\"code\": 0"
 echo "$result"
@@ -156,7 +156,7 @@ check_response "$result" "\"vid\": $vid"
 check_response "$result" "\"pid\": $pid"
 check_response "$result" "\"productLabel\": \"$description\""
 check_response "$result" "\"schemaVersion\": $schema_version_3"
-check_response "$result" "\"commissionerRemoteUiFlowUrl\": \"$newCommissionerRemoteUiFlowURL\""
+check_response "$result" "\"managedAclExtensionRequestFlowUrl\": \"$newManagedAclExtensionRequestFlowUrl\""
 check_response "$result" "\"commissioningModeInitialStepsHint\": $newCommissioningModeInitialStepsHint"
 echo "$result"
 

diff --git a/proto/zigbeealliance/distributedcomplianceledger/dclauth/grant.proto b/proto/zigbeealliance/distributedcomplianceledger/dclauth/grant.proto
@@ -9,5 +9,6 @@ message Grant {
   string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; 
   int64 time = 2; // number of nanoseconds elapsed since January 1, 1970 UTC
   string info = 3;
+  uint32 schemaVersion = 4;
 }
 
diff --git a/proto/zigbeealliance/distributedcomplianceledger/dclupgrade/grant.proto b/proto/zigbeealliance/distributedcomplianceledger/dclupgrade/grant.proto
@@ -9,5 +9,6 @@ message Grant {
   string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; 
   int64 time = 2; // number of nanoseconds elapsed since January 1, 1970 UTC
   string info = 3;
+  uint32 schemaVersion = 4;
 }
 
diff --git a/proto/zigbeealliance/distributedcomplianceledger/model/model.proto b/proto/zigbeealliance/distributedcomplianceledger/model/model.proto
@@ -25,6 +25,6 @@ message Model {
   int32 lsfRevision = 17;
   string creator = 18 [(cosmos_proto.scalar) = "cosmos.AddressString"];
   uint32 schemaVersion = 19;
-  string commissionerRemoteUiFlowUrl = 20;
+  string managedAclExtensionRequestFlowUrl = 20;
 }
 
diff --git a/proto/zigbeealliance/distributedcomplianceledger/model/product.proto b/proto/zigbeealliance/distributedcomplianceledger/model/product.proto
@@ -8,4 +8,5 @@ message Product {
   int32 pid = 1; 
   string name = 2; 
   string partNumber = 3;
+  uint32 schemaVersion = 4;
 }
diff --git a/proto/zigbeealliance/distributedcomplianceledger/model/tx.proto b/proto/zigbeealliance/distributedcomplianceledger/model/tx.proto
@@ -41,7 +41,7 @@ message MsgCreateModel {
   string productUrl = 16 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
   string lsfUrl = 17 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
   uint32 schemaVersion = 18 [(gogoproto.moretags) = "validate:\"gte=0,lte=65535\""];
-  string commissionerRemoteUiFlowUrl = 19 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
+  string managedAclExtensionRequestFlowUrl = 19 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
 }
 message MsgCreateModelResponse {}
 
@@ -62,7 +62,7 @@ message MsgUpdateModel {
   string lsfUrl = 13 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
   int32 lsfRevision = 14 [(gogoproto.moretags) = "validate:\"gte=0,lte=65535\""];
   uint32 schemaVersion = 15 [(gogoproto.moretags) = "validate:\"gte=0,lte=65535\""];
-  string commissionerRemoteUiFlowUrl = 16 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
+  string managedAclExtensionRequestFlowUrl = 16 [(gogoproto.moretags) = "validate:\"omitempty,url,startsnotwith=http:,max=256\""];
   uint32 commissioningModeInitialStepsHint = 17;
 }
 message MsgUpdateModelResponse {}

diff --git a/proto/zigbeealliance/distributedcomplianceledger/pki/grant.proto b/proto/zigbeealliance/distributedcomplianceledger/pki/grant.proto
@@ -9,5 +9,6 @@ message Grant {
   string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; 
   int64 time = 2; // number of nanoseconds elapsed since January 1, 1970 UTC
   string info = 3;
+  uint32 schemaVersion = 4;
 }
 
diff --git a/proto/zigbeealliance/distributedcomplianceledger/validator/grant.proto b/proto/zigbeealliance/distributedcomplianceledger/validator/grant.proto
@@ -9,4 +9,5 @@ message Grant {
   string address = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"]; 
   int64 time = 2; // number of nanoseconds elapsed since January 1, 1970 UTC
   string info = 3;
+  uint32 schemaVersion = 4;
 }
diff --git a/ts-client/zigbeealliance.distributedcomplianceledger.dclauth/rest.ts b/ts-client/zigbeealliance.distributedcomplianceledger.dclauth/rest.ts
@@ -31,6 +31,9 @@ export interface DclauthGrant {
    */
   time?: string;
   info?: string;
+
+  /** @format int64 */
+  schemaVersion?: number;
 }
 
 export type DclauthMsgApproveAddAccountResponse = object;

diff --git a/...omplianceledger.dclauth/types/zigbeealliance/distributedcomplianceledger/dclauth/grant.ts b/...omplianceledger.dclauth/types/zigbeealliance/distributedcomplianceledger/dclauth/grant.ts
@@ -9,10 +9,11 @@ export interface Grant {
   /** number of nanoseconds elapsed since January 1, 1970 UTC */
   time: number;
   info: string;
+  schemaVersion: number;
 }
 
 function createBaseGrant(): Grant {
-  return { address: "", time: 0, info: "" };
+  return { address: "", time: 0, info: "", schemaVersion: 0 };
 }
 
 export const Grant = {
@@ -26,6 +27,9 @@ export const Grant = {
     if (message.info !== "") {
       writer.uint32(26).string(message.info);
     }
+    if (message.schemaVersion !== 0) {
+      writer.uint32(32).uint32(message.schemaVersion);
+    }
     return writer;
   },
 
@@ -45,6 +49,9 @@ export const Grant = {
         case 3:
           message.info = reader.string();
           break;
+        case 4:
+          message.schemaVersion = reader.uint32();
+          break;
         default:
           reader.skipType(tag & 7);
           break;
@@ -58,6 +65,7 @@ export const Grant = {
       address: isSet(object.address) ? String(object.address) : "",
       time: isSet(object.time) ? Number(object.time) : 0,
       info: isSet(object.info) ? String(object.info) : "",
+      schemaVersion: isSet(object.schemaVersion) ? Number(object.schemaVersion) : 0,
     };
   },
 
@@ -66,6 +74,7 @@ export const Grant = {
     message.address !== undefined && (obj.address = message.address);
     message.time !== undefined && (obj.time = Math.round(message.time));
     message.info !== undefined && (obj.info = message.info);
+    message.schemaVersion !== undefined && (obj.schemaVersion = Math.round(message.schemaVersion));
     return obj;
   },
 
@@ -74,6 +83,7 @@ export const Grant = {
     message.address = object.address ?? "";
     message.time = object.time ?? 0;
     message.info = object.info ?? "";
+    message.schemaVersion = object.schemaVersion ?? 0;
     return message;
   },
 };

diff --git a/ts-client/zigbeealliance.distributedcomplianceledger.dclupgrade/rest.ts b/ts-client/zigbeealliance.distributedcomplianceledger.dclupgrade/rest.ts
@@ -18,6 +18,9 @@ export interface DclupgradeGrant {
    */
   time?: string;
   info?: string;
+
+  /** @format int64 */
+  schemaVersion?: number;
 }
 
 export type DclupgradeMsgApproveUpgradeResponse = object;

diff --git a/...nceledger.dclupgrade/types/zigbeealliance/distributedcomplianceledger/dclupgrade/grant.ts b/...nceledger.dclupgrade/types/zigbeealliance/distributedcomplianceledger/dclupgrade/grant.ts
@@ -9,10 +9,11 @@ export interface Grant {
   /** number of nanoseconds elapsed since January 1, 1970 UTC */
   time: number;
   info: string;
+  schemaVersion: number;
 }
 
 function createBaseGrant(): Grant {
-  return { address: "", time: 0, info: "" };
+  return { address: "", time: 0, info: "", schemaVersion: 0 };
 }
 
 export const Grant = {
@@ -26,6 +27,9 @@ export const Grant = {
     if (message.info !== "") {
       writer.uint32(26).string(message.info);
     }
+    if (message.schemaVersion !== 0) {
+      writer.uint32(32).uint32(message.schemaVersion);
+    }
     return writer;
   },
 
@@ -45,6 +49,9 @@ export const Grant = {
         case 3:
           message.info = reader.string();
           break;
+        case 4:
+          message.schemaVersion = reader.uint32();
+          break;
         default:
           reader.skipType(tag & 7);
           break;
@@ -58,6 +65,7 @@ export const Grant = {
       address: isSet(object.address) ? String(object.address) : "",
       time: isSet(object.time) ? Number(object.time) : 0,
       info: isSet(object.info) ? String(object.info) : "",
+      schemaVersion: isSet(object.schemaVersion) ? Number(object.schemaVersion) : 0,
     };
   },
 
@@ -66,6 +74,7 @@ export const Grant = {
     message.address !== undefined && (obj.address = message.address);
     message.time !== undefined && (obj.time = Math.round(message.time));
     message.info !== undefined && (obj.info = message.info);
+    message.schemaVersion !== undefined && (obj.schemaVersion = Math.round(message.schemaVersion));
     return obj;
   },
 
@@ -74,6 +83,7 @@ export const Grant = {
     message.address = object.address ?? "";
     message.time = object.time ?? 0;
     message.info = object.info ?? "";
+    message.schemaVersion = object.schemaVersion ?? 0;
     return message;
   },
 };

diff --git a/ts-client/zigbeealliance.distributedcomplianceledger.model/rest.ts b/ts-client/zigbeealliance.distributedcomplianceledger.model/rest.ts
@@ -44,7 +44,7 @@ export interface DistributedcomplianceledgermodelModel {
 
   /** @format int64 */
   schemaVersion?: number;
-  commissionerRemoteUiFlowUrl?: string;
+  managedAclExtensionRequestFlowUrl?: string;
 }
 
 export interface DistributedcomplianceledgermodelModelVersion {
@@ -121,6 +121,9 @@ export interface ModelProduct {
   pid?: number;
   name?: string;
   partNumber?: string;
+
+  /** @format int64 */
+  schemaVersion?: number;
 }
 
 export interface ModelQueryAllModelResponse {

diff --git a/...tedcomplianceledger.model/types/zigbeealliance/distributedcomplianceledger/model/model.ts b/...tedcomplianceledger.model/types/zigbeealliance/distributedcomplianceledger/model/model.ts
@@ -23,7 +23,7 @@ export interface Model {
   lsfRevision: number;
   creator: string;
   schemaVersion: number;
-  commissionerRemoteUiFlowUrl: string;
+  managedAclExtensionRequestFlowUrl: string;
 }
 
 function createBaseModel(): Model {
@@ -47,7 +47,7 @@ function createBaseModel(): Model {
     lsfRevision: 0,
     creator: "",
     schemaVersion: 0,
-    commissionerRemoteUiFlowUrl: "",
+    managedAclExtensionRequestFlowUrl: "",
   };
 }
 
@@ -110,8 +110,8 @@ export const Model = {
     if (message.schemaVersion !== 0) {
       writer.uint32(152).uint32(message.schemaVersion);
     }
-    if (message.commissionerRemoteUiFlowUrl !== "") {
-      writer.uint32(162).string(message.commissionerRemoteUiFlowUrl);
+    if (message.managedAclExtensionRequestFlowUrl !== "") {
+      writer.uint32(162).string(message.managedAclExtensionRequestFlowUrl);
     }
     return writer;
   },
@@ -181,7 +181,7 @@ export const Model = {
           message.schemaVersion = reader.uint32();
           break;
         case 20:
-          message.commissionerRemoteUiFlowUrl = reader.string();
+          message.managedAclExtensionRequestFlowUrl = reader.string();
           break;
         default:
           reader.skipType(tag & 7);
@@ -222,8 +222,8 @@ export const Model = {
       lsfRevision: isSet(object.lsfRevision) ? Number(object.lsfRevision) : 0,
       creator: isSet(object.creator) ? String(object.creator) : "",
       schemaVersion: isSet(object.schemaVersion) ? Number(object.schemaVersion) : 0,
-      commissionerRemoteUiFlowUrl: isSet(object.commissionerRemoteUiFlowUrl)
-        ? String(object.commissionerRemoteUiFlowUrl)
+      managedAclExtensionRequestFlowUrl: isSet(object.managedAclExtensionRequestFlowUrl)
+        ? String(object.managedAclExtensionRequestFlowUrl)
         : "",
     };
   },
@@ -255,8 +255,8 @@ export const Model = {
     message.lsfRevision !== undefined && (obj.lsfRevision = Math.round(message.lsfRevision));
     message.creator !== undefined && (obj.creator = message.creator);
     message.schemaVersion !== undefined && (obj.schemaVersion = Math.round(message.schemaVersion));
-    message.commissionerRemoteUiFlowUrl !== undefined
-      && (obj.commissionerRemoteUiFlowUrl = message.commissionerRemoteUiFlowUrl);
+    message.managedAclExtensionRequestFlowUrl !== undefined
+      && (obj.managedAclExtensionRequestFlowUrl = message.managedAclExtensionRequestFlowUrl);
     return obj;
   },
 
@@ -281,7 +281,7 @@ export const Model = {
     message.lsfRevision = object.lsfRevision ?? 0;
     message.creator = object.creator ?? "";
     message.schemaVersion = object.schemaVersion ?? 0;
-    message.commissionerRemoteUiFlowUrl = object.commissionerRemoteUiFlowUrl ?? "";
+    message.managedAclExtensionRequestFlowUrl = object.managedAclExtensionRequestFlowUrl ?? "";
     return message;
   },
 };