Review and cleanup Module Descriptors for mod-remote-storage

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.

https://github.com/folio-org/folio-module-descriptor-validator 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

  • 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 module is not a java based - run local scripts and fix module descriptor

Environment

None

Potential Workaround

None

Checklist

hide

Activity

Show:

Gurleen Kaur1 October 28, 2024 at 5:16 AM

Except for the below permission and adding of the plugin in pom.xml the changes have been completed. No concrete decision taken for pubsub.events.post permission validation.

{ [ERROR] ""key"" : ""Permission is not defined in module descriptor"", [ERROR] ""value"" : ""pubsub.events.post"" [ERROR] }

CC: , ,

Gurleen Kaur1 September 12, 2024 at 7:28 AM

Hi ,
The validation errors for mod-remote-storage

Done

Details

Assignee

Reporter

Priority

Story Points

Sprint

Development Team

Volaris

Fix versions

Release

Ramsons (R2 2024)

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created September 4, 2024 at 10:28 AM
Updated October 30, 2024 at 1:55 PM
Resolved October 21, 2024 at 5:52 AM
TestRail: Cases
TestRail: Runs