Copilot commented on code in PR #19019:
URL: https://github.com/apache/pinot/pull/19019#discussion_r3738069489
##########
pinot-spi/src/main/java/org/apache/pinot/spi/query/QueryExecutionContext.java:
##########
@@ -85,6 +88,17 @@ public enum QueryType {
/// Guards single-emission of the scan-based killing dry-run log line and
metric for this query
private final AtomicBoolean _scanKillingDryRunEmitted = new
AtomicBoolean(false);
+ /// Generic, product-agnostic response metadata registered during query
handling — a free-form
+ /// string-to-[JsonNode] map that any component can populate to surface an
informational note about
+ /// how the query was handled (for example that it was executed with an
alternate/degraded
+ /// strategy). Values are arbitrary JSON, so a note can be a scalar, an
object, or an array. It is
+ /// read by the broker when assembling the
[org.apache.pinot.common...BrokerResponse]. This context
Review Comment:
The Javadoc references `org.apache.pinot.common...BrokerResponse` (with an
ellipsis) from `pinot-spi`, which renders poorly and looks like a placeholder.
Since `pinot-spi` shouldn’t depend on `pinot-common`, consider rewording this
sentence to avoid the pseudo type link and just describe the behavior in plain
text.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
