HBASE-28525 Extended REST Documentation: Stateless Scanner, table exists, multiget with filter #6498

PDavid · 2024-11-28T12:42:30Z

Added the following to the REST API documentation:

Table exists endpoint (GET /table/exists)
Stateless Scanner endpoint (the documentation for this was based on the patch of https://issues.apache.org/jira/browse/HBASE-10346)
filter and filter_b64 parameters for multiget endpoint
"suffixGlobbing" endpoints (GET /table/row_prefix*/column)
append operation
increment operation
includeStartRow and includeStopRow stateless scanner parameters

Other changes:

Updated REST XML Schema and REST Protobufs Schema in documentation
Updated XMLSchema.xsd with the latest changes

Do you maybe see some other REST endpoints not documented?

src/main/asciidoc/_chapters/external_apis.adoc

hbase-rest/src/main/resources/org/apache/hadoop/hbase/rest/XMLSchema.xsd

src/main/asciidoc/_chapters/external_apis.adoc

PDavid · 2024-12-04T07:37:22Z

The org.apache.hadoop.hbase.regionserver.TestRegionServerReportForDuty unit test failed in the PR build - it is unrelated as the only Java code change was removing two TODO comments.

stoty

Thanks for doing this.

I requested a few changes and clarifications.

src/main/asciidoc/_chapters/external_apis.adoc

As it is now documented.

…r parameters to REST Documentation

…mentation

implementing code review suggestion.

… scanner so that it's clear which patch is required to support: - filter_b64 - includeStartRow - includeStopRow

stoty

+1 LGTM

I haven't checked the rendered documents, I assume that you did, and formatting has not been broken.

PDavid · 2024-12-05T09:38:21Z

+1 LGTM

I haven't checked the rendered documents, I assume that you did, and formatting has not been broken.

Many thanks! 👍
Yes, I generated the book.html from the source and checked it thoroughly. The formatting was good (not broken).

src/main/asciidoc/_chapters/external_apis.adoc

NihalJain · 2024-12-06T06:46:51Z

+1, LGTM, please fix table # numbering before merging

Added missing '.'

As it was before so it is more consistent with other table titles.

Apache-HBase · 2024-12-06T09:04:29Z

🎊 +1 overall

Vote	Subsystem	Runtime	Logfile	Comment
+0 🆗	reexec	0m 18s		Docker mode activated.
			_ Prechecks _
+1 💚	dupname	0m 0s		No case conflicting files found.
+0 🆗	codespell	0m 0s		codespell was not available.
+0 🆗	detsecrets	0m 0s		detect-secrets was not available.
+1 💚	@author	0m 0s		The patch does not contain any @author tags.
+1 💚	hbaseanti	0m 0s		Patch does not have any anti-patterns.
			_ master Compile Tests _
+0 🆗	mvndep	0m 14s		Maven dependency ordering for branch
+1 💚	mvninstall	2m 39s		master passed
+1 💚	compile	7m 18s		master passed
+1 💚	checkstyle	1m 0s		master passed
+1 💚	spotbugs	7m 36s		master passed
+0 🆗	refguide	1m 58s		branch has no errors when building the reference guide. See footer for rendered docs, which you should manually inspect.
+1 💚	spotless	0m 39s		branch has no errors when running spotless:check.
			_ Patch Compile Tests _
+0 🆗	mvndep	0m 11s		Maven dependency ordering for patch
+1 💚	mvninstall	2m 33s		the patch passed
+1 💚	compile	7m 19s		the patch passed
+1 💚	javac	7m 19s		the patch passed
+1 💚	blanks	0m 0s		The patch has no blanks issues.
+1 💚	checkstyle	1m 2s		the patch passed
+1 💚	spotbugs	7m 50s		the patch passed
+0 🆗	refguide	1m 55s		patch has no errors when building the reference guide. See footer for rendered docs, which you should manually inspect.
+1 💚	hadoopcheck	9m 6s		Patch does not cause any errors with Hadoop 3.3.6 3.4.0.
+1 💚	spotless	0m 39s		patch has no errors when running spotless:check.
			_ Other Tests _
+1 💚	asflicense	0m 21s		The patch does not generate ASF License warnings.
		58m 36s

Subsystem	Report/Notes
Docker	ClientAPI=1.47 ServerAPI=1.47 base: https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-6498/6/artifact/yetus-general-check/output/Dockerfile
GITHUB PR	#6498
Optional Tests	dupname asflicense javac spotbugs checkstyle codespell detsecrets compile hadoopcheck hbaseanti spotless refguide
uname	Linux c403d04bf46b 5.4.0-200-generic #220-Ubuntu SMP Fri Sep 27 13:19:16 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux
Build tool	maven
Personality	dev-support/hbase-personality.sh
git revision	master / `14fef35`
Default Java	Eclipse Adoptium-17.0.11+9
refguide	https://nightlies.apache.org/hbase/HBase-PreCommit-GitHub-PR/PR-6498/6/yetus-general-check/output/branch-site/book.html
refguide	https://nightlies.apache.org/hbase/HBase-PreCommit-GitHub-PR/PR-6498/6/yetus-general-check/output/patch-site/book.html
Max. process+thread count	192 (vs. ulimit of 30000)
modules	C: hbase-rest . U: .
Console output	https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-6498/6/console
versions	git=2.34.1 maven=3.9.8 spotbugs=4.7.3
Powered by	Apache Yetus 0.15.0 https://yetus.apache.org

This message was automatically generated.

Apache-HBase · 2024-12-06T13:19:47Z

🎊 +1 overall

Vote	Subsystem	Runtime	Logfile	Comment
+0 🆗	reexec	0m 27s		Docker mode activated.
-0 ⚠️	yetus	0m 2s		Unprocessed flag(s): --brief-report-file --spotbugs-strict-precheck --author-ignore-list --blanks-eol-ignore-file --blanks-tabs-ignore-file --quick-hadoopcheck
			_ Prechecks _
			_ master Compile Tests _
+0 🆗	mvndep	0m 24s		Maven dependency ordering for branch
+1 💚	mvninstall	2m 55s		master passed
+1 💚	compile	2m 1s		master passed
+1 💚	javadoc	2m 6s		master passed
+1 💚	shadedjars	5m 34s		branch has no errors when building our shaded downstream artifacts.
			_ Patch Compile Tests _
+0 🆗	mvndep	0m 11s		Maven dependency ordering for patch
+1 💚	mvninstall	2m 52s		the patch passed
+1 💚	compile	2m 2s		the patch passed
+1 💚	javac	2m 2s		the patch passed
+1 💚	javadoc	2m 8s		the patch passed
+1 💚	shadedjars	5m 35s		patch has no errors when building our shaded downstream artifacts.
			_ Other Tests _
+1 💚	unit	281m 12s		root in the patch passed.
		313m 50s

Subsystem	Report/Notes
Docker	ClientAPI=1.43 ServerAPI=1.43 base: https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-6498/6/artifact/yetus-jdk17-hadoop3-check/output/Dockerfile
GITHUB PR	#6498
Optional Tests	javac javadoc unit compile shadedjars
uname	Linux 7df418d5ec70 5.4.0-1103-aws #111~18.04.1-Ubuntu SMP Tue May 23 20:04:10 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
Build tool	maven
Personality	dev-support/hbase-personality.sh
git revision	master / `14fef35`
Default Java	Eclipse Adoptium-17.0.11+9
Test Results	https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-6498/6/testReport/
Max. process+thread count	8667 (vs. ulimit of 30000)
modules	C: hbase-rest . U: .
Console output	https://ci-hbase.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-6498/6/console
versions	git=2.34.1 maven=3.9.8
Powered by	Apache Yetus 0.15.0 https://yetus.apache.org

This message was automatically generated.

NihalJain · 2024-12-09T07:38:59Z

Hi @PDavid is this good to merge?

PDavid · 2024-12-09T07:56:46Z

Hi @PDavid is this good to merge?

Hi @NihalJain!
Thanks, yes, I think the PR is ready to merge. @stoty said that he will merge it at latest tomorrow.

stoty · 2024-12-09T08:31:31Z

But of course you are also welcome to merge this @NihalJain .

NihalJain · 2024-12-09T08:51:27Z

Hi @PDavid is this good to merge?

Hi @NihalJain! Thanks, yes, I think the PR is ready to merge. @stoty said that he will merge it at latest tomorrow.

Ah cool. Was just checking!

But of course you are also welcome to merge this @NihalJain .

Please go ahead @stoty.

…s, multiget with filter (#6498) Signed-off-by: Nihal Jain <[email protected]> Signed-off-by: Istvan Toth <[email protected]> (cherry picked from commit 126f723)

…s, multiget with filter (apache#6498) Signed-off-by: Nihal Jain <[email protected]> Signed-off-by: Istvan Toth <[email protected]>

…s, multiget with filter (apache#6498) Signed-off-by: Nihal Jain <[email protected]> Signed-off-by: Istvan Toth <[email protected]> (cherry picked from commit 126f723)

PDavid changed the title ~~HBASE-28525 Extended REST Documentation~~ HBASE-28525 Extended REST Documentation: Stateless Scanner, table exists, multiget with filter Nov 28, 2024

PDavid marked this pull request as ready for review December 2, 2024 09:29

PDavid force-pushed the HBASE-28525-document-REST-endpoints branch from 884dfc8 to c7a04ec Compare December 2, 2024 09:30

PDavid commented Dec 2, 2024

View reviewed changes

src/main/asciidoc/_chapters/external_apis.adoc Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

PDavid marked this pull request as draft December 3, 2024 09:43

This comment has been minimized.

Sign in to view

PDavid commented Dec 3, 2024

View reviewed changes

hbase-rest/src/main/resources/org/apache/hadoop/hbase/rest/XMLSchema.xsd Show resolved Hide resolved

PDavid commented Dec 3, 2024

View reviewed changes

src/main/asciidoc/_chapters/external_apis.adoc Show resolved Hide resolved

This comment has been minimized.

Sign in to view

PDavid marked this pull request as ready for review December 4, 2024 07:37

stoty requested changes Dec 5, 2024

View reviewed changes

PDavid added 12 commits December 5, 2024 10:05

HBASE-28525 Added "GET /table/exists" to REST documentation

9154289

HBASE-28525 Added REST documentation for Stateless Scanner endpoint

5c8f120

HBASE-28525 Removed TODO from TableResource.getScanResource()

7352d25

As it is now documented.

HBASE-28525 Added "suffixGlobbing" endpoints to REST Documentation

122b51c

HBASE-28525 Added append operation to REST Documentation

33accdd

HBASE-28525 Added increment operation to REST Documentation

7ba2a68

HBASE-28525 Added includeStartRow and includeStopRow stateless scanne…

8ae82af

…r parameters to REST Documentation

HBASE-28525 Updated REST XML Schema and REST Protobufs Schema in docu…

1909628

…mentation

HBASE-28525 Updated XMLSchema.xsd with the latest changes

52d7b8d

HBASE-28525 Improved naming of scanner operation REST endpoints

8c57b5e

implementing code review suggestion.

HBASE-28525 Added note with ticket ID for new parameters of stateless…

1b98ced

… scanner so that it's clear which patch is required to support: - filter_b64 - includeStartRow - includeStopRow

HBASE-28525 Added note to stateless endpoint about result size

745c5c7

PDavid force-pushed the HBASE-28525-document-REST-endpoints branch from 4ba6020 to 745c5c7 Compare December 5, 2024 09:05

stoty approved these changes Dec 5, 2024

View reviewed changes

This comment has been minimized.

Sign in to view

NihalJain reviewed Dec 6, 2024

View reviewed changes

src/main/asciidoc/_chapters/external_apis.adoc Outdated Show resolved Hide resolved

NihalJain approved these changes Dec 6, 2024

View reviewed changes

PDavid added 2 commits December 6, 2024 08:47

HBASE-28525 Fixed table # numbering

38c77ea

Added missing '.'

HBASE-28525 Highlight Scan operation name in table title

14fef35

As it was before so it is more consistent with other table titles.

stoty merged commit 126f723 into apache:master Dec 9, 2024
1 check passed

PDavid deleted the HBASE-28525-document-REST-endpoints branch December 9, 2024 09:12

HBASE-28525 Extended REST Documentation: Stateless Scanner, table exists, multiget with filter #6498

HBASE-28525 Extended REST Documentation: Stateless Scanner, table exists, multiget with filter #6498

Uh oh!

Conversation

PDavid commented Nov 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

PDavid commented Dec 4, 2024

Uh oh!

stoty left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stoty left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PDavid commented Dec 5, 2024

Uh oh!

This comment has been minimized.

This comment has been minimized.

Uh oh!

NihalJain commented Dec 6, 2024

Uh oh!

Apache-HBase commented Dec 6, 2024

Uh oh!

Apache-HBase commented Dec 6, 2024

Uh oh!

NihalJain commented Dec 9, 2024

Uh oh!

PDavid commented Dec 9, 2024

Uh oh!

stoty commented Dec 9, 2024

Uh oh!

NihalJain commented Dec 9, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

PDavid commented Nov 28, 2024 •

edited

Loading

stoty left a comment •

edited

Loading