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

docs: mark C8 REST search as experimental #4098

Merged
merged 3 commits into from
Aug 6, 2024
Merged

docs: mark C8 REST search as experimental #4098

merged 3 commits into from
Aug 6, 2024

Conversation

tmetzke
Copy link
Member

@tmetzke tmetzke commented Aug 2, 2024

Description

  • Introduces C8 REST API search endpoints for user tasks, process instances, decision instances
  • Marks the search endpoints as experimental
  • Additionally introduces all added endpoints for jobs and incidents

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/).

@tmetzke tmetzke added the 8.6.0-alpha4 August 2024 alpha release label Aug 2, 2024
@tmetzke tmetzke requested review from nicpuppa and a team August 2, 2024 14:29
@tmetzke tmetzke self-assigned this Aug 2, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 2, 2024 •
edited
Loading

👋 🤖 🤔 Hello! 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.5/.

  • docs/apis-tools/camunda-api-rest/specifications/activate-jobs.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/assign-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/camunda-8-rest-api.info.mdx
  • docs/apis-tools/camunda-api-rest/specifications/complete-job.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/complete-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/fail-job.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/get-cluster-topology.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-decision-definitions-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-process-instances-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/query-user-tasks-experimental.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/report-error-for-job.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/resolve-incident.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/sidebar.js
  • docs/apis-tools/camunda-api-rest/specifications/unassign-user-task.api.mdx
  • docs/apis-tools/camunda-api-rest/specifications/update-user-task.api.mdx

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.

@tmetzke
Copy link
Member Author

tmetzke commented Aug 2, 2024

The endpoints are not all perfect yet regarding descriptions for attributes and such.
We'll fix this until the 8.6 minor release. The REST endpoint developers are informed to pay more attention to adding descriptions.

@tmetzke tmetzke linked an issue Aug 2, 2024 that may be closed by this pull request
Mark C8 REST Query API endpoints as experimental and disabled by default #4097
Closed
@akeller akeller requested a review from pepopowitz August 2, 2024 15:08
@nicpuppa nicpuppa added the deploy Stand up a temporary docs site with this PR label Aug 5, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs August 5, 2024 05:40 Destroyed
nicpuppa
nicpuppa previously approved these changes Aug 5, 2024
View reviewed changes
Copy link
Contributor

@nicpuppa nicpuppa left a comment

Choose a reason for hiding this comment

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

🚀

christinaausley
christinaausley previously approved these changes Aug 5, 2024
View reviewed changes
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

🚀

@tmetzke tmetzke dismissed stale reviews from christinaausley and nicpuppa via 09d4e2e August 6, 2024 06:44
@github-actions github-actions bot temporarily deployed to camunda-docs August 6, 2024 07:00 Destroyed
tmetzke added 2 commits August 6, 2024 09:20
@tmetzke
docs: mark C8 REST search as experimental
e3e0683 
* Introduces C8 REST API search endpoints for user tasks, process instances, decision instances
* Marks the search endpoints as experimental
* Additionally introduces all added endpoints for jobs and incidents
@tmetzke
docs: adjust C8 REST API summaries
1a2d5c3 
Use imperative form for all summaries
@tmetzke tmetzke force-pushed the 4097-c8-rest-search-experimental branch from 09d4e2e to 1a2d5c3 Compare August 6, 2024 07:20
@github-actions github-actions bot temporarily deployed to camunda-docs August 6, 2024 07:28 Destroyed
@tmetzke tmetzke enabled auto-merge (squash) August 6, 2024 07:45
@tmetzke
Copy link
Member Author

tmetzke commented Aug 6, 2024

I adjusted the summaries to make them consistently use imperative form.

@tmetzke tmetzke disabled auto-merge August 6, 2024 08:06
@tmetzke tmetzke enabled auto-merge (squash) August 6, 2024 08:06
@github-actions github-actions bot temporarily deployed to camunda-docs August 6, 2024 08:14 Destroyed
@tmetzke tmetzke merged commit 6803e39 into main Aug 6, 2024
7 checks passed
@tmetzke tmetzke deleted the 4097-c8-rest-search-experimental branch August 6, 2024 08:23
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 6, 2024

🧹 Preview environment for this PR has been torn down.

@tmetzke tmetzke mentioned this pull request Aug 12, 2024
Closed
23 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicpuppa nicpuppa nicpuppa approved these changes

@pepopowitz pepopowitz Awaiting requested review from pepopowitz

@christinaausley christinaausley Awaiting requested review from christinaausley

Assignees

@tmetzke tmetzke

Labels
8.6.0-alpha4 August 2024 alpha release deploy Stand up a temporary docs site with this PR
Projects
Developer Experience
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Mark C8 REST Query API endpoints as experimental and disabled by default
3 participants
@tmetzke @nicpuppa @christinaausley