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

Add context path info to component REST APIs #3710

Merged
merged 2 commits into from
Apr 26, 2024
Merged

Conversation

tmetzke
Copy link
Member

@tmetzke tmetzke commented Apr 25, 2024

Description

Adds details on where to find the Zeebe, Tasklist, and Operate REST API endpoints.
Backported until version 8.2 where applicable.

closes #3698

When should this change go live?

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@tmetzke tmetzke added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) component:zeebe Issues related with Zeebe project component:operate Issues related with Operate project component:tasklist Issues related with Tasklist project labels Apr 25, 2024
@tmetzke tmetzke self-assigned this Apr 25, 2024
@tmetzke
Copy link
Member Author

tmetzke commented Apr 25, 2024

@ralfpuchert and @houssain-barouni, can you please check if the changes are correct for Operate and Tasklist?
Please especially have a look at the changes to the released versions regarding context paths that might have changed, e.g. from /api/v1 to /v1 or anything alike.

@tmetzke
Copy link
Member Author

tmetzke commented Apr 25, 2024

@jonathanlukas, can you please double-check that this is what you're looking for? 🙂

Adds details on where to find the Zeebe, Tasklist, and Operate REST API endpoints.
Backported until version 8.2 where applicable.
jonathanlukas
jonathanlukas previously approved these changes Apr 25, 2024
Copy link
Contributor

@jonathanlukas jonathanlukas left a comment

Choose a reason for hiding this comment

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

lgtm

ralfpuchert
ralfpuchert previously approved these changes Apr 26, 2024
Copy link
Contributor

@ralfpuchert ralfpuchert left a comment

Choose a reason for hiding this comment

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

Operate public API has been available under /v1/. LGTM

Copy link
Contributor

@houssain-barouni houssain-barouni left a comment

Choose a reason for hiding this comment

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

LGTM for tasklist

@tmetzke tmetzke merged commit ec8bdb6 into main Apr 26, 2024
6 checks passed
@tmetzke tmetzke deleted the 3698-rest-context-paths branch April 26, 2024 21:25
@tmetzke
Copy link
Member Author

tmetzke commented Apr 29, 2024

Thanks, @christinaausley, for your additions, super helpful for the users! 🌟

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:operate Issues related with Operate project component:tasklist Issues related with Tasklist project component:zeebe Issues related with Zeebe project kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Camunda Saas: Mention Zeebe REST API endpoint schema
5 participants