techdocsmith commented on a change in pull request #11761:
URL: https://github.com/apache/druid/pull/11761#discussion_r720473435
##########
File path: docs/querying/sql.md
##########
@@ -949,10 +949,14 @@ You can additionally request a header by setting "header"
to true in your reques
}
```
-In this case, the first result returned will be a header. For the `csv`,
`array`, and `arrayLines` formats, the header
+In this case, the first result of the response body returned will be a header.
For the `csv`, `array`, and `arrayLines` formats, the header
Review comment:
```suggestion
In this case, the first result of the response body is the header row. For
the `csv`, `array`, and `arrayLines` formats, the header
```
##########
File path: docs/querying/sql.md
##########
@@ -871,13 +871,13 @@ Submit your query as the value of a "query" field in the
JSON object within the
{"query" : "SELECT COUNT(*) FROM data_source WHERE foo = 'bar'"}
```
-##### Request
+##### Request body
|Property|Description|Default|
|--------|----|-----------|
|`query`|SQL query string.| none (required)|
|`resultFormat`|Format of query results. See [Responses](#responses) for
details.|`"object"`|
-|`header`|Whether or not to include a header. See [Responses] for
details.|`false`|
+|`header`|Whether or not to include a header for the query result. See
[Responses](#responses) for details.|`false`|
Review comment:
```suggestion
|`header`|Whether or not to include a header row for the query result. See
[Responses](#responses) for details.|`false`|
```
I think saying header row helps with the differentiation.
--
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]
