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.

Sign up for GitHub

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

Jump to bottom

Create public C8 REST API guidelines #24239

Open
2 tasks
Tracked by #23736
tmetzke opened this issue Oct 30, 2024 · 2 comments · May be fixed by camunda/camunda-docs#4580
Open
2 tasks
Tracked by #23736

Create public C8 REST API guidelines #24239

tmetzke opened this issue Oct 30, 2024 · 2 comments · May be fixed by camunda/camunda-docs#4580
Assignees
@tmetzke
Labels
component/c8-api All things unified C8 API, e.g. C8 REST kind/documentation Categorizes an issue or PR as documentation related

Comments

@tmetzke
Copy link
Member

tmetzke commented Oct 30, 2024 •
edited
Loading

Description

  • Provide a public version of the (🔒 internal) C8 REST API guidelines
  • Replace the internal content with the public reference as much as possible (ideally everything in API guidelines)
@tmetzke tmetzke mentioned this issue Oct 30, 2024
Open
@tmetzke tmetzke self-assigned this Oct 30, 2024
@tmetzke tmetzke added kind/documentation Categorizes an issue or PR as documentation related component/c8-api All things unified C8 API, e.g. C8 REST labels Oct 30, 2024
@tmetzke tmetzke linked a pull request Nov 7, 2024 that will close this issue
Open
11 tasks
@akeller
Copy link
Member

akeller commented Dec 4, 2024

@tmetzke, I mentioned this on the docs PR, but who is the audience for this? Camundi, customers, or both? When I reviewed the PR, it was unclear.

@tmetzke
Copy link
Member Author

tmetzke commented Dec 5, 2024

@tmetzke, I mentioned this on the docs PR, but who is the audience for this? Camundi, customers, or both? When I reviewed the PR, it was unclear.

Yep, it's on my (completely crowded) radar 😅 The audience should be users in general to understand how we design our API. It's currently too focused on Camundi because it's just a copy of the internal guidelines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tmetzke tmetzke

Labels
component/c8-api All things unified C8 API, e.g. C8 REST kind/documentation Categorizes an issue or PR as documentation related
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add C8 REST guidelines camunda/camunda-docs
2 participants
@tmetzke @akeller