Skip to content

docs(api): better document refresh token behavior - #894

Merged
kevincador merged 1 commit into
masterfrom
docs/oauth-refresh-token
Jul 30, 2026
Merged

docs(api): better document refresh token behavior#894
kevincador merged 1 commit into
masterfrom
docs/oauth-refresh-token

Conversation

@kevincador

Copy link
Copy Markdown
Contributor

Summary

Clarifies how OAuth refresh tokens behave and documents the error response returned when a token exchange fails.

Addresses the documentation follow-up from #888.

Changes

  • Document that refresh tokens are single-use.
  • Explain that clients must store the replacement refresh token returned by each successful exchange.
  • Document the structured 400 OAuth error response.
  • Add descriptions to the request and response refresh_token fields.

Risk

Low. These changes affect contract documentation and the generated OpenAPI error schema without changing authentication behavior.

Notes

The documentation guide has already been updated with a "Refreshing an Access Token" section: https://docs.trakt.tv/docs/authentication-oauth

@kevincador
kevincador merged commit 3472254 into master Jul 30, 2026
3 checks passed
@kevincador
kevincador deleted the docs/oauth-refresh-token branch July 30, 2026 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant