docs: fix inaccuracies in ADR 0012 (non-nullable tag external_id) - #728
Conversation
Scope the import-format optionality claim to the REST API only, since import has always required an identifier per tag row. Strike the non-injective uppercase/underscore legibility example from the backfill algorithm, since it can collapse two distinct tag values onto the same external_id.
openedx-webhooks
added
the
open-source-contribution
|
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. |
3 participants
Summary
While drafting the implementation ticket that goes with ADR 0012, Claude flagged an inaccuracy and a concern in the decision text. This PR corrects them.
The "New tags going forward" bullet claimed both the REST API and import format keep
external_idoptional for the caller. That's wrong for import: the import format has always required an identifier for every tag row, rejected as empty otherwise, so this decision's auto-generation only applies to the API creation path. The bullet is reworded to reflect that.The backfill algorithm's example of transforming the copied value "for UI legibility" by uppercasing it and replacing spaces with underscores isn't injective: two distinct, legal tag values in the same taxonomy, for example
Wind InstrumentsandWind_Instruments, would both collapse toWIND_INSTRUMENTSunder that transform, producing exactly theexternal_idcollision this decision's collision-free argument is meant to rule out. The example is struck. The decision already states that no particular format or collision-resolution scheme is required, so removing the one unsafe example doesn't change what's actually required.Context
openedx_tagging) — the rename pathway this decision builds on, referenced by the "Institutions can replace an auto-generated value" bulletVerification
Rebuilt the docs with Sphinx (
python -m sphinx -b html . _build/html_check -W --keep-going) after each edit; build succeeds with no warnings on this file.