Skip to content

Commit

Permalink
docs: Add PII annotations
Browse files Browse the repository at this point in the history
Per OEP-30 these annotations should live with the models, just moving
them here from the edx-platform safelist.
  • Loading branch information
bmtcril committed Feb 18, 2025
1 parent b7c5db6 commit 642d337
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions edxval/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ class Profile(models.Model):
The profile_name has a regex validator because in case this field will be
used in a url.
.. no_pii:
"""
profile_name = models.CharField(
max_length=50,
Expand Down Expand Up @@ -100,6 +102,8 @@ class Video(models.Model):
Attributes:
status: Used to keep track of the processing video as it goes through
the video pipeline, e.g., "Uploading", "File Complete"...
.. no_pii:
"""
created = models.DateTimeField(auto_now_add=True)
edx_video_id = models.CharField(
Expand Down Expand Up @@ -157,6 +161,8 @@ class CourseVideo(models.Model, ModelFactoryWithValidation):
Every course-semester has a unique course_id. A video can be paired with
multiple course_id's but each pair is unique together.
.. no_pii:
"""
course_id = models.CharField(max_length=255)
video = models.ForeignKey(Video, related_name='courses', on_delete=models.CASCADE)
Expand Down Expand Up @@ -184,6 +190,8 @@ def __str__(self):
class EncodedVideo(models.Model):
"""
Video/encoding pair
.. no_pii:
"""
created = models.DateTimeField(auto_now_add=True)
modified = models.DateTimeField(auto_now=True)
Expand Down Expand Up @@ -300,6 +308,8 @@ def deconstruct(self):
class VideoImage(TimeStampedModel):
"""
Image model for course video.
.. no_pii:
"""
course_video = models.OneToOneField(CourseVideo, related_name="video_image", on_delete=models.CASCADE)
image = CustomizableImageField()
Expand Down Expand Up @@ -426,6 +436,8 @@ def deconstruct(self):
class VideoTranscript(TimeStampedModel):
"""
Transcript for a video
.. no_pii:
"""
video = models.ForeignKey(Video, related_name='video_transcripts', null=True, on_delete=models.CASCADE)
transcript = CustomizableFileField()
Expand Down Expand Up @@ -619,6 +631,8 @@ class ThreePlayTurnaround:
class TranscriptPreference(TimeStampedModel):
"""
Third Party Transcript Preferences for a Course
.. no_pii:
"""
course_id = models.CharField(verbose_name='Course ID', max_length=255, unique=True)
provider = models.CharField(
Expand Down Expand Up @@ -663,6 +677,8 @@ def __str__(self):
class ThirdPartyTranscriptCredentialsState(TimeStampedModel):
"""
State of transcript credentials for a course organization
.. no_pii:
"""

class Meta:
Expand Down

0 comments on commit 642d337

Please sign in to comment.