Skip to content

Fix doc for sync metadata interceptor #35

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

Merged
merged 1 commit into from
Oct 17, 2025
Merged

Fix doc for sync metadata interceptor #35

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
6 changes: 3 additions & 3 deletions docs/interceptors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ An authentication interceptor checking bearer tokens and storing them to a conte
def __init__(self, valid_tokens: list[str]):
self._valid_tokens = valid_tokens

def on_start(self, ctx: RequestContext) -> Token["auth_token"]:
def on_start_sync(self, ctx: RequestContext) -> Token["auth_token"]:
authorization = ctx.request_headers().get("authorization")
if not authorization or not authorization.startswith("Bearer "):
raise ConnectError(Code.UNAUTHENTICATED)
Expand All @@ -221,7 +221,7 @@ An authentication interceptor checking bearer tokens and storing them to a conte
raise ConnectError(Code.PERMISSION_DENIED)
return _auth_token.set(token)

def on_end(self, token: Token["auth_token"], ctx: RequestContext):
def on_end_sync(self, token: Token["auth_token"], ctx: RequestContext):
_auth_token.reset(token)
```

Expand Down Expand Up @@ -253,7 +253,7 @@ the authorization header.
_auth_token = ContextVar["auth_token"]("current_auth_token")

class ClientAuthInterceptor:
def on_start(self, ctx: RequestContext):
def on_start_sync(self, ctx: RequestContext):
auth_token = _auth_token.get(None)
if auth_token:
ctx.request_headers()["authorization"] = f"Bearer {auth_token}"
Expand Down