docs: add ADR for persisted competency deletability signal#661
docs: add ADR for persisted competency deletability signal#661mgwozdz-unicon wants to merge 1 commit into
Conversation
Decides how API clients learn a competency guardrail record (Taxonomy, Tag, ObjectTag, CompetencyCriteriaGroup, CompetencyCriteria) is delete-protected before attempting a delete: a persisted, monotonic `deletable` boolean set at learner-status write time, rather than computed per-request or cached.
|
Thanks for the pull request, @mgwozdz-unicon! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Why
openedx-core#655 proposes how to enforce the
delete/edit guardrails ADR-0002 and ADR-0003 already decided for competency taxonomy data, and
raised surfacing a
deletablesignal on the relevant GET endpoints so Studio can disable/warn onthe delete action instead of only discovering the block from a failed request. How to compute that
signal turned into a real design question (read-time cost vs. write-path complexity), so it gets
its own ADR rather than staying an implementation detail of that issue.
Summary
deletableboolean on the five delete-protected models (Taxonomy,CompetencyTaxonomy,Tag,ObjectTag,CompetencyCriteriaGroup,CompetencyCriteria) ratherthan computing it per-request or caching it.
TruetoFalseonly, never back), set synchronously in the sametransaction as the learner-status write that triggers it. No cache-invalidation logic needed as a
result.
can already be non-deletable.
itself.
Exists()/OuterRef()annotation, andcaching that computed value with a TTL.
Related to #655.