Skip to content

Commit

Permalink
x/oauth2: clarify that ExpiresIn is not automatically populated by th…
Browse files Browse the repository at this point in the history
…e package

Added a note to the `ExpiresIn` field documentation to clarify that
the oauth2 package does not automatically populate the `ExpiresIn`
field, even if the server returns an "expires_in" value.
This change helps prevent confusion for developers expecting
ExpiresIn` to be set when interacting with methods like `Config.Exchange`.
  • Loading branch information
soh335 committed Oct 20, 2024
1 parent 3e64809 commit 71e6027
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions token.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ type Token struct {
// relative to an unknown time base approximately around "now".
// It is the application's responsibility to populate
// `Expiry` from `ExpiresIn` when required.
// Note: The oauth2 package does not automatically populate
// `ExpiresIn` even if the server returns an "expires_in" field.
ExpiresIn int64 `json:"expires_in,omitempty"`

// raw optionally contains extra metadata from the server
Expand Down

0 comments on commit 71e6027

Please sign in to comment.