happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix `scopes` deprecation message and `Security` docstring

This commit is contained in:
Yurii Motov 2025-11-25 22:01:16 +01:00
parent f42161cd19
commit 367b272a60
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
fastapi/param_functions.py
View File

@ -2396,6 +2396,8 @@ def Security( # noqa: N802
```python ```python
Security(dependency_fn, oauth_scopes=["items", "users"]) Security(dependency_fn, oauth_scopes=["items", "users"])
``` ```
​
""" """
), ),
] = None, ] = None,
@ -2438,8 +2440,8 @@ def Security( # noqa: N802
Declare a FastAPI Security dependency. Declare a FastAPI Security dependency.
The only difference with a regular dependency is that it can declare OAuth2 The only difference with a regular dependency is that it can declare OAuth2
scopes that will be integrated with OpenAPI and the automatic UI docs (by default scopes (`oauth_scopes` parameter) that will be integrated with OpenAPI and the
at `/docs`). automatic UI docs (by default at `/docs`).
It takes a single "dependable" callable (like a function). It takes a single "dependable" callable (like a function).