[solr] branch branch_9x updated: Mention uniqueKey requirement for highlighting (#714)

[ep...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

epugh pushed a commit to branch branch_9x
in repository https://gitbox.apache.org/repos/asf/solr.git


The following commit(s) were added to refs/heads/branch_9x by this push:
     new cb78371  Mention uniqueKey requirement for highlighting (#714)
cb78371 is described below

commit cb78371d2420cdf30b658117ea1c6fe4812dc5fc
Author: Radu Gheorghe <ra...@sematext.com>
AuthorDate: Fri Mar 4 21:00:03 2022 +0200

    Mention uniqueKey requirement for highlighting (#714)
    
    * Mention uniqueKey requirement for highlighting
    
    This one is hard to catch because there's no error if you set `hl=on` and there's no `uniqueKey`. You just don't see a `highlighting` element in the response.
    
    * Rework phrasing a bit to communicate clearer the requirement for uniqueKey.
    
    Co-authored-by: epugh@opensourceconnections.com <>
---
 solr/solr-ref-guide/modules/query-guide/pages/highlighting.adoc | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/solr/solr-ref-guide/modules/query-guide/pages/highlighting.adoc b/solr/solr-ref-guide/modules/query-guide/pages/highlighting.adoc
index 911385d..88f561d 100644
--- a/solr/solr-ref-guide/modules/query-guide/pages/highlighting.adoc
+++ b/solr/solr-ref-guide/modules/query-guide/pages/highlighting.adoc
@@ -27,8 +27,10 @@ Nonetheless, highlighting is very simple to use.
 
 == Usage
 
+Highlighting requires that you have a `uniqueKey` defined in your xref:indexing-guide:schema-elements.adoc[schema].
+
 === Common Highlighter Parameters
-You only need to set the `hl` and often `hl.fl` parameters to get results.
+You need to set the `hl` and often `hl.fl` parameters to enable highlighting results to be returned.
 The following table documents these and some other supported parameters.
 Note that many highlighting parameters support per-field overrides, such as: `f._title_txt_.hl.snippets`.