openedx / openedx/openedx-platform
History Log: Unify entripoints
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
In the REST API for the history log, we can unify:
blocks/<key>/draft_history/withcontainers/<key>/draft_history/blocks/<key>/publish_history/withcontainers/<key>/publish_history/blocks/<key>/creation_entry/withcontainers/<key>/creation_entry/
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the REST API handlers for the listed blocks and containers history-log endpoints and compare their current routes and behavior. Done means the paired draft_history, publish_history, and creation_entry entry points are unified without changing their intended responses, with the relevant API tests passing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100