Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc] Update websocket docs to suggest passing the token as headers rather than query parameters #23625

Open
1 of 2 tasks
lhotari opened this issue Nov 21, 2024 · 5 comments · May be fixed by apache/pulsar-site#981
Open
1 of 2 tasks

[Doc] Update websocket docs to suggest passing the token as headers rather than query parameters #23625

lhotari opened this issue Nov 21, 2024 · 5 comments · May be fixed by apache/pulsar-site#981
Assignees
@walkinggo
Labels
doc-required Your PR changes impact docs and you will update later.

Comments

@lhotari
Copy link
Member

lhotari commented Nov 21, 2024

Search before asking

  • I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

https://pulsar.apache.org/docs/4.0.x/client-libraries-websocket/#authentication

What is your suggestion?

suggest passing the token as headers rather than query parameters

Any reference?

No response

Are you willing to submit a PR?

  • I'm willing to submit a PR!
@lhotari lhotari added the doc-required Your PR changes impact docs and you will update later. label Nov 21, 2024
@walkinggo
Copy link

I want to do it if no one want. could you assign it to me? @lhotari

@lhotari
Copy link
Member Author

lhotari commented Dec 17, 2024

I want to do it if no one want. could you assign it to me? @lhotari

sure, please go ahead. Just a tip: using generative AI such as ChatGPT is good for fixing grammar issues.

@lhotari
Copy link
Member Author

lhotari commented Dec 17, 2024

@walkinggo You should first update the documentation files in the docs directory and then in the versioned_docs ONLY for supported versions (version-4.0.x and version-3.0.x). More details in https://github.com/apache/pulsar-site?tab=readme-ov-file#updating-versioned-docs and https://pulsar.apache.org/contribute/document-contribution/#update-versioned-docs .

@walkinggo
Copy link

Thank you ! I will try my best to finish it.

@walkinggo
Copy link

I would like to resolve this issue, but could you please explain the reason? You suggested passing the token as a header rather than as a query parameter, but why is that the case? @lhotari

@walkinggo walkinggo linked a pull request Dec 23, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@walkinggo walkinggo

Labels
doc-required Your PR changes impact docs and you will update later.
Projects
None yet
Milestone
No milestone
2 participants
@lhotari @walkinggo