[OAK-3728] Document indexes in the index itself

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.2.19, 1.3.13, 1.4
• Component/s: query
• Assignee: Thomas Mueller
• Reporter: Thomas Mueller
• Created: 04/Dec/15 09:48
• Updated: 17/Aug/16 13:59
• Resolved: 09/Dec/15 08:12

Description

Out-of-the box indexes should be documented, so that people know why they are needed. This is mainly needed for Oak indexes; we don't need to enforce this for user defined indexes.

To do that, for each index, a property "info" could be added. Example:

/oak:index/nodetype/info = "Oak index used for ..."

Issue Links

• relates to: OAK-3751 Limit the unique index "authorizableId" to the "rep:Authorizable" nodetype