Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add PII model annotations #95

Merged
merged 1 commit into from
Nov 27, 2024
Merged

docs: Add PII model annotations #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions milestones/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ class Milestone(TimeStampedModel):
Milestones can be used to drive functionality and behavior 'behind
the scenes' in Open edX, such as with the Pre-Requisite Course and
Course Entrance Exam use cases.

.. no_pii:
"""
namespace = models.CharField(max_length=255, db_index=True)
name = models.CharField(max_length=255, db_index=True)
Expand Down Expand Up @@ -52,6 +54,8 @@ class MilestoneRelationshipType(TimeStampedModel):
This same process of indicating MilestoneRelationshipTypes can be
applied to other learning objects as well, such as course content
(XBlocks/modules).

.. no_pii:
"""
# name = models.CharField(max_length=255, db_index=True, unique=True)

Expand Down Expand Up @@ -82,6 +86,8 @@ class CourseMilestone(TimeStampedModel):
below. In addition, a MilestoneRelationshipType specifies the
particular sort of relationship that exists between the Course and
the Milestone, such as "requires".

.. no_pii:
"""
course_id = models.CharField(max_length=255, db_index=True)
milestone = models.ForeignKey(Milestone, db_index=True, on_delete=models.CASCADE)
Expand All @@ -107,6 +113,8 @@ class CourseContentMilestone(TimeStampedModel):
ones. In addition, a MilestoneRelationshipType specifies the
particular sort of relationship that exists between the Milestone
and the CourseContent, such as "requires" or "fulfills".

.. no_pii:
"""
course_id = models.CharField(max_length=255, db_index=True)
content_id = models.CharField(max_length=255, db_index=True)
Expand Down Expand Up @@ -143,6 +151,8 @@ class UserMilestone(TimeStampedModel):
The 'source' field was originally introduced as a free-form auditing
field to document the method, location, or event which triggered the
collection of the milestone by this user.

.. no_pii:
"""
user_id = models.IntegerField(db_index=True)
milestone = models.ForeignKey(Milestone, db_index=True, on_delete=models.CASCADE)
Expand Down