Repository navigation
Conversation
|
Thanks for the pull request, @rpenido! 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. 🔘 Update the status of your PRYour PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate. Where 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. |
|
Closing in favour of #20, which uses the open-craft/openedx-search fork. GitHub does not allow changing a pull request's head repository, so the description was carried over verbatim. |
Description
This PR adds ADR 0002 for
openedx-searchand the first implementation of the contract it defines: the engine-neutral schema model and the use-case registration layer. The ADR settles how a use case declares its document schema and index settings, how registrations stay engine-neutral, how a deployment selects a backend, and how backends render and reconcile the declaration. It also records the alternatives considered with pros and cons, including the narrow flat-string backend contract and its benchmark in #3 and #4.The implementation provides
IndexSchema,Field,Capabilitiesand the settings blocks; a thread-safe in-memory use-case registry with validation; per-use-case backend resolution from deployment settings; and sample course and library schemas.Registrations are consumer-owned: a consumer calls
register_use_case(..., replace=True)from its ownAppConfig.ready(). The library does not scan packages or auto-discover registrations.Testing instructions
uv sync --group testuv run --group test pytestOther information
This branch is laid out against the open tooling cleanup in #2 so the two merge without conflicts.
Private ref: