Skip to content

No defined behaviour when incorrect arguments are passed to API calls #1490

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

Open
Tracked by #1499 ...
kriswest opened this issue Jan 8, 2025 · 0 comments · May be fixed by #1559
Open
Tracked by #1499 ...

No defined behaviour when incorrect arguments are passed to API calls #1490

kriswest opened this issue Jan 8, 2025 · 0 comments · May be fixed by #1559
Labels
api FDC3 API Working Group enhancement New feature or request good first issue Good for newcomers

Comments

@kriswest
Copy link
Contributor

kriswest commented Jan 8, 2025

Enhancement Request

FDC3 standardizes error strings that are returned by FDC3 API calls. FDC3 2.1 added a number of MalformedContext errors to handle cases where an invalid context object is passed (e.g. an object without a type property). However, there are no standardized errors to provide in response to API calls that have other types of invalid arguments, for example, a a call to addContextListener where a number or boolean is passed as the context type, or handler function.

Create InvalidArguments error types in the ChannelError, OpenError and ResolveError enumerations to handle these cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api FDC3 API Working Group enhancement New feature or request good first issue Good for newcomers
Projects
None yet
1 participant