From 1536d2df9faafed5fcafc1788781df5636bef31d Mon Sep 17 00:00:00 2001
From: Brian Mesick <bmesick@tcril.org>
Date: Mon, 25 Nov 2024 13:12:40 -0500
Subject: [PATCH] docs: Add PII annotations

Per OEP-30 these annotations should live with the models, just moving
them here from the edx-platform safelist.
---
 edxval/models.py | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/edxval/models.py b/edxval/models.py
index 56b0ac9b..1c14af64 100644
--- a/edxval/models.py
+++ b/edxval/models.py
@@ -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,
@@ -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(
@@ -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)
@@ -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)
@@ -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()
@@ -419,6 +429,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()
@@ -612,6 +624,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(
@@ -656,6 +670,8 @@ def __str__(self):
 class ThirdPartyTranscriptCredentialsState(TimeStampedModel):
     """
     State of transcript credentials for a course organization
+
+    .. no_pii:
     """
 
     class Meta: