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.

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

Clarify expected behaviour of IntentResolution.getResult() when IntentHandlers resolve to void #1003

Closed
kriswest opened this issue May 24, 2023 · 0 comments · Fixed by #1004
Labels
api FDC3 API Working Group bug Something isn't working conformance Conformance testing framework docs Documentation
Milestone

Comments

@kriswest
Copy link
Contributor

Area of Issue

[x] API

Issue Description:

The documentation of the IntentHandler type introduced in 2.0 and related behaviour from the IntentResolution.getResult() API call, when a void result is returned, is open to interpretation due to a confusing description. Clarify the description to ensure its easy to understand the expected behavior.

Additional Context:

One of the use-cases for getResult() discussed when it was introduced was knowing when the intent handler has completed. This should be possible even when the intent handler is returning void and shouldn't appear to be an error. However, the description of IntentHandler and the ResultError.NoResultReturned don't quite match up (You might resolve getResult() to void OR reject with ResultError.NoResultReturned. It was not intended that the promise rejects with an error on expected behavior.

As this was not clear in 2.0 it was suggested that the 2.0 conformance tests allow for either output, while 2.1 fixes the description and standardizes on resolving to void.

@kriswest kriswest added bug Something isn't working docs Documentation api FDC3 API Working Group labels May 24, 2023
@kriswest kriswest added this to the 2.1 milestone May 24, 2023
@kriswest kriswest added the conformance Conformance testing framework label May 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api FDC3 API Working Group bug Something isn't working conformance Conformance testing framework docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant