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.

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

docs: explain how to use java client with APIs in a c8run environment #5365

Merged
merged 2 commits into from
Mar 26, 2025

Conversation

pepopowitz
Copy link
Collaborator

Description

This is follow-up to this discussion.

There is a trick to using the Java client to connect to APIs via cookie auth in a C8Run environment. Thanks to @tmetzke, this PR explains that trick.

It only applies to v8.6 and v8.7, as in v8.8 we no longer need cookie auth to connect to the APIs.'

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the DevEx team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and:
    • are in the /docs directory (version 8.8).
    • are in the /versioned_docs/version-8.7/ directory (version 8.7).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@pepopowitz pepopowitz added target:8.7 Issues included in the 8.7 release deploy Stand up a temporary docs site with this PR available & undocumented This is already available but undocumented and should be released within a week. labels Mar 25, 2025
@pepopowitz pepopowitz self-assigned this Mar 25, 2025
@pepopowitz pepopowitz requested review from tmetzke and a team March 25, 2025 16:56
Copy link
Contributor

👋 🤖 🤔 Hello, @pepopowitz! Did you make your changes in all the right places?

These files were changed only in versioned_docs/version-8.7/. You might want to duplicate these changes in docs/.

  • versioned_docs/version-8.7/apis-tools/camunda-api-rest/camunda-api-rest-authentication.md
  • versioned_docs/version-8.7/self-managed/setup/deploy/local/c8run.md
These files were changed only in versioned_docs/version-8.6/. You might want to duplicate these changes in docs/.
  • versioned_docs/version-8.6/apis-tools/camunda-api-rest/camunda-api-rest-authentication.md
  • versioned_docs/version-8.6/self-managed/setup/deploy/local/c8run.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@github-actions github-actions bot temporarily deployed to camunda-docs March 25, 2025 17:04 Destroyed
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

This makes sense to me from a TW perspective - thank you for updating the C8Run page as well!

Copy link
Member

@tmetzke tmetzke left a comment

Choose a reason for hiding this comment

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

👍 Love it, great read! 🚀

💭 The C8Run instructions also mention the gRPC API. I am not the greatest expert in authentication mechanisms in our platform, but I believe that cookie authentication is not needed for that protocol. Maybe you can clarify this offline, and if this is indeed not needed, we should be clear about that in this C8Run guide. Currently, it somehow reads like it's necessary, but there is no example for gRPC calls, so that might confuse users at some point. This is non-blocking and can go into a follow-up.

@pepopowitz
Copy link
Collaborator Author

💭 The C8Run instructions also mention the gRPC API. I am not the greatest expert in authentication mechanisms in our platform, but I believe that cookie authentication is not needed for that protocol. Maybe you can clarify this offline, and if this is indeed not needed, we should be clear about that in this C8Run guide. Currently, it somehow reads like it's necessary, but there is no example for gRPC calls, so that might confuse users at some point. This is non-blocking and can go into a follow-up.

I don't personally have the capability to manage this follow-up right now.

@pepopowitz pepopowitz merged commit bc9220e into main Mar 26, 2025
14 checks passed
@pepopowitz pepopowitz deleted the pepopowitz/c8run-java-client branch March 26, 2025 16:37
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
available & undocumented This is already available but undocumented and should be released within a week. deploy Stand up a temporary docs site with this PR target:8.7 Issues included in the 8.7 release
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants