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: add troubleshooting option for openid-connect #11892

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

yardenshoham
Copy link
Contributor

This solved my issue when nothing else did.

References #11711

This solved my issue when nothing else did.

Signed-off-by: Yarden Shoham <git@yardenshoham.com>
@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. approved doc Documentation things labels Jan 6, 2025
@yardenshoham yardenshoham changed the title docs: Add troubleshooting option for openid-connect docs: add troubleshooting option for openid-connect Jan 6, 2025
bearer_only: false
# this comes from https://github.com/zmartzone/lua-resty-openidc, if this is missing, all information will be stored in the session. This
# causes the cookies to be too large and the request to fail. We have control over id_token, user, enc_id_token, and access_token.
# We currently include only access_token in the session. If this gets too big we can remove it as well.
Copy link
Member

Choose a reason for hiding this comment

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

Could you simplify the comment to

# use session_contents option to configure which information among id_token, user, enc_id_token, and access_token, get stored.

and add the same doc update to the Chinese doc?

# causes the cookies to be too large and the request to fail. We have control over id_token, user, enc_id_token, and access_token.
# We currently include only access_token in the session. If this gets too big we can remove it as well.
session_contents:
access_token: true
Copy link
Member

Choose a reason for hiding this comment

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

Technically this is an attribute that was previously not explicitly exposed, so should be also be added to attribute section of the doc; as well as to the plugin schema in the source code (relevant tests need to be updated as well) 💭 cc: @juzhiyuan

@yardenshoham
Copy link
Contributor Author

Maybe you could take over and do everything in #11889

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved doc Documentation things size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants