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(web-modeler): clarify Web Modeler public API OIDC setup #5325

Merged
merged 2 commits into from
Mar 28, 2025

Conversation

wollefitz
Copy link
Member

@wollefitz wollefitz commented Mar 20, 2025

Description

Closes https://github.com/camunda/web-modeler/issues/13603

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.

@wollefitz wollefitz added component:web-modeler-sm Issues related with Web Modeler Self-Managed available & undocumented This is already available but undocumented and should be released within a week. labels Mar 20, 2025
@wollefitz wollefitz self-assigned this Mar 20, 2025
@wollefitz wollefitz force-pushed the web-modeler-13603-oidc-rest-api branch from 2f61242 to ee9adba Compare March 20, 2025 15:10
@wollefitz wollefitz added the deploy Stand up a temporary docs site with this PR label Mar 20, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs March 20, 2025 15:26 Destroyed
@wollefitz wollefitz force-pushed the web-modeler-13603-oidc-rest-api branch 2 times, most recently from 93b6faf to 716d9a1 Compare March 20, 2025 17:39
@github-actions github-actions bot temporarily deployed to camunda-docs March 20, 2025 17:48 Destroyed
@wollefitz
Copy link
Member Author

@ingorichtsmeier Small ping to have a look at this

@jfriedenstab feel free to hand over to another WMC engineer in case you don't have the capacity to review.

@ingorichtsmeier
Copy link
Contributor

ingorichtsmeier commented Mar 24, 2025

Hi @wollefitz, I would recommend changing the names of the APIs to distinguish them clearly. I thought a while about them, and for our users, it is easier to name them the Web Modeler API (to support the Web Modeler User interface) and Web Modeler REST API (for public access).

The client ID needs a clarification, too. Which one is really required and is used in the code? The ID of the confidential client or the ID of the public client?

All values are created in step 3. (For the GENERIC configuration)

Copy link
Contributor

@jfriedenstab jfriedenstab left a comment

Choose a reason for hiding this comment

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

Sorry for the delayed review!

@wollefitz wollefitz force-pushed the web-modeler-13603-oidc-rest-api branch 3 times, most recently from 89279fe to a3d3bdb Compare March 27, 2025 18:34
@github-actions github-actions bot temporarily deployed to camunda-docs March 27, 2025 18:43 Destroyed
@wollefitz wollefitz force-pushed the web-modeler-13603-oidc-rest-api branch from a3d3bdb to a740a1d Compare March 27, 2025 18:57
@wollefitz wollefitz requested review from jfriedenstab and a team March 27, 2025 18:58
@wollefitz
Copy link
Member Author

@ingorichtsmeier @jfriedenstab Thanks for the thorough review - I made the suggested adjustments. Could you have another look?

@github-actions github-actions bot temporarily deployed to camunda-docs March 27, 2025 19:06 Destroyed
Copy link
Contributor

@jfriedenstab jfriedenstab left a comment

Choose a reason for hiding this comment

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

Looks good to me! 👍🏻

Copy link
Contributor

@ingorichtsmeier ingorichtsmeier left a comment

Choose a reason for hiding this comment

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

Much better than before.

@wollefitz wollefitz removed the request for review from a team March 28, 2025 10:22
@wollefitz
Copy link
Member Author

@camunda/tech-writers I'll go ahead and merge this as this is mainly a technical change. If you identify something that has to be changed retroactively I'm happy to adjust!

@wollefitz wollefitz merged commit 022db5b into main Mar 28, 2025
11 checks passed
@wollefitz wollefitz deleted the web-modeler-13603-oidc-rest-api branch March 28, 2025 10:23
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. component:web-modeler-sm Issues related with Web Modeler Self-Managed deploy Stand up a temporary docs site with this PR
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants