Latest generation

lib/metadatadef.pb.dart

@@ -1215,6 +1215,7 @@ class RestoreMetadatasRequest extends $pb.GeneratedMessage {
   @$pb.TagNumber(1)
   void clearRscID() => $_clearField(1);
 
+  /// Resource Identifier : ProjectID or SiteID
   @$pb.TagNumber(2)
   $core.bool get alterClickhouse => $_getBF(1);
   @$pb.TagNumber(2)

lib/restrictions.pb.dart

@@ -92,6 +92,7 @@ class Restriction extends $pb.GeneratedMessage {
   @$pb.TagNumber(1)
   void clearID() => $_clearField(1);
 
+  /// Unique identifier of the restriction.
   @$pb.TagNumber(2)
   $core.String get projectID => $_getSZ(1);
   @$pb.TagNumber(2)
@@ -101,6 +102,7 @@ class Restriction extends $pb.GeneratedMessage {
   @$pb.TagNumber(2)
   void clearProjectID() => $_clearField(2);
 
+  /// Identifier of the project the restriction belongs to.
   @$pb.TagNumber(3)
   RestrictionType get targetType => $_getN(2);
   @$pb.TagNumber(3)
@@ -110,6 +112,7 @@ class Restriction extends $pb.GeneratedMessage {
   @$pb.TagNumber(3)
   void clearTargetType() => $_clearField(3);
 
+  /// Determines how the restriction is applied (by user or by partner).
   @$pb.TagNumber(4)
   $core.String get name => $_getSZ(3);
   @$pb.TagNumber(4)
@@ -119,6 +122,7 @@ class Restriction extends $pb.GeneratedMessage {
   @$pb.TagNumber(4)
   void clearName() => $_clearField(4);
 
+  /// Human-readable name of the restriction.
   @$pb.TagNumber(5)
   $core.String get description => $_getSZ(4);
   @$pb.TagNumber(5)
@@ -128,6 +132,7 @@ class Restriction extends $pb.GeneratedMessage {
   @$pb.TagNumber(5)
   void clearDescription() => $_clearField(5);
 
+  /// Optional description providing context for the restriction.
   @$pb.TagNumber(6)
   $core.bool get status => $_getBF(5);
   @$pb.TagNumber(6)
@@ -137,9 +142,11 @@ class Restriction extends $pb.GeneratedMessage {
   @$pb.TagNumber(6)
   void clearStatus() => $_clearField(6);
 
+  /// Whether the restriction is currently active (true = enabled, false = disabled).
   @$pb.TagNumber(7)
   $pb.PbList<$1.Rule> get rules => $_getList(6);
 
+  /// List of RPL rules that make up this restriction.
   @$pb.TagNumber(8)
   $core.String get updatedAt => $_getSZ(7);
   @$pb.TagNumber(8)
@@ -149,6 +156,7 @@ class Restriction extends $pb.GeneratedMessage {
   @$pb.TagNumber(8)
   void clearUpdatedAt() => $_clearField(8);
 
+  /// Timestamp of the last update (RFC 3339).
   @$pb.TagNumber(9)
   $core.String get createdAt => $_getSZ(8);
   @$pb.TagNumber(9)
@@ -205,6 +213,7 @@ class RestrictionComputeResult extends $pb.GeneratedMessage {
   @$pb.TagNumber(1)
   $pb.PbList<RuleComputeResult> get results => $_getList(0);
 
+  /// Computed results for each rule in the restriction, one entry per output format.
   @$pb.TagNumber(2)
   $core.String get restrictionID => $_getSZ(1);
   @$pb.TagNumber(2)
@@ -214,6 +223,7 @@ class RestrictionComputeResult extends $pb.GeneratedMessage {
   @$pb.TagNumber(2)
   void clearRestrictionID() => $_clearField(2);
 
+  /// Identifier of the restriction these results belong to.
   @$pb.TagNumber(3)
   $core.String get restrictionName => $_getSZ(2);
   @$pb.TagNumber(3)
@@ -279,6 +289,7 @@ class RuleComputeResult extends $pb.GeneratedMessage {
   @$pb.TagNumber(1)
   void clearFormat() => $_clearField(1);
 
+  /// Output format the rule was compiled into.
   @$pb.TagNumber(2)
   $core.String get value => $_getSZ(1);
   @$pb.TagNumber(2)
@@ -288,6 +299,7 @@ class RuleComputeResult extends $pb.GeneratedMessage {
   @$pb.TagNumber(2)
   void clearValue() => $_clearField(2);
 
+  /// Compiled rule expression in the target format.
   @$pb.TagNumber(3)
   $core.String get ruleID => $_getSZ(2);
   @$pb.TagNumber(3)
@@ -297,6 +309,7 @@ class RuleComputeResult extends $pb.GeneratedMessage {
   @$pb.TagNumber(3)
   void clearRuleID() => $_clearField(3);
 
+  /// Identifier of the rule this result was computed from.
   @$pb.TagNumber(4)
   $pb.PbList<$core.String> get attributes => $_getList(3);
 }
@@ -359,6 +372,7 @@ class RestrictionRule extends $pb.GeneratedMessage {
   @$pb.TagNumber(1)
   void clearName() => $_clearField(1);
 
+  /// Human-readable name of the rule.
   @$pb.TagNumber(2)
   $2.EntityType get entity => $_getN(1);
   @$pb.TagNumber(2)
@@ -368,6 +382,7 @@ class RestrictionRule extends $pb.GeneratedMessage {
   @$pb.TagNumber(2)
   void clearEntity() => $_clearField(2);
 
+  /// Entity type the rule applies to (e.g. ORDER, ACTOR).
   @$pb.TagNumber(3)
   $core.String get description => $_getSZ(2);
   @$pb.TagNumber(3)
@@ -377,6 +392,7 @@ class RestrictionRule extends $pb.GeneratedMessage {
   @$pb.TagNumber(3)
   void clearDescription() => $_clearField(3);
 
+  /// Optional description providing context for the rule.
   @$pb.TagNumber(4)
   $core.String get definition => $_getSZ(3);
   @$pb.TagNumber(4)
@@ -386,6 +402,7 @@ class RestrictionRule extends $pb.GeneratedMessage {
   @$pb.TagNumber(4)
   void clearDefinition() => $_clearField(4);
 
+  /// RPL (Reflex Platform Language) expression defining the rule logic.
   @$pb.TagNumber(5)
   $pb.PbList<$core.String> get attributes => $_getList(4);
 }

lib/restrictions.pbenum.dart

@@ -17,7 +17,9 @@ import 'package:protobuf/protobuf.dart' as $pb;
 /// RestrictionType determines the scope of a restriction's application.
 class RestrictionType extends $pb.ProtobufEnum {
   static const RestrictionType RESTRICTION_TYPE_UNKNOWN = RestrictionType._(0, _omitEnumNames ? '' : 'RESTRICTION_TYPE_UNKNOWN');
+  /// Default unset value. Should not be used explicitly.
   static const RestrictionType RESTRICTION_TYPE_USER = RestrictionType._(1, _omitEnumNames ? '' : 'RESTRICTION_TYPE_USER');
+  /// Restriction applies to individual users directly.
   static const RestrictionType RESTRICTION_TYPE_PARTNER = RestrictionType._(2, _omitEnumNames ? '' : 'RESTRICTION_TYPE_PARTNER');
 
   static const $core.List<RestrictionType> values = <RestrictionType> [
@@ -35,8 +37,11 @@ class RestrictionType extends $pb.ProtobufEnum {
 /// RuleComputeFormat specifies the query language into which a restriction rule is compiled.
 class RuleComputeFormat extends $pb.ProtobufEnum {
   static const RuleComputeFormat RULE_COMPUTE_FORMAT_UNKNOWN = RuleComputeFormat._(0, _omitEnumNames ? '' : 'RULE_COMPUTE_FORMAT_UNKNOWN');
+  /// Default unset value. Should not be used explicitly.
   static const RuleComputeFormat RULE_COMPUTE_FORMAT_CH = RuleComputeFormat._(1, _omitEnumNames ? '' : 'RULE_COMPUTE_FORMAT_CH');
+  /// ClickHouse SQL expression.
   static const RuleComputeFormat RULE_COMPUTE_FORMAT_OS = RuleComputeFormat._(2, _omitEnumNames ? '' : 'RULE_COMPUTE_FORMAT_OS');
+  /// OpenSearch query expression.
   static const RuleComputeFormat RULE_COMPUTE_FORMAT_JQ = RuleComputeFormat._(3, _omitEnumNames ? '' : 'RULE_COMPUTE_FORMAT_JQ');
 
   static const $core.List<RuleComputeFormat> values = <RuleComputeFormat> [

lib/rules.pb.dart

@@ -94,6 +94,7 @@ class Rule extends $pb.GeneratedMessage {
   @$pb.TagNumber(1)
   void clearID() => $_clearField(1);
 
+  /// Unique identifier of the rule.
   @$pb.TagNumber(2)
   $core.String get organisationID => $_getSZ(1);
   @$pb.TagNumber(2)
@@ -103,6 +104,7 @@ class Rule extends $pb.GeneratedMessage {
   @$pb.TagNumber(2)
   void clearOrganisationID() => $_clearField(2);
 
+  /// Identifier of the organisation the rule belongs to.
   @$pb.TagNumber(3)
   $1.EntityType get entity => $_getN(2);
   @$pb.TagNumber(3)
@@ -112,6 +114,7 @@ class Rule extends $pb.GeneratedMessage {
   @$pb.TagNumber(3)
   void clearEntity() => $_clearField(3);
 
+  /// Entity type the rule applies to (e.g. ORDER, ACTOR).
   @$pb.TagNumber(4)
   $core.String get name => $_getSZ(3);
   @$pb.TagNumber(4)
@@ -121,6 +124,7 @@ class Rule extends $pb.GeneratedMessage {
   @$pb.TagNumber(4)
   void clearName() => $_clearField(4);
 
+  /// Human-readable name of the rule.
   @$pb.TagNumber(5)
   $core.String get description => $_getSZ(4);
   @$pb.TagNumber(5)
@@ -130,6 +134,7 @@ class Rule extends $pb.GeneratedMessage {
   @$pb.TagNumber(5)
   void clearDescription() => $_clearField(5);
 
+  /// Optional description providing context for the rule.
   @$pb.TagNumber(6)
   $core.String get definition => $_getSZ(5);
   @$pb.TagNumber(6)
@@ -139,6 +144,7 @@ class Rule extends $pb.GeneratedMessage {
   @$pb.TagNumber(6)
   void clearDefinition() => $_clearField(6);
 
+  /// RPL (Reflex Platform Language) expression defining the rule logic.
   @$pb.TagNumber(7)
   RuleType get ruleType => $_getN(6);
   @$pb.TagNumber(7)
@@ -148,6 +154,7 @@ class Rule extends $pb.GeneratedMessage {
   @$pb.TagNumber(7)
   void clearRuleType() => $_clearField(7);
 
+  /// Category of the rule, determining how it is enforced.
   @$pb.TagNumber(8)
   $core.String get ruleTypeID => $_getSZ(7);
   @$pb.TagNumber(8)
@@ -157,6 +164,7 @@ class Rule extends $pb.GeneratedMessage {
   @$pb.TagNumber(8)
   void clearRuleTypeID() => $_clearField(8);
 
+  /// ID of the resource this rule is attached to. Its type depends on RuleType (e.g. a RestrictionID for RESTRICTION, a ProjectLifecycle task ID for PRUNE or ANONYMIZE).
   @$pb.TagNumber(9)
   $core.bool get status => $_getBF(8);
   @$pb.TagNumber(9)
@@ -166,6 +174,7 @@ class Rule extends $pb.GeneratedMessage {
   @$pb.TagNumber(9)
   void clearStatus() => $_clearField(9);
 
+  /// Whether the rule is currently active (true = enabled, false = disabled).
   @$pb.TagNumber(10)
   $pb.PbList<$core.String> get attributes => $_getList(9);
 }
@@ -303,6 +312,7 @@ class CreateRuleRequest extends $pb.GeneratedMessage {
   @$pb.TagNumber(8)
   void clearIssuer() => $_clearField(8);
 
+  /// Who created the rule, will be used as the commit's author when pushed to git
   @$pb.TagNumber(9)
   $pb.PbList<$core.String> get attributes => $_getList(8);
 }
@@ -464,6 +474,7 @@ class UpdateRuleRequest extends $pb.GeneratedMessage {
   @$pb.TagNumber(6)
   void clearIssuer() => $_clearField(6);
 
+  /// Who updated the rule, will be used as the commit's author when pushed to git
   @$pb.TagNumber(7)
   $pb.PbList<$core.String> get attributes => $_getList(6);
 }

lib/rules.pbenum.dart

@@ -17,8 +17,11 @@ import 'package:protobuf/protobuf.dart' as $pb;
 /// RuleType categorises rules by their enforcement behaviour within a project.
 class RuleType extends $pb.ProtobufEnum {
   static const RuleType RULE_TYPE_PROJECT_UNKNOWN = RuleType._(0, _omitEnumNames ? '' : 'RULE_TYPE_PROJECT_UNKNOWN');
+  /// Default unset value. Should not be used explicitly.
   static const RuleType RULE_TYPE_PROJECT_RESTRICTION = RuleType._(1, _omitEnumNames ? '' : 'RULE_TYPE_PROJECT_RESTRICTION');
+  /// Data-access restriction: filters which data a user or role can see.
   static const RuleType RULE_TYPE_PROJECT_PRUNE = RuleType._(2, _omitEnumNames ? '' : 'RULE_TYPE_PROJECT_PRUNE');
+  /// Prune: removes or archives entities based on defined conditions.
   static const RuleType RULE_TYPE_PROJECT_ANONYMIZE = RuleType._(3, _omitEnumNames ? '' : 'RULE_TYPE_PROJECT_ANONYMIZE');
 
   static const $core.List<RuleType> values = <RuleType> [