docs(API): unmentioned_in multiple uploads works too #STRINGS-1379 (#778)

Author: jablan

doc/compiled.json

@@ -239,3 +239,25 @@ response_status_codes:
   required: false
   schema:
     type: string
+q:
+  description: |
+    Specify a query to do broad search for keys by name (including wildcards).<br><br>
+    The following qualifiers are also supported in the search term:<br>
+    <ul>
+      <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>
+      <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>
+      <li><code>tags:tag_name</code> to filter for keys with certain tags</li>
+      <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
+      <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
+      <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
+    </ul>
+    <br/>
+    <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p>
+    <br/>
+    Find more examples <a href="#overview--usage-examples">here</a>.
+  example: mykey* translated:true
+  name: q
+  in: query
+  schema:
+    type: string
+

parameters.yaml

@@ -13,26 +13,7 @@ parameters:
   in: query
   schema:
     type: string
-- description: |
-    Specify a query to do broad search for keys by name (including wildcards).<br><br>
-    The following qualifiers are also supported in the search term:<br>
-    <ul>
-      <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>
-      <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>
-      <li><code>tags:tag_name</code> to filter for keys with certain tags</li>
-      <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
-      <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
-      <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
-    </ul>
-    <br/>
-    <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p>
-    <br/>
-    Find more examples <a href="#overview--usage-examples">here</a>.
-  example: mykey* translated:true
-  name: q
-  in: query
-  schema:
-    type: string
+- "$ref": "../../parameters.yaml#/q"
 - description: Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
   example: abcd1234abcd1234abcd1234abcd1234
   name: locale_id

paths/keys/destroy-collection.yaml

@@ -63,7 +63,7 @@ requestBody:
                 <li><code>tags:tag_name</code> to filter for keys with certain tags</li>
                 <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
                 <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
-                <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
+                <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
               </ul>
               Find more examples <a href="#overview--usage-examples">here</a>.
             type: string

paths/keys/exclude.yaml

@@ -63,7 +63,7 @@ requestBody:
                 <li><code>tags:tag_name</code> to filter for keys with certain tags</li>
                 <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
                 <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
-                <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
+                <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
               </ul>
               Find more examples <a href="#overview--usage-examples">here</a>.
             type: string

paths/keys/include.yaml

@@ -27,25 +27,7 @@ parameters:
   in: query
   schema:
     type: string
-- description: |
-    Specify a query to do broad search for keys by name (including wildcards).<br><br>
-    The following qualifiers are also supported in the search term:<br>
-    <ul>
-      <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>
-      <li><code>name:key_name,...</code> for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li>
-      <li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li>
-      <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li>
-      <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li>
-      <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
-      <li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li>
-      <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
-    </ul>
-    Find more examples <a href="#overview--usage-examples">here</a>.
-  example: mykey* translated:true
-  name: q
-  in: query
-  schema:
-    type: string
+- "$ref": "../../parameters.yaml#/q"
 - description: Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
   example: abcd1234abcd1234abcd1234abcd1234
   name: locale_id

paths/keys/index.yaml

@@ -79,7 +79,7 @@ requestBody:
                 <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li>
                 <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
                 <li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li>
-                <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
+                <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
               </ul>
               Find more examples <a href="#overview--usage-examples">here</a>.
               Please note: If <code>tags</code> are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys.

paths/keys/search.yaml

@@ -63,7 +63,7 @@ requestBody:
                 <li><code>tags:tag_name</code> to filter for keys with certain tags</li>
                 <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
                 <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
-                <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
+                <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
               </ul>
               Find more examples <a href="#overview--usage-examples">here</a>.
             type: string

paths/keys/tag.yaml

@@ -63,7 +63,7 @@ requestBody:
                 <li><code>tags:tag_name</code> to filter for keys with certain tags</li>
                 <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>
                 <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>
-                <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>
+                <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li>
               </ul>
               Find more examples <a href="#overview--usage-examples">here</a>.
             type: string