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.

Sign up for GitHub

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

Jump to bottom

Add actionable guidance on payload validation error #119

Open
grayside opened this issue Apr 16, 2021 · 1 comment
Open

Add actionable guidance on payload validation error #119

grayside opened this issue Apr 16, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@grayside
Copy link
Contributor

When working with background events locally, it can be difficult to construct the payload correctly. If you are missing the data or context properties, the framework will raise an HTTP 400 response without actionable details. (#83 addresses documentation)

Current Behavior

The current framework response is:

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<title>400 Bad Request</title>
<h1>Bad Request</h1>
<p>The browser (or proxy) sent a request that this server could not understand.</p>

The current log output is:

127.0.0.1 - - [16/Apr/2021 12:38:05] "POST / HTTP/1.1" 400 -

Expected behavior

Log output should specify payload validation errors down to the property & type level.
@di di added the enhancement New feature or request label Jul 7, 2021
@grant
Copy link
Contributor

grant commented Apr 27, 2022

The change would be additional error message after validating an event:

functions-framework-python/src/functions_framework/__init__.py

Line 167 in 99a9df6

flask.abort(400)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@grayside @di @grant