Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ Unreleased
Added
=====

* Added an optional ``hidden`` flag to permission categories and permissions in the authorization
schema. Hidden permissions, and the permissions of hidden categories, are left out of the
role and permission catalog, including each role's permission list, but keep their role grants
and permission checks.
* Added the static authorization schema, a versioned YAML format for declaring permissions,
permission categories, roles, and role extensions (ADR 0017). The permissions and roles
previously defined in ``authz.policy`` are expressed as schema files under
Expand Down
6 changes: 6 additions & 0 deletions docs/references/authorization-schema-json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ Permission category fields
.. jsonschema:: ../../src/openedx_authz/engine/schema/authz-schema-v1.json#/$defs/permission_category/properties/icon
:lift_description:

.. jsonschema:: ../../src/openedx_authz/engine/schema/authz-schema-v1.json#/$defs/permission_category/properties/hidden
:lift_description:

Permission fields
*****************

Expand All @@ -69,6 +72,9 @@ Permission fields
.. jsonschema:: ../../src/openedx_authz/engine/schema/authz-schema-v1.json#/$defs/permission/properties/icon
:lift_description:

.. jsonschema:: ../../src/openedx_authz/engine/schema/authz-schema-v1.json#/$defs/permission/properties/hidden
:lift_description:

Role fields
***********

Expand Down
Loading
Loading