openedx / openedx/openedx-authz

Implement extraction and translation of static YAML authz metadata (Internationalization)

Open
#432 0 comments 0 reactions 1 assignee View on GitHub

@BryanttV is already working on this.

Since Sep 2, 2026.

willow
Dominant language
Python
Stars
0
Forks
9
Avg merge
13d 9h
Merged PRs (30d)
9

Description

Description

The authz schema contains the display names and descriptions shown for static roles, permissions, and permission categories. Currently, applications contribute these strings via YAML files.

Problem

Because these strings are defined in YAML, standard Python and JavaScript extraction tools cannot find them automatically. This leaves them out of the standard localization workflow.

Proposed Solution

Implement the ADR to bring static authorization metadata into the existing OEP-58 translation process. The goal is to make user-facing text translatable while keeping stable system identifiers intact.

Acceptance Criteria
  • Configure an extraction mechanism to parse YAML files and isolate schema fields as independent, translatable messages.
  • Route the extracted messages through the openedx-translations pipeline and Atlas.
  • Update the API to evaluate the requested language and return the correctly translated strings (display names and descriptions).
  • Write tests confirming the API serves the correct language and that stable identifiers remain completely unchanged in all responses.

Proposed ADR: https://github.com/openedx/openedx-authz/pull/424

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.