Skip to content

Clarify docs and comments on Errors and and findIntent error response#843

Merged
kriswest merged 4 commits intomasterfrom
spec-clarificaitons-errors-findIntent
Nov 10, 2022
Merged

Clarify docs and comments on Errors and and findIntent error response#843
kriswest merged 4 commits intomasterfrom
spec-clarificaitons-errors-findIntent

Conversation

@kriswest
Copy link
Copy Markdown
Contributor

resolves #807
resolves #841

Clarifies how errors should be returned (reject promise with JS Error object, using message from enumeration) throughout docs and source comments in 2.0. Includes clarification that findIntent fns should error if no apps are found

@kriswest kriswest requested review from a team and hughtroeger October 28, 2022 13:19
@netlify
Copy link
Copy Markdown

netlify Bot commented Oct 28, 2022

Deploy Preview for lambent-kulfi-cf51a7 canceled.

Name Link
🔨 Latest commit fa45df3
🔍 Latest deploy log https://app.netlify.com/sites/lambent-kulfi-cf51a7/deploys/635beeee1a550d0008eda430

@kriswest kriswest mentioned this pull request Oct 28, 2022
32 tasks
@kriswest kriswest added docs Documentation api FDC3 API Working Group labels Nov 3, 2022
Copy link
Copy Markdown
Member

@robmoffat robmoffat left a comment

Choose a reason for hiding this comment

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

very thorough!

@kriswest kriswest merged commit 24656c7 into master Nov 10, 2022
@kriswest kriswest deleted the spec-clarificaitons-errors-findIntent branch November 10, 2022 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api FDC3 API Working Group docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

findIntent functions docs need to clarify expected response when no apps are found Error cases need better documentation, they are rejected Promises

4 participants