Features/threshold in response #68
Conversation
bento_beacon/utils/censorship.py
Outdated
| @@ -2,6 +2,13 @@ | |||
| from .exceptions import APIException, InvalidQuery | |||
|
|
|||
|
|
|||
| def no_results_censorship_message(): | |||
| return ( | |||
| "No results. Either none were found, or the query produced results numbering at " | |||
There was a problem hiding this comment.
this might get a bit weird with translation - maybe there should be two info messages in order or something... although translating anything with a dynamic count threshold is going to be weird. maybe we need a separate field in info with the configured threshold, and set some flag in info if we show a message regarding the threshold.
There was a problem hiding this comment.
Ah, I wasn't going to propose translating this at all, since:
- it's the API json response, which is always English (even when searching in French in the front end)
- if a user-facing translation is needed somewhere (eg in bento_public), it can be translated there rather than in the API
- if bento public actually needs explicit mention of censorship, it needs to be somewhere other than hidden in an api response
There was a problem hiding this comment.
yes I dont think the response itself needs to be translated, but having a dynamic message (i.e., a changing threshold) means it's hard to translate on the bento_public end - if the threshold is set in the response and a flag can be set to show a special second info box with the threshold included, it would be easier to translate on that end
There was a problem hiding this comment.
Well, there's only one item that changes, and it's in a fixed spot, so this is easily translated in two chunks.
At any rate, I don't expect bento_public to handle this message at all. This is intended only for people using beacon without a UI; if bento_public needs a message like this at all it should probably be mentioned in an "about" section or somewhere else.
|
Now split into two messages |
Mention censorship threshold in beacon response. (Redmine #1918)
A short message is added to all searches with no results. The same message is given whether censorship was applied or not (the true results may be zero, or some amount within the threshold for censorship that was then changed to zero). Mentioning it only when censorship is applied would be a data leak.
Despite the text in the ticket, there is no point adding this message to all responses, this is just noise if results are above the threshold. It could be added to e.g. service-info if it needs to be advertised more broadly.