Remove Zeebe REST API #4650

akeller · 2024-11-22T22:16:35Z

Description

🪦 Removing the deprecated Zeebe REST API. 🪦

I think this can be separate from a specific alpha, so it can be reviewed and merged whenever (unless @tmetzke or @aleksander-dytko think differently).

Remaining items to bring this PR out of draft status:

Redirects (to the Camunda REST API)
Backporting (content removal only, not announcement)

@camunda/tech-writers one of you can take this over while I'm gone to get it merged.

When should this change go live?

This is a bug fix, security concern, or something that needs urgent release support.
This is already available but undocumented and should be released within a week.
This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
This is part of a scheduled alpha or minor. (apply alpha or minor label)
There is no urgency with this change and can be released at any time.

PR Checklist

My changes are for an already released minor and are in /versioned_docs directory.
My changes are for the next minor and are in /docs directory (aka /next/).
I (will) added a redirect for a renamed or deleted page to the .htaccess file.

My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

github-actions · 2024-11-22T22:17:00Z

👋 🤖 🤔 Hello, @christinaausley! 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/apis-tools/frontend-development/01-task-applications/02-user-task-lifecycle.md
docs/apis-tools/spring-zeebe-sdk/getting-started.md
docs/apis-tools/zeebe-api-rest/sidebar-schema.js
docs/apis-tools/zeebe-api-rest/specifications/assign-a-user-task.api.mdx
docs/apis-tools/zeebe-api-rest/specifications/complete-a-user-task.api.mdx
docs/apis-tools/zeebe-api-rest/specifications/get-cluster-topology.api.mdx
docs/apis-tools/zeebe-api-rest/specifications/sidebar.js
docs/apis-tools/zeebe-api-rest/specifications/unassign-a-user-task.api.mdx
docs/apis-tools/zeebe-api-rest/specifications/update-a-user-task.api.mdx
docs/apis-tools/zeebe-api-rest/specifications/zeebe-rest-api.info.mdx
docs/apis-tools/zeebe-api-rest/tutorial.md
docs/apis-tools/zeebe-api-rest/zeebe-api-rest-authentication.md
docs/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md
docs/components/console/manage-clusters/manage-api-clients.md
docs/components/zeebe/technical-concepts/architecture.md
docs/guides/setup-client-connection-credentials.md
docs/self-managed/zeebe-deployment/operations/management-api.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.

akeller · 2024-11-22T22:56:27Z

The build currently breaks in part due to the migration guide for user tasks, work that I see happening over on #4573.

tmetzke · 2024-11-27T18:59:22Z

Do we also remove this from the /api directory? There are some references to that. Not sure if this needs to be part of this PR or is a follow-up since that is more about internal structure changes than user-facing docs.

christinaausley · 2024-12-02T16:04:45Z

Do we also remove this from the /api directory? There are some references to that. Not sure if this needs to be part of this PR or is a follow-up since that is more about internal structure changes than user-facing docs.

I would assume so. Once I get #4573 merged in I'll get this cleaned up and merged as well. CC @volodymyr-melnykc

tmetzke

Looks good to me, content-wise 👍
I'm not sure if there are other structural leftovers for the Zeebe API, I guess @pepopowitz knows this best 🙂

akeller · 2024-12-04T18:54:25Z

Looks good to me, content-wise 👍 I'm not sure if there are other structural leftovers for the Zeebe API, I guess @pepopowitz knows this best 🙂

@pepopowitz can you review to make sure we've made all the docs infra changes necessary to remove the Zeebe REST API?

pepopowitz

In addition to the inline comment, I also think this block is what's giving you a build error right now, and should be removed.

Other than that I think you cleaned everything up!

static/.htaccess

christinaausley · 2024-12-06T22:10:48Z

@tmetzke Can you confirm if the Zeebe REST API should be removed in 8.5 and 8.6?

tmetzke · 2024-12-09T08:11:38Z

@tmetzke Can you confirm if the Zeebe REST API should be removed in 8.5 and 8.6?

As far as I know, we keep it there. @felix-mueller (covering for @aleksander-dytko), can you confirm or deny? 😄

christinaausley · 2024-12-09T15:38:21Z

I've confirmed with @felix-mueller this is still valid for 8.5 and 8.6, so this PR is ready for final review.

@tmetzke Would you like me to keep this API in Postman for now, or remove it with an announcement to migrate to the Camunda 8 API?

tmetzke · 2024-12-09T18:33:57Z

@tmetzke Would you like me to keep this API in Postman for now, or remove it with an announcement to migrate to the Camunda 8 API?

Let's add an announcement to move to C8 API 👍

versioned_docs/version-8.5/apis-tools/tasklist-api-rest/migrate-to-zeebe-user-tasks.md

tmetzke

👍 Looks good to me, thanks for tracking it down everywhere 🚀
🔧 Only one spot left that might need some attention.

Pre-approving since my last suggestion is not blocking.

pepopowitz

Nice work!!!

remove zeebe rest api + announce

4c91f79

akeller added the target:8.7 Issues included in the 8.7 release label Nov 22, 2024

akeller requested review from tmetzke, aleksander-dytko and a team November 22, 2024 22:16

akeller self-assigned this Nov 22, 2024

remove from sidebars

d5eca0c

Update announcements.md

311e51e

christinaausley self-assigned this Nov 25, 2024

christinaausley and others added 3 commits December 3, 2024 10:48

Merge branch 'main' into remove-zeebe-rest

f9cb647

remove zeebe rest references from next

7d45d62

remove /docs

d8732a6

tmetzke previously approved these changes Dec 4, 2024

View reviewed changes

akeller requested a review from pepopowitz December 4, 2024 18:52

pepopowitz reviewed Dec 4, 2024

View reviewed changes

static/.htaccess Outdated Show resolved Hide resolved

remove zeebe card

7d4c9e5

christinaausley dismissed tmetzke’s stale review via 7d4c9e5 December 5, 2024 14:15

christinaausley added 3 commits December 5, 2024 09:20

add redirects

2170cb2

merge in main

7098a3c

fix extra parenthese

e09dd13

remove zeebe rest api tutorial

5638079

christinaausley marked this pull request as ready for review December 9, 2024 15:29

christinaausley requested a review from tmetzke December 12, 2024 18:13

Merge branch 'main' into remove-zeebe-rest

171fe36

tmetzke reviewed Dec 13, 2024

View reviewed changes

versioned_docs/version-8.5/apis-tools/tasklist-api-rest/migrate-to-zeebe-user-tasks.md Outdated Show resolved Hide resolved

tmetzke previously approved these changes Dec 13, 2024

View reviewed changes

revert 8.5 change

d0ef613

christinaausley dismissed tmetzke’s stale review via d0ef613 December 13, 2024 14:47

christinaausley added 2 commits December 13, 2024 09:47

remove comma

8fcd66a

fix link

7a3c047

christinaausley requested review from pepopowitz and tmetzke December 16, 2024 19:26

pepopowitz approved these changes Dec 17, 2024

View reviewed changes

christinaausley merged commit 74fa8ef into main Dec 17, 2024
10 checks passed

christinaausley deleted the remove-zeebe-rest branch December 17, 2024 18:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove Zeebe REST API #4650

Remove Zeebe REST API #4650

akeller commented Nov 22, 2024

github-actions bot commented Nov 22, 2024 •

edited

Loading

akeller commented Nov 22, 2024

tmetzke commented Nov 27, 2024

christinaausley commented Dec 2, 2024 •

edited

Loading

tmetzke left a comment

akeller commented Dec 4, 2024

pepopowitz left a comment •

edited

Loading

christinaausley commented Dec 6, 2024

tmetzke commented Dec 9, 2024

christinaausley commented Dec 9, 2024

tmetzke commented Dec 9, 2024

tmetzke left a comment

pepopowitz left a comment

Remove Zeebe REST API #4650

Remove Zeebe REST API #4650

Conversation

akeller commented Nov 22, 2024

Description

When should this change go live?

PR Checklist

github-actions bot commented Nov 22, 2024 • edited Loading

akeller commented Nov 22, 2024

tmetzke commented Nov 27, 2024

christinaausley commented Dec 2, 2024 • edited Loading

tmetzke left a comment

Choose a reason for hiding this comment

akeller commented Dec 4, 2024

pepopowitz left a comment • edited Loading

Choose a reason for hiding this comment

christinaausley commented Dec 6, 2024

tmetzke commented Dec 9, 2024

christinaausley commented Dec 9, 2024

tmetzke commented Dec 9, 2024

tmetzke left a comment

Choose a reason for hiding this comment

pepopowitz left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 22, 2024 •

edited

Loading

christinaausley commented Dec 2, 2024 •

edited

Loading

pepopowitz left a comment •

edited

Loading