Skip to content

docs: document UriUtils.encodePath for Java client service invocation#5231

Open
javier-aliaga wants to merge 2 commits into
dapr:v1.18from
javier-aliaga:docs/java-invoke-http-path-encoding
Open

docs: document UriUtils.encodePath for Java client service invocation#5231
javier-aliaga wants to merge 2 commits into
dapr:v1.18from
javier-aliaga:docs/java-invoke-http-path-encoding

Conversation

@javier-aliaga

Copy link
Copy Markdown
Contributor

newRequestBuilder no longer encodes the path; document that callers must encode segments containing URI-illegal characters (e.g. spaces) with UriUtils.encodePath, and that passing them raw throws IllegalArgumentException. Reflects dapr/java-sdk#1774.

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within tabpane
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have tabpane

In addition, please fill out the following to help reviewers understand this pull request:

Description

Issue reference

newRequestBuilder no longer encodes the path; document that callers must
encode segments containing URI-illegal characters (e.g. spaces) with
UriUtils.encodePath, and that passing them raw throws IllegalArgumentException.
Reflects dapr/java-sdk#1774.

Signed-off-by: Javier Aliaga <javier@diagrid.io>
@javier-aliaga javier-aliaga requested review from a team as code owners July 1, 2026 10:28
@github-actions github-actions Bot added the automerge: java Auto-merged language-specific SDK docs label Jul 1, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Auto-approval: java SDK docs

@alicejgibbons alicejgibbons left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

a few minor things

Comment thread sdkdocs/java/content/en/java-sdk-docs/java-client/_index.md Outdated
Comment thread sdkdocs/java/content/en/java-sdk-docs/java-client/_index.md Outdated
Comment thread sdkdocs/java/content/en/java-sdk-docs/java-client/_index.md Outdated
Comment thread sdkdocs/java/content/en/java-sdk-docs/java-client/_index.md Outdated
Drop the alert wrapper in favor of a plain paragraph, reword per review,
and group the URL path encoding row with the user-responsibility rows.

Signed-off-by: Javier Aliaga <javier@diagrid.io>

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Auto-approval: java SDK docs

@alicejgibbons alicejgibbons left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@alicejgibbons

Copy link
Copy Markdown
Contributor

Do we need backport for this and the other sdk doc with the comparison table in it for 1.17 SDK?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automerge: java Auto-merged language-specific SDK docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants