Skip to content

Commit 7c0d757

Browse files
committed
docs: update documentation for glob pattern format
1 parent a08f22c commit 7c0d757

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

openedx_authz/api/data.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ class OrgLibraryGlobData(ContentLibraryData):
529529
"""Organization-level glob pattern for content libraries.
530530
531531
This class represents glob patterns that match multiple libraries within an organization.
532-
Format: 'lib:ORG:*' where ORG is a valid organization identifier.
532+
Format: ``lib:ORG:*`` where ORG is a valid organization identifier.
533533
534534
The glob pattern allows granting permissions to all libraries within a specific organization
535535
without needing to specify each library individually.
@@ -538,15 +538,15 @@ class OrgLibraryGlobData(ContentLibraryData):
538538
NAMESPACE (str): Inherited 'lib' from ContentLibraryData.
539539
ID_SEPARATOR (str): ':' for content library scopes.
540540
IS_GLOB (bool): True for organization-level glob patterns.
541-
external_key (str): The glob pattern (e.g., 'lib:DemoX:*').
542-
namespaced_key (str): The pattern with namespace (e.g., 'lib^lib:DemoX:*').
541+
external_key (str): The glob pattern (e.g., ``lib:DemoX:*``).
542+
namespaced_key (str): The pattern with namespace (e.g., ``lib^lib:DemoX:*``).
543543
544544
Validation Rules:
545-
- Must end with GLOBAL_SCOPE_WILDCARD (*)
546-
- Must have format 'lib:ORG:*' (exactly one organization identifier)
545+
- Must end with GLOBAL_SCOPE_WILDCARD (``*``)
546+
- Must have format ``lib:ORG:*`` (exactly one organization identifier)
547547
- The organization must exist in at least one ContentLibrary
548548
- Wildcard can only appear at the end after org identifier
549-
- Cannot have wildcards at slug level (lib:ORG:SLUG* is invalid)
549+
- Cannot have wildcards at slug level (``lib:ORG:SLUG*`` is invalid)
550550
551551
Examples:
552552
>>> glob = OrgLibraryGlobData(external_key='lib:DemoX:*')
@@ -565,7 +565,7 @@ def org(self) -> str | None:
565565
"""Get the organization identifier from the glob pattern.
566566
567567
Returns:
568-
str: The organization identifier (e.g., 'DemoX' from 'lib:DemoX:*'), None otherwise.
568+
str: The organization identifier (e.g., ``DemoX`` from ``lib:DemoX:*``), None otherwise.
569569
"""
570570
return self.get_org(self.external_key)
571571

@@ -574,7 +574,7 @@ def validate_external_key(cls, external_key: str) -> bool:
574574
"""Validate the external_key format for organization-level library globs.
575575
576576
Args:
577-
external_key (str): The external key to validate (e.g., 'lib:DemoX:*').
577+
external_key (str): The external key to validate (e.g., ``lib:DemoX:*``).
578578
579579
Returns:
580580
bool: True if the format is valid, False otherwise.
@@ -604,7 +604,7 @@ def get_org(cls, external_key: str) -> str | None:
604604
external_key (str): The external key to extract the organization identifier from.
605605
606606
Returns:
607-
str: The organization identifier (e.g., 'DemoX' from 'lib:DemoX:*'), None otherwise.
607+
str: The organization identifier (e.g., ``DemoX`` from ``lib:DemoX:*``), None otherwise.
608608
"""
609609
suffix = cls.ID_SEPARATOR + GLOBAL_SCOPE_WILDCARD
610610
if not external_key.endswith(suffix):
@@ -776,7 +776,7 @@ class OrgCourseGlobData(CourseOverviewData):
776776
namespaced_key (str): The pattern with namespace (e.g., 'course-v1^course-v1:OpenedX+*').
777777
778778
Validation Rules:
779-
- Must end with GLOBAL_SCOPE_WILDCARD (*)
779+
- Must end with GLOBAL_SCOPE_WILDCARD (``*``)
780780
- Must have format 'course-v1:ORG+*' (exactly one organization identifier)
781781
- The organization must exist in at least one CourseOverview
782782
- Wildcard can only appear at the end after org identifier

0 commit comments

Comments
 (0)