Clarify ordering of auth schemes in ServiceIndex #1915
Merged
Conversation
This file contains 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
sugmanue
approved these changes
Aug 10, 2023
gosar
approved these changes
Aug 10, 2023
syall
approved these changes
Aug 10, 2023
gosar
reviewed
Aug 14, 2023
| assertThat(auth, hasKey(HttpBearerAuthTrait.ID)); | ||
| List<ShapeId> ids = new ArrayList<>(auth.keySet()); | ||
| assertThat(ids, hasSize(3)); | ||
| assertThat(ids.get(0), equalTo(HttpBasicAuthTrait.ID)); |
There was a problem hiding this comment.
getsAuthSchemesOfServiceWithAuthTrait below also should assert the order instead of just hasKey.
Updates the docs for getEffectiveAuthSchemes to clarify that the returned auth schemes will be in alphabetical order by shape id if there is no `auth` trait present. This was always the case due to the usage of TreeMap, but the documentation didn't explicitly state it. Tests were also updated to ensure this ordering.
milesziemer
force-pushed
the
authscheme-ordering
branch
from
e3cb19d to
067e82b
Compare
milesziemer
added a commit
to milesziemer/smithy
that referenced
this pull request
Aug 16, 2023
Updates javadoc for ServiceIndex::getAuthSchemes to say the returned order is alphabetical. Tests were updated in smithy-lang#1915 to assert this ordering for ServiceIndex::getEffectiveAuthSchemes, but it also made the same update for the ServiceIndex::getAuthSchemes test. The PR didn't include a javadoc update, so the purpose of this PR is to fix that.
milesziemer
added a commit
to milesziemer/smithy
that referenced
this pull request
Aug 16, 2023
Updates javadoc for ServiceIndex::getAuthSchemes to say the returned order is alphabetical. Tests were updated in smithy-lang#1915 to assert this ordering for ServiceIndex::getEffectiveAuthSchemes, but it also made the same update for the ServiceIndex::getAuthSchemes test. The PR didn't include a javadoc update, so the purpose of this PR is to fix that.
milesziemer
added a commit
that referenced
this pull request
Aug 18, 2023
Updates javadoc for ServiceIndex::getAuthSchemes to say the returned order is alphabetical. Tests were updated in #1915 to assert this ordering for ServiceIndex::getEffectiveAuthSchemes, but it also made the same update for the ServiceIndex::getAuthSchemes test. The PR didn't include a javadoc update, so the purpose of this PR is to fix that.
alextwoods
pushed a commit
to alextwoods/smithy
that referenced
this pull request
Sep 15, 2023
Updates the docs for getEffectiveAuthSchemes to clarify that the returned auth schemes will be in alphabetical order by shape id if there is no `auth` trait present. This was always the case due to the usage of TreeMap, but the documentation didn't explicitly state it. Tests were also updated to ensure this ordering.
alextwoods
pushed a commit
to alextwoods/smithy
that referenced
this pull request
Sep 15, 2023
Updates javadoc for ServiceIndex::getAuthSchemes to say the returned order is alphabetical. Tests were updated in smithy-lang#1915 to assert this ordering for ServiceIndex::getEffectiveAuthSchemes, but it also made the same update for the ServiceIndex::getAuthSchemes test. The PR didn't include a javadoc update, so the purpose of this PR is to fix that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updates the docs for getEffectiveAuthSchemes to clarify that the returned auth schemes will be in alphabetical order by shape id if there is no
authtrait present. This was always the case due to the usage of TreeMap, but the documentation didn't explicitly state it.Tests were also updated to ensure this ordering.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.