chore: improve how-to guide concerning scopes#11
Open
mirdono wants to merge 2 commits intomu-semtech:masterfrom
Open
chore: improve how-to guide concerning scopes#11mirdono wants to merge 2 commits intomu-semtech:masterfrom
mirdono wants to merge 2 commits intomu-semtech:masterfrom
Conversation
The initial version of the scopes how-to guide used an `access-by-query` group. But in the typical use case of using scopes to restrict access for a session-less services an `always-accessible` group is likely to be used. This commit updates the how-to guide to match this use case more closely. This situation of combining an `access-by-query` group with a scope is now explained at the end of the guide to clarify the somewhat subtle difference between the two cases.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The initial version of the scopes how-to guide combines an
access-by-querygroup with a scope. Furthermore, the how-to guide was not explicit about the fact that requests need specify the correct scope and belong to the right group.
This PR clarifies this how-to guide by
always-accessiblegroup. This situation matchesthe typical use case using scopes to restrict access for a session-less
service.
applicable.
access-by-querygroup is illustrated as asecond example at the end of the section. This is intended to clarify the
somewhat subtle difference between the two use case.
Furthermore, this PR corrects some smaller errors throughout the README that caught my eye.
Thanks to @cecemel for raising this issue.