Skip to content

feat: add ADR 0002 and use-case registration API - #19

Closed
rpenido wants to merge 2 commits into
openedx:mainfrom
rpenido:search-schema-adr
Closed

rpenido wants to merge 2 commits into
openedx:mainfrom
rpenido:search-schema-adr

Conversation

@rpenido

@rpenido rpenido commented Oct 21, 2026 •

Copy link
Copy Markdown

Description

This PR adds ADR 0002 for openedx-search and 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, Capabilities and 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 own AppConfig.ready(). The library does not scan packages or auto-discover registrations.

Testing instructions

  • For now, the main review point is the ADR002. The implementation is a draft, so we can have a more tangible discussion
  • Additonally, you can run:
    • uv sync --group test
    • uv run --group test pytest

Other information

This branch is laid out against the open tooling cleanup in #2 so the two merge without conflicts.


Private ref:

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 21, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @rpenido!

This repository is currently maintained by @ormsbee.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If 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 PR

Your 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@rpenido

rpenido commented Oct 21, 2026

Copy link
Copy Markdown
Author

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.

@rpenido rpenido closed this Oct 21, 2026
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Oct 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

2 participants