Skip to content

Commit

Permalink
chore: add help text to serializer fields of bulk enrollments
Browse files Browse the repository at this point in the history
  • Loading branch information
justEhmadSaeed committed Jan 25, 2024
1 parent 3288a37 commit 4ea89b0
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions license_manager/apps/api/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -402,9 +402,18 @@ class EnterpriseEnrollmentWithLicenseSubsidyQueryParamsSerializer(serializers.Se
Serializer for the enterprise enrollment with license subsidy query params
"""

enterprise_customer_uuid = serializers.UUIDField(required=True)
enroll_all = serializers.BooleanField(required=False)
subscription_uuid = serializers.UUIDField(required=False)
enterprise_customer_uuid = serializers.UUIDField(
required=True,
help_text='The UUID of the associated enterprise customer',
)
enroll_all = serializers.BooleanField(
required=False,
help_text='A boolean indicating whether to enroll all learners or not',
)
subscription_uuid = serializers.UUIDField(
required=False,
help_text='The UUID of the subscription',
)

class Meta:
fields = [
Expand All @@ -425,6 +434,7 @@ class EnterpriseEnrollmentWithLicenseSubsidyRequestSerializer(serializers.Serial
),
allow_empty=False,
required=True,
help_text='an array of learners\' emails',
)
course_run_keys = serializers.ListField(
child=serializers.CharField(
Expand All @@ -433,8 +443,12 @@ class EnterpriseEnrollmentWithLicenseSubsidyRequestSerializer(serializers.Serial
),
allow_empty=False,
required=True,
help_text='an array of course run keys',
)
notify = serializers.BooleanField(
required=True,
help_text='a boolean indicating whether to notify learners or not',
)
notify = serializers.BooleanField(required=True)

class Meta:
fields = [
Expand Down

0 comments on commit 4ea89b0

Please sign in to comment.