Skip to content

Document the exceptions thrown by capability methods in scaladoc #29

Description

@sideeffffect

Severity: low · Category: docs

Evidence

  • Capability methods that internally decode (StateCapability.get, ServiceInvocationCapability.invoke, …) don't mention they may surface JsonDecodeException, and the infra paths don't note the unchecked DaprException.

Problem
The project's error model is intentionally exception-based, so the thrown types are part of the public contract — but they're mostly implicit. The best-practices the project follows mandate documenting public-API behaviour.

Suggested fix
Add a short note once per capability trait header, e.g. "Throws DaprException on sidecar/infra failure; may throw JsonDecodeException if the stored/returned payload doesn't match T."

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationlowLow importance

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions