Skip to content

Commit 92d1399

Browse files
committed
Update getAuthSchemes javadoc
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.
1 parent a13d754 commit 92d1399

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

smithy-model/src/main/java/software/amazon/smithy/model/knowledge/ServiceIndex.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ private Model getModel() {
105105
* <p>An <em>auth defining trait</em> is a trait that is marked with
106106
* the {@code smithy.api#authDefinition} trait.
107107
*
108+
* <p>The returned map is ordered alphabetically by absolute shape ID.
109+
*
108110
* <p>An empty map is returned if {@code id} cannot be found in the
109111
* model or is not a service shape.
110112
*
@@ -127,7 +129,7 @@ public Map<ShapeId, Trait> getAuthSchemes(ToShapeId service) {
127129
*
128130
* <p>The returned map is provided in the same order as the values in the
129131
* {@code auth} trait if an auth trait is present, otherwise the result
130-
* returned is ordered alphabetically by absolute shape id.
132+
* returned is ordered alphabetically by absolute shape ID.
131133
*
132134
* <p>An empty map is returned if {@code service} cannot be found in the
133135
* model or is not a service shape.
@@ -167,7 +169,7 @@ public Map<ShapeId, Trait> getEffectiveAuthSchemes(ToShapeId service) {
167169
*
168170
* <p>The returned map is provided in the same order as the values in the
169171
* {@code auth} trait if an auth trait is present, otherwise the result
170-
* returned is ordered alphabetically by absolute shape id.
172+
* returned is ordered alphabetically by absolute shape ID.
171173
*
172174
* <p>An empty map is returned if {@code service} shape cannot be found
173175
* in the model or is not a service shape. An empty map is returned if

0 commit comments

Comments
 (0)