Skip to content

docs: state that instanceId and processInstanceId are the same value - #321

Merged
zambrovski merged 1 commit into
bpm-crafters:developfrom
stephanpelikan:docs/318-process-instance-id-matches
Oct 7, 2026
Merged

zambrovski merged 1 commit into
bpm-crafters:developfrom
stephanpelikan:docs/318-process-instance-id-matches

Conversation

@stephanpelikan

Copy link
Copy Markdown
Contributor

Closes #318.

As confirmed in #318, the instanceId returned by StartProcessApi and the processInstanceId in the
meta of a task name the same process instance with the same string. This adds that promise to the KDoc
of ProcessInformation.instanceId and CommonRestrictions.PROCESS_INSTANCE_ID, so adapters built on
the API can rely on it.

Only documentation changes. No code changes.

🤖 Generated with Claude Code

ProcessInformation.instanceId and the processInstanceId in the meta of a
task name the same process instance with the same string. A caller can
match a delivered task to the instance it started. Confirmed in bpm-crafters#318.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Lxo4MXbp6VPoDkUrTBNXJ1
@codecov

codecov Bot commented Oct 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 50.65%. Comparing base (a9ac2f0) to head (3d8da45).

Additional details and impacted files
@@            Coverage Diff             @@
##             develop     #321   +/-   ##
==========================================
  Coverage      50.65%   50.65%           
  Complexity        80       80           
==========================================
  Files             40       40           
  Lines            458      458           
  Branches           9        9           
==========================================
  Hits             232      232           
  Misses           221      221           
  Partials           5        5           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@zambrovski zambrovski added this to the 1.8 milestone Oct 7, 2026
@zambrovski zambrovski added the Type: documentation Improvements or additions to documentation label Oct 7, 2026
@zambrovski
zambrovski merged commit 1d10f4c into bpm-crafters:develop Oct 7, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Is ProcessInformation.instanceId the same value as the processInstanceId in a task's meta?

2 participants