Skip to content

Fix REST web service parameter docs#7139

Merged
hansva merged 1 commit into
apache:mainfrom
BharatDeva:fix/rest-web-service-parameter-doc
May 18, 2026
Merged

Fix REST web service parameter docs#7139
hansva merged 1 commit into
apache:mainfrom
BharatDeva:fix/rest-web-service-parameter-doc

Conversation

@BharatDeva
Copy link
Copy Markdown
Contributor

Fixes #3277.

This updates the Hop REST execution documentation so the request body option list matches the example directly above it.

The example uses:

"service" : "test"

but the option list described the same field as execute. The Hop Server web service documentation also uses service, so this changes the REST option list to service for consistency.

Validation performed locally:

git diff --check
# clean
Select-String -Path docs\hop-user-manual\modules\ROOT\pages\hop-rest\index.adoc -Pattern '`service`','`execute`','"service" : "test"' -SimpleMatch
# line 254: example contains "service" : "test"
# line 273: option list now documents `service`

I could not run the full mvn clean install apache-rat:check locally because Maven/Java are not installed in this Windows/WSL environment. The change is limited to one AsciiDoc word in the user manual.

  • Run mvn clean install apache-rat:check to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.
  • If you have a group of commits related to the same change, please squash your commits into one and force push your branch using git rebase -i.
  • Mention the appropriate issue in your description (for example: addresses #123), if applicable.
  • I hereby declare this contribution to be licensed under the Apache License Version 2.0, January 2004.
  • In any other case, please file an Apache Individual Contributor License Agreement.

The REST execution example uses the JSON field service, while the option list below it still described the same field as execute. Update the option list to match the example and the Hop Server web service documentation.

Addresses apache#3277.

Signed-off-by: BharatDeva <278575558+BharatDeva@users.noreply.github.com>
@hansva hansva merged commit 58b3d6f into apache:main May 18, 2026
1 check passed
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.

[Bug]: Documentation - Web service doc - 1st parameter - execute or service?

2 participants