Skip to content
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.

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

docs: clarify graceful refresh token rotation #1959

Merged
merged 3 commits into from
Dec 3, 2024
Merged

Conversation

aeneasr
Copy link
Member

@aeneasr aeneasr commented Dec 2, 2024

Related Issue or Design Document

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.sh) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

Copy link
Member

@vinckr vinckr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use bold only when writing about user interface (UI) elements.

@aeneasr
Copy link
Member Author

aeneasr commented Dec 3, 2024

Hm, I find the text on the left easier to read - is it not common to make the - text: part before the : bold to summarize the point?

Screenshot 2024-12-03 at 12 43 10

@vinckr
Copy link
Member

vinckr commented Dec 3, 2024

Hm, I find the text on the left easier to read - is it not common to make the - text: part before the : bold to summarize the point?

Maybe, but at the moment we follow the microsoft style guide which says bolding only in special cases such as describing UI.

We can change that, but it would need to be consistent across the whole documentation and documented clearly in the style guide.
What is no go in my opinion is everyone contributing to docs doing it in their own style and then its absolutely disjointed.

@aeneasr
Copy link
Member Author

aeneasr commented Dec 3, 2024

OK, thank you for updating it!

@aeneasr aeneasr merged commit 1456674 into master Dec 3, 2024
7 checks passed
@aeneasr aeneasr deleted the add-graceful-docs branch December 3, 2024 13:42
@@ -55,10 +55,21 @@ with new tokens for each request without immediate invalidation of the original

## Example behavior with grace period

- **Using the refresh token within the grace period**: If a refresh token is used twice within the configured grace period (for
When the user calls `/oauth2/auth` and performs login and consent, the OAuth2 server issues an access token and a refresh token.
These tokens and all subsequent tokens issued within the grace period are part of the same consent request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase "consent request" is, I think, a Hydra implementation artifact.

Maybe some day we can clarify the concepts both in documenation and in code.

It's a difficult thing to wrap your head around. This is just a side remark.

This PR is 👍

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I actually struggled quite hard in trying to find the right phrase. Is it login request? consent request? token chain? consent flow? authorized consent id? Haven't found a good solution yet.

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.

3 participants