Allow mergekey to be given for command=search
[pazpar2-moved-to-github.git] / doc / pazpar2_protocol.xml
index 8fb88cf..e227354 100644 (file)
@@ -390,6 +390,26 @@ search.pz2?session=2044502273&command=stat
      </varlistentry>
 
      <varlistentry>
+      <term>mergekey</term>
+      <listitem>
+       <para>
+       Sets mergekey for this search and rest of session, or until
+       another mergekey is given for show/search. The mergekey value is a
+       comma separated list with one or more names as they appear
+       in the service description  equivalent to
+       <literal>mergekey="optional"</literal> inside a metadata element.
+       If the empty string is given for mergekey it is disabled
+       and rest of session will use the default mergekey from service
+       or stylesheet.
+       </para>
+       <para>
+       This facility, "dynamic mergekey", appeared in Pazpar2 version
+       1.6.31.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
       <term>sort</term>
       <listitem>
        <para>
@@ -424,7 +444,7 @@ search.pz2?session=2044502273&command=stat
       <listitem>
        <para>
        Sets mergekey for this show and rest of session, or until
-       another mergekey is given for show. The mergekey value is a
+       another mergekey is given for show/search. The mergekey value is a
        comma separated list with one or more names as they appear
        in the service description  equivalent to
        <literal>mergekey="optional"</literal> inside a metadata element.