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

feat: unprotected API for C8Run #5145

Merged
merged 2 commits into from
Mar 6, 2025
Merged

feat: unprotected API for C8Run #5145

merged 2 commits into from
Mar 6, 2025

Conversation

megglos
Copy link
Contributor

@megglos megglos commented Mar 4, 2025

Description

Removes the now unnecessary cookie auth for the C8Run API, which is unprotected by default starting with 8.8.0-alpha2.

Also added a section to instruct the user on how to enable authentication and authorization, should they want to make use of it.

closes https://github.com/camunda/documentation-team/issues/463

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.

Copy link
Contributor

github-actions bot commented Mar 4, 2025

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

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

  • docs/self-managed/setup/deploy/local/c8run.md
These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.7/.
  • docs/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.

@megglos megglos force-pushed the meg-463-c8run-880alpha2 branch 3 times, most recently from aca449f to a1fc1d3 Compare March 4, 2025 19:09
@megglos megglos force-pushed the meg-463-c8run-880alpha2 branch from a1fc1d3 to 34e7481 Compare March 4, 2025 19:11
@megglos megglos marked this pull request as ready for review March 4, 2025 19:11
@megglos megglos requested review from conceptualshark and a team March 4, 2025 19:12
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.

Committed a few wording updates, but otherwise this looks good to go - happy to get rid of the old cookie auth steps! 🙌

@akeller
Copy link
Member

akeller commented Mar 4, 2025

Removes the now unnecessary cookie auth for the C8Run API, which is unprotected by default starting with 8.8.0-alpha2.

Just confirming, we would still need cookie auth for just C8Run in 8.6 and 8.7, correct? We have an open PR here.

@akeller akeller added component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed component:api Issues related to the C8 REST API labels Mar 4, 2025
@akeller akeller mentioned this pull request Mar 4, 2025
9 tasks
@megglos megglos mentioned this pull request Mar 6, 2025
12 tasks
@megglos megglos merged commit 98da588 into main Mar 6, 2025
13 checks passed
@megglos megglos deleted the meg-463-c8run-880alpha2 branch March 6, 2025 16:07
christinaausley pushed a commit that referenced this pull request Mar 6, 2025
* feat: unprotected API for C8Run

* update headers, auth steps

---------

Co-authored-by: Cole Garbo <cole.garbo@camunda.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.8.0-alpha2 component:api Issues related to the C8 REST API component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

4 participants