Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Making sure all endpoints define at least the minimum common responses #103

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Commits on Dec 12, 2020

  1. Making sure all endpoints define at least the minimum common responses

    A common pitfall when using this package is the following: you define
    an endpoint that can result in 400 Bad Request, but you forget to list 400
    in the `responses` section of your endpoint in openapi.yaml. This package
    then instead returns 500 Internal Server error, because it keeps the promise
    that only defined responses will be allowed (unless you set
    `enable_request_validation` to `False`, that is).
    
    With this commit, all endpoints, by default need to have 200, 400 and 500
    on the list of `responses` in openapi.yaml, otherwise the app won't start. Additionally, all
    endpoints that accept a parameter, also need to have 404 on the list of
    `responses`.
    
    You can skip this check by setting `enable_endpoint_validation` to `False`.
    
    Refs #22
    Refs #49 (comment)
    Refs #36
    zupo committed Dec 12, 2020
    Configuration menu
    Copy the full SHA
    e55ea8f View commit details
    Browse the repository at this point in the history