openedx / openedx/frontend-app-authoring
Multiple API endpoints for courseDetails
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 17
- Forks
- 218
- Avg merge
- 9d 20h
- Merged PRs (30d)
- 20
Description
There are multiple endpoints for the "same" course details functionality:
- https://github.com/openedx/frontend-app-authoring/blob/master/src/course-outline/data/api.ts#L22
- https://github.com/openedx/frontend-app-authoring/blob/master/src/data/api.ts#L5
- https://github.com/openedx/frontend-app-authoring/blob/master/src/schedule-and-details/data/api.ts#L6
Check if it's possible to use only one endpoint and place it generically so that it can be used in all those locations
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
Compare the course-details API definitions in src/course-outline/data/api.ts, src/data/api.ts, and src/schedule-and-details/data/api.ts. Determine whether they represent the same endpoint and identify the generic location that can serve all three areas. Done means the duplicated definitions are replaced by one shared endpoint without changing course-details behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, frontend
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100