Skip to content

Commit

Permalink
feat!: Removed org and number fields from CourseCatalogData (#95)
Browse files Browse the repository at this point in the history
These are redundant with course key and can be added back in later if we
actually need them.

This is a breaking change but it should only affect event-bus code that
hasn't yet been merged.

See discussion here:
#72 (comment)
  • Loading branch information
timmc-edx authored Aug 16, 2022
1 parent 3cfb09b commit 18e7ade
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,13 @@ Change Log
Unreleased
----------

[0.12.0] - 2022-08-16
---------------------
Changed
~~~~~~~
* **Breaking change**: Removed ``org`` and ``number`` fields from ``CourseCatalogData``
(should only affect unreleased event-bus code, though)

[0.11.1] - 2022-07-28
---------------------
Expand Down
2 changes: 1 addition & 1 deletion openedx_events/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
more information about the project.
"""

__version__ = "0.11.1"
__version__ = "0.12.0"
4 changes: 0 additions & 4 deletions openedx_events/content_authoring/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ class CourseCatalogData:
Arguments:
course_key (CourseKey): identifier of the Course object.
name (str): course name
org (str): course organization identifier
number (str): course number
schedule_data (CourseScheduleData): scheduling information for the course
short_description (str): one- or two-sentence course description (optional)
effort (str): estimated level of effort in hours per week (optional). Kept as a str to align with the lms model.
Expand All @@ -53,8 +51,6 @@ class CourseCatalogData:
# basic identifiers
course_key = attr.ib(type=CourseKey)
name = attr.ib(type=str)
number = attr.ib(type=str)
org = attr.ib(type=str)

# additional marketing information
schedule_data = attr.ib(type=CourseScheduleData)
Expand Down

0 comments on commit 18e7ade

Please sign in to comment.