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

update README re: discovery doc validation disabling #521

Merged
merged 1 commit into from
Jul 17, 2019
Merged

update README re: discovery doc validation disabling #521

merged 1 commit into from
Jul 17, 2019

Conversation

cconcannon
Copy link

As a follow-up to the [closed] issue #419

Requesting to update the README with instructions for configuring ID Providers that do not have the issuer url as the base for other url's at the discovery endpoint. For these ID Providers, the strictDiscoveryDocumentValidation parameter must be set to false in order for the library to function.

The discovery document validation is not part of OIDC specification. OIDC Specification states that the Issuer property can optionally contain path components in the uri scheme (https://openid.net/specs/openid-connect-discovery-1_0.html#IssuerDiscovery)

Copy link
Collaborator

@jeroenheijmans jeroenheijmans left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, the text looks good to me. I have two suggestions / remarks though:

  1. Take care with your editor. The commit touches many lines by merely updating the bullit list character or affacting some whitespace. On one hand this seems like a minor thing, but on the other it can make merging multiple PRs on the readme a huge pain. I suggest reverting all those changes.
  2. I think a strict-document-validation.md file in the docs-src/ folder for this makes more sense (I'd rely on Google to send people to there instead of to the readme for the proper search terms, but if you'd prefer we could link to the docs from the readme)

PS. Note I'm just a contributor of the library, not a maintainer.

@cconcannon
Copy link
Author

Thank you @jeroenheijmans for your feedback. I cleaned up my commit and refactored the suggestions into a new .md file in the additional documentation section. I also linked to my new documentation in the "Original Config API section of the documents.

@jeroenheijmans
Copy link
Collaborator

LGTM! 👍

@manfredsteyer manfredsteyer merged commit 952b292 into manfredsteyer:master Jul 17, 2019
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