Skip to content

docs: Update outdated design and API documentation#327

Open
ayushiahjolia wants to merge 1 commit intomainfrom
docs_update
Open

docs: Update outdated design and API documentation#327
ayushiahjolia wants to merge 1 commit intomainfrom
docs_update

Conversation

@ayushiahjolia
Copy link
Copy Markdown
Contributor

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Issue Link, if available

#184

Description

Update all docs under docs/ except docs/spec, will update those in followup PR.

  • Fix step signatures from Supplier to Function<StepContext, T>
  • Add missing operations to design.md API surface (callback, waitForCallback, runInChildContext, parallel, waitForCondition)
  • Rewrite parallel.md from outdated design plan to actual API (ParallelDurableFuture, branch(), ParallelResult)
  • Fix waitForCondition initialState from method param to config
  • Fix renamed types (CompletionReason -> ConcurrencyCompletionStatus, NOT_STARTED -> SKIPPED, WaitForConditionException -> WaitForConditionFailedException, InvokeTimedoutException -> InvokeTimedOutException)
  • Add missing DurableConfig options (pollingStrategy, checkpointDelay)
  • Complete exception hierarchy with all 20 exception classes
  • Add missing packages/classes to design.md package structure
  • Fix broken links and remove non-existent InvokeConfig.timeout()
  • Update ADR-003 status from Review to Accepted

Demo/Screenshots

N/A

Checklist

  • I have filled out every section of the PR template
  • I have thoroughly tested this change

Testing

Unit Tests

Have unit tests been written for these changes? N/A

Integration Tests

Have integration tests been written for these changes? N/A

Examples

Has a new example been added for the change? (if applicable) N/A

@ayushiahjolia ayushiahjolia requested a review from a team April 10, 2026 00:03
└── ChildContextFailedException - Child context failed and the original exception could not be reconstructed
├── ChildContextFailedException - Child context failed and the original exception could not be reconstructed
├── MapIterationFailedException - Map iteration failed and the original exception could not be reconstructed
└── ParallelBranchFailedException - Parallel branch failed and the original exception could not be reconstructed
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we also mention SuspendExecutionException?

var result = ctx.waitForCondition("poll", String.class, checkFunc);
} catch (WaitForConditionFailedException e) {
// Max attempts exceeded — condition was never met
} catch (IllegalStateException e) {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

When users should handle this IllegalStateException?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants