Skip to content

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

Description

@BryanttV

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: #424

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions