Skip to content

docs: add missing JSON field rowSignature in response examples when u…#17618

Merged
kgyrtkirk merged 2 commits intoapache:masterfrom
thomas-dufour:fix-issue-17586
Feb 27, 2025
Merged

docs: add missing JSON field rowSignature in response examples when u…#17618
kgyrtkirk merged 2 commits intoapache:masterfrom
thomas-dufour:fix-issue-17586

Conversation

@thomas-dufour
Copy link
Copy Markdown
Contributor

docs: add missing JSON field rowSignature in response examples when using scan queries

Fixes #17586.

Description

I found out the documentation about scan queries was out of date. Therefore, I updated the documentation with the actual response format returned by a local Druid v31.

@@ -45,10 +45,10 @@ An example Scan query object is shown below:
"resultFormat": "list",
"columns":[],
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about selecting just a few columns? so that the data/signature doesn't fill half the screen?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did that. If we want the rowSignature to be even more compact, I can format it a bit differently (but the format will not be at linter standard)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah - I also hate the terse json formatting...some time ago I was playing with jackson to make it a bit nicer everywhere on a branch - but it was so outside of scope with what I was doing so I reverted those changes.

the relevant commit is here feel free to pick it up - I don't have time to finish it.

I guess the change in the above commit aren't linter standard either :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just to be clear, I can't tell if you are expecting me to do something more. Can we resolve this thread?

Also, should I do anything more after your approbation?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just mentioning that - that's all :)

@kgyrtkirk
Copy link
Copy Markdown
Member

note: you could just add further commits and avoid force push - the PR will be squashed on merge anyway

@kgyrtkirk
Copy link
Copy Markdown
Member

@thomas-dufour: your email address tdufo...@wi...ind.io is not associated with github ; if I merge it right now it will attribute it to 1082...59+thomas-du...ur@users.noreply.github.com.

You could associate that email address with your gh account following this doc - or would you like me to go ahead and merge it as-is?

@thomas-dufour
Copy link
Copy Markdown
Contributor Author

@thomas-dufour: your email address tdufo...@wi...ind.io is not associated with github ; if I merge it right now it will attribute it to 1082...59+thomas-du...ur@users.noreply.github.com.

You could associate that email address with your gh account following this doc - or would you like me to go ahead and merge it as-is?

Ah thanks, I set it as public. It should appears clearly now

@kgyrtkirk kgyrtkirk merged commit 8f65662 into apache:master Feb 27, 2025
6 checks passed
@kgyrtkirk
Copy link
Copy Markdown
Member

thank you for fixing this @thomas-dufour ! :)

@kgyrtkirk kgyrtkirk added this to the 33.0.0 milestone Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Scan queries documentation examples are missing the json key rowSignature

2 participants