[jira] [Created] (SOLR-14829) Default components are missing facet_module and terms in documentation

["Johannes Baiter (Jira)" <ji...@apache.org>]

Johannes Baiter created SOLR-14829:
--------------------------------------

             Summary: Default components are missing facet_module and terms in documentation
                 Key: SOLR-14829
                 URL: https://issues.apache.org/jira/browse/SOLR-14829
             Project: Solr
          Issue Type: Bug
      Security Level: Public (Default Security Level. Issues are Public)
          Components: documentation
    Affects Versions: 8.6.2
            Reporter: Johannes Baiter


The list of search components that are enabled by default is missing the {{facet_module}} and {{terms }}components. The terms component is instead listed under "other useful components", while the {{FacetModule}} is never listed anywhere in the documentation, despite it being neccessary for the JSON Facet API to work.

This is also how I stumbled upon this, I spent hours trying to figure out why JSON-based faceting was not working with my setup, after taking a glance at the {{SearchHandler}} source code based on a hunch, it became clear that my custom list of search components (created based on the list in the reference guide) was to blame.

A patch for the documentation gap is attached, but I think there are some other issues with the naming/documentation around the two faceting APIs that may be worth discussing:
 * The names {{facet_module}} / {{FacetModule}} are very misleading, since the documentation is always talking about the "JSON Facet API", but the term "JSON" does not appear in the name of the component nor does the component have any documentation attached that mentions this
 * Why is the {{FacetModule}} class located in the {{search.facet}} package while every single other search component included in the core is located in the {{handler.component package}}?



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org