Review and cleanup Module Descriptor for mod-patron

Description

To support automatic capabilities creation and keep FOLIO permission usage consistent, it is suggested that all module descriptors be reviewed and inconsistencies in permission namings and usage be fixed.

can help teams with finding such problems in the module descriptor.

If the module is not a java based - https://github.com/folio-org/folio-module-descriptor-validator/blob/master/scripts/module-descriptor-batch-validator/README.md

Permission naming convention for renaming - https://folio-org.atlassian.net/wiki/spaces/FOLIJET/pages/156368925/Permissions+naming+convention

How to rename a permission:

Rules for Module Descriptor:

  • Permission name according to the convention

  • One permission can be used to protect only one endpoint

  • An endpoint should be protected by 0-1 permissions

  • Permission with sub-permissions(Permission set) can’t be used for endpoint protection

Scope:

  • Add plugin to the modules pom file and run build

  • Fix problems in module descriptor according to the Permission naming convention or rules

  • If the module is not a java based - run local scripts and fix the module descriptor

Environment

None

Potential Workaround

None

Checklist

hide

Activity

Show:

Raman Auramau September 26, 2024 at 12:13 PM

Scope for review and correction based on information from the report:

  • mod-patron-6.2.0-SNAPSHOT.136

    • Permission protects more than one endpoint: patron.account.item.get [/patron/account/{accountId} [GET], /patron/account [GET], /patron/account/by-email/{email} [GET]]

    • Permission is not defined in module descriptor: patron.account.item.post

Done

Details

Assignee

Reporter

Priority

Story Points

Sprint

Development Team

Vega

Fix versions

Release

Ramsons (R2 2024)

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs

Created September 26, 2024 at 12:13 PM
Updated December 1, 2024 at 3:52 PM
Resolved November 25, 2024 at 8:30 AM
TestRail: Cases
TestRail: Runs