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

Require implementations to throw errors if options (post bodies generally) are not understood #386

Closed
dlongley opened this issue May 28, 2024 · 1 comment · Fixed by #394
Assignees
Labels
ready for PR Issue ready to be resolved via a Pull Request

Comments

@dlongley
Copy link
Contributor

This is particularly important to enable smooth upgrade paths to add new features by ensuring that post bodies that are not understood will result in errors -- so that clients can detect that certain features are not available in an implementation.

We should state this generally but also have tests for individual endpoints. For example, posting a non-empty body to start an exchange -- for an exchange that does not understand anything but an empty post body -- should result in an error.

@msporny
Copy link
Contributor

msporny commented Jun 11, 2024

The group discussed this on the 2024-06-11 telecon:

@PatStLouis asked if this was about undefined options, or for existing options. @msporny noted that it's for both; it's for any data, option, or option value that the API endpoint does not understand or know how to process.

There were no objections to ensuring that API endpoints default to throwing errors when they receive data, options, or option values that they don't understand.

A PR needs to be raised to instruct implementers that they MUST throw errors when they receive data, options, or option values that they don't understand.

@msporny msporny added the ready for PR Issue ready to be resolved via a Pull Request label Jun 11, 2024
@wes-smith wes-smith linked a pull request Jun 25, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for PR Issue ready to be resolved via a Pull Request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants