Add @searchable annotation to denote which API entities should be visible in Search...

[civicrm-core.git] / Civi / Api4 / Generic / Traits / OptionList.php

diff --git a/Civi/Api4/Generic/Traits/OptionList.php b/Civi/Api4/Generic/Traits/OptionList.php
index fb400cc55eef077f20e432fd3c6580664617f510..70936e0119af9d24111cc5f86f304978e16e0405 100644 (file)
--- a/Civi/Api4/Generic/Traits/OptionList.php
+++ b/Civi/Api4/Generic/Traits/OptionList.php
@@ -15,6 +15,9 @@ namespace Civi\Api4\Generic\Traits;
  * An optionList is a small entity whose primary purpose is to supply a semi-static list of options to fields in other entities.
  *
  * The options appear in the field metadata for other entities that reference this one via pseudoconstant.
+ *
+ * Note: At time of writing, this trait does nothing except toggle the searchable flag, (and adds "OptionList" to the "type" in Entity::get() metadata).
+ * @searchable false (FYI annotation isn't functional because this is a trait - workaround in AbstractEntity::getInfo)
  */
 trait OptionList {