DR-000002 - Tenant Id and Module Name Restrictions

Owned by Julian Ladisch
Last updated: May 06, 2024 by Jenn Colt
Submitted Date

 

Approved Date

 

StatusACCEPTED
ImpactLOW

RFC - n/a

Other Related Resources

Contributors

Approvers

Background/Context

See https://folio-org.atlassian.net/wiki/display/DD/Tenant+Id+and+Module+Name+Restrictions

Assumptions

See https://folio-org.atlassian.net/wiki/display/DD/Tenant+Id+and+Module+Name+Restrictions

Constraints

See https://folio-org.atlassian.net/wiki/display/DD/Tenant+Id+and+Module+Name+Restrictions

Decision

Limit tenant id to 31 bytes. Disallow underscore in tenant id. Regexp: [a-z][a-z0-9]{0,30}

Restrictions for back-end module names:

  • Module name can contain only lowercase letters, digits and minus. Start with a letter. Disallow minus followed by a digit or a minus.
  • Limit module name to 31 bytes. Disallow uppercase letters. Disallow underscore.
  • Regexp: [a-z]([a-z0-9]|-(?=[a-z])){0,30}
  • Disallow these module names: catalog, date, role, time, timestamp, user

Implications