Skip to content

♻️ Fix Examples in the documentation #725

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

Closed
wants to merge 1 commit into from
Closed

♻️ Fix Examples in the documentation #725

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions docs/get-started/refresh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,17 @@ To implement an explicit refresh mechanism, you need to create a new route that
```python
from pydantic import BaseModel
from fastapi import FastAPI, Depends, HTTPException
from authx import AuthX, TokenPayload
from authx import AuthX, AuthXConfig, TokenPayload

# Create an AuthX configuration
auth_config = AuthXConfig()
auth_config.JWT_ALGORITHM = 'HS256'
auth_config.JWT_SECRET_KEY = 'SECRET_KEY'
auth_config.JWT_TOKEN_LOCATION = ['headers']


app = FastAPI()
security = AuthX()
security = AuthX(auth_config)

class LoginForm(BaseModel):
username: str
Expand Down Expand Up @@ -73,8 +80,8 @@ This example provides a basic implementation of an explicit refresh mechanism. I

```sh
# We request access to the protected route with the token
$ curl -s --oauth2-bearer $TOKEN http://0.0.0.0:8000/sensitive_operation
"You have access to this sensitive operation"
$ curl -s --oauth2-bearer $TOKEN http://0.0.0.0:8000/protected
"You have access to this protected resource"
```
=== "3. Refreshing Access Token"

Expand Down
Loading