fix: Add dart documentation

atsign-foundation · Mar 18, 2024 · a9389c2 · a9389c2
1 parent 8f44aee
commit a9389c2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/packages/at_commons/lib/src/verb/enroll_verb_builder.dart b/packages/at_commons/lib/src/verb/enroll_verb_builder.dart
@@ -36,7 +36,10 @@ class EnrollVerbBuilder extends AbstractVerbBuilder {
   String? encryptedDefaultSelfEncryptionKey;
   String? encryptedAPKAMSymmetricKey;
 
-  List<EnrollmentStatus>? enrollmentStatusFilter = EnrollmentStatus.values;
+  /// Filters enrollment requests according to the provided [EnrollmentStatus] criteria.
+  ///
+  /// Accepts a list of enrollment statuses, defaulting to all available status values.
+  List<EnrollmentStatus> enrollmentStatusFilter = EnrollmentStatus.values;
 
   @override
   String buildCommand() {

diff --git a/packages/at_commons/test/enroll_params_test.dart b/packages/at_commons/test/enroll_params_test.dart
@@ -55,12 +55,12 @@ void main() {
 
     test('A test to verify enroll list regex with params', () {
       String command =
-          'enroll:list:{"approvalStatusFilter":"[pending, approved]"}';
+          'enroll:list:{"enrollmentStatusFilter":"[pending, approved]"}';
       expect(RegExp(VerbSyntax.enroll).hasMatch(command), true);
 
       command = command.replaceAll('enroll:list:', '');
       var enrollParams = jsonDecode(command);
-      expect(enrollParams['approvalStatusFilter'], '[pending, approved]');
+      expect(enrollParams['enrollmentStatusFilter'], '[pending, approved]');
     });
 
     test('A test to verify enroll list regex without params', () {