Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork8.7k
✨ Add support for extensions and updates to the OpenAPI schema in path operations#1922
Conversation
codecovbot commentedAug 19, 2020 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Codecov Report
@@ Coverage Diff @@## master #1922 +/- ##========================================== Coverage 100.00% 100.00% ========================================== Files 401 408 +7 Lines 10095 10196 +101 ==========================================+ Hits 10095 10196 +101
Continue to review full report at Codecov.
|
📝 Docs preview for commitef11de8 at:https://5f3d3325b71f19b554d54b99--fastapi.netlify.app |
edouardlp commentedAug 19, 2020
Note that this is similar to#1917 in that |
📝 Docs preview for commitb73f7af at:https://5f3d4104691656ae542c442a--fastapi.netlify.app |
Kludex commentedAug 19, 2020
Right now, the PR's are not compatible... To make them compatible |
| app = FastAPI() | ||
| @app.get("/items/", **{"x-my-open-api-extension": "value"}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'd rather write something like:
| @app.get("/items/",**{"x-my-open-api-extension":"value"}) | |
| @app.get("/items/",openapi_extensions={"x-my-open-api-extension":"value"}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Explicit is better than implicit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Realized@Kludex commented the exact same thing 😬
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I haven't said anything, have I? 😮
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
To make them compatible extra should be a dict, not a keyworded.
I mis-read.
edouardlpAug 21, 2020 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I do prefer it explicit as well, but I was mirroringPath,Field andQuery which will add any other arguments to the open api spec. I'll make the change, thanks for the suggestion!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
@hadrien@edouardlp I think it should be openapi_extensions={..}, or if we'd use ** we should update the operation late in get_openapi_path instead of in get_openapi_operation_metadata as that would give us a "openapi override" so we could set requestBody or whatever and not having it overwritten somewhere in get_openapi_path.
What do you guys think?
hadrien commentedAug 21, 2020
Would there be a way to add extension to the router as well? |
mbelang commentedSep 21, 2020
@tiangolo Any chance this could be looked at please? We think it is a nice enhancement to the openapi support and that would solve a big part of automation for us. Thx |
triptec commentedOct 9, 2020
I tried this branch out and found a missing **route.extra in the call to add_api_route in include_router and also moved to get_openapi_path. Is it perhaps something of interest? |
to keep it comparable/consistent with Pydantic's schema_extra:https://pydantic-docs.helpmanual.io/usage/schema/#schema-customizationRemove wildcard parameters from path operation decorators, to be re-added as a single parameter after merging master
📝 Docs preview for commit0e3d84b at:https://61030891eb9ff5337060b81d--fastapi.netlify.app |
tiangolo commentedJul 29, 2021
Thanks for the work@edouardlp! 🚀 🍰 And thanks for the discussion everyone. I updated this a bit, renamed the parameter to I also refactored the implementation to make sure that it does a deep merge of the schema and moved it to do it after the other stuff is added. This way this can be used not only for extensions but also to modify the automatically generated schema. I also added some other examples, docs, and tests. This will be available in FastAPI version |
…h operations (fastapi#1922)Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
Uh oh!
There was an error while loading.Please reload this page.
Description
This PR adds support for specifying extra info for the JSON schema of path operations. This is so thatOpenAPI extensions can be used when declaring routes.
Use case
We need this because we rely on open api extensions to configure our service mesh (linkerd) forretries andtimeouts, but there are probably many use cases for this.
Implementation
Operationaccepts any extra info, which matches the behavior ofPath,Field,Query, etc. There might be an argument to restrict it tox-prefixed fields, but this will be more complex. I'm not sure it is worth it.