Skip to content

MODWRKFLOW-68: Fix permission names and bring in folio-module-descriptor-validator.#159

Merged
kaladay merged 1 commit into
masterfrom
MODWRKFLOW-68
Jul 1, 2026
Merged

MODWRKFLOW-68: Fix permission names and bring in folio-module-descriptor-validator.#159
kaladay merged 1 commit into
masterfrom
MODWRKFLOW-68

Conversation

@kaladay

@kaladay kaladay commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

MODWRKFLOW-68

Remove all of the *.all permissions as they are now recommended against directly in the tech council module acceptance criteria.

Use only 4 sections (first.second.third.fourth).

  1. The first is always workflow (also known as module prefix).
  2. The second is dependent on the purpose, but maintains the current design and now uses underscores (also known as resource).
  3. The third must either bey item or collection (also known as scope).
  4. The fourth is one of the allowed verbs, generally REST verbs (also known as action).

An underscore instead of a dash is used so that only word characters are used in this group and so that the expansion expands with spaces instead of dashes.

The action verbs, like activate, are technical valid as per the documentation. However, modules like folio-module-descriptor-validator and ecosystems like Eureka do not treat these as such. The unsupported verbs, such as activate, are simply moved into the second section using underscores.

This brings in folio-module-descriptor-validator with the appropriate plugin repository and latest version.

see: https://folio-org.atlassian.net/wiki/spaces/FOLIJET/pages/156368925/Permissions+naming+convention#Use-of-punctuation
see: https://folio-org.atlassian.net/wiki/spaces/TC/pages/1626144774/Permission+Naming+Guidelines

…tor-validator.

Remove all of the `*.all` permissions as they are now recommended against directly in the tech council module acceptance criteria.

Use only 4 sections (`first.second.third.fourth`).
  1. The first is always `workflow` (also known as module prefix).
  2. The second is dependent on the purpose, but maintains the current design and now uses underscores (also known as resource).
  3. The third must either bey `item` or `collection` (also known as scope).
  4. The fourth is one of the allowed verbs, generally **REST** verbs (also known as action).

An underscore instead of a dash is used so that only word characters are used in this group and so that the expansion expands with spaces instead of dashes.

The action verbs, like `activate`, are technical valid as per the documentation.
However, modules like `folio-module-descriptor-validator` and ecosystems like **Eureka** do not treat these as such.
The unsupported verbs, such as `activate`, are simply moved into the second section using underscores.

This brings in `folio-module-descriptor-validator` with the appropriate plugin repository and latest version.

see: https://folio-org.atlassian.net/wiki/spaces/FOLIJET/pages/156368925/Permissions+naming+convention#Use-of-punctuation
see: https://folio-org.atlassian.net/wiki/spaces/TC/pages/1626144774/Permission+Naming+Guidelines
@kaladay kaladay requested a review from a team July 1, 2026 19:13
@sonarqubecloud

sonarqubecloud Bot commented Jul 1, 2026

Copy link
Copy Markdown

@kaladay kaladay merged commit 56d22d6 into master Jul 1, 2026
16 checks passed
@kaladay kaladay deleted the MODWRKFLOW-68 branch July 1, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants