learningequality / learningequality/le-utils
Reinstitute common embed definitions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 36
- PR merge metrics
- No merged PRs in 30d
Description
❌ This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.
Current behavior
We rolled back separating some common schema definitions (solely a UUID definition) into a separate file because it was not supporting both frontend and backend usage.
Desired behavior
Separate out some common embed definitions, including more than just the previous UUID definition, and structure it similarly to how completion criteria uses mastery criteria, such that we can utilize the schemas on both the frontend and backend.
- Since le-utils does not have a hard requirement on
jsonschemaitself, any usage should be overly defensive on it not being installed
Value add
- DRY
Possible tradeoffs
- Complexity of separating schema definitions into more than 2 files
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 reviewing the rolled-back changes in PR #172 and the existing completion-criteria/mastery-criteria structure referenced in the issue. Identify where common embed schemas are defined and how both frontend and backend consumers access them; done means the shared definitions cover more than UUID and remain safe when jsonschema is not installed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100