Skip to content

Commit

Permalink
chore: warn users about sending empty filter values when deleting keys (
Browse files Browse the repository at this point in the history
#669)

* Add additional warning for sending empty filters in `q` param

* Moved warning under all params

* Remove extra space

* Updated copy.
  • Loading branch information
hahmed-dev authored Aug 16, 2024
1 parent c218fc2 commit 2685b58
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion doc/compiled.json
Original file line number Diff line number Diff line change
Expand Up @@ -21325,7 +21325,7 @@
}
},
{
"description": "Specify a query to do broad search for keys by name (including wildcards).<br><br>\nThe following qualifiers are also supported in the search term:<br>\n<ul>\n <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>\n <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>\n <li><code>tags:tag_name</code> to filter for keys with certain tags</li>\n <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>\n <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>\n <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>\n</ul>\nFind more examples <a href=\"#overview--usage-examples\">here</a>.\n",
"description": "Specify a query to do broad search for keys by name (including wildcards).<br><br>\nThe following qualifiers are also supported in the search term:<br>\n<ul>\n <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>\n <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>\n <li><code>tags:tag_name</code> to filter for keys with certain tags</li>\n <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>\n <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>\n <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li>\n</ul>\n<br/>\n<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>\n<br/>\nFind more examples <a href=\"#overview--usage-examples\">here</a>.\n",
"example": "mykey* translated:true",
"name": "q",
"in": "query",
Expand Down
3 changes: 3 additions & 0 deletions paths/keys/destroy-collection.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ parameters:
<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
Expand Down

0 comments on commit 2685b58

Please sign in to comment.