Add validator for services with no auth trait #1929
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
milesziemer
force-pushed
the
auth-schemes-with-no-auth-validator
branch
from
edcc172 to
f450453
Compare
syall
reviewed
Aug 16, 2023
...java/software/amazon/smithy/model/validation/validators/ServiceWithNoAuthTraitValidator.java
Outdated
Show resolved
Hide resolved
milesziemer
force-pushed
the
auth-schemes-with-no-auth-validator
branch
from
f450453 to
6b5489b
Compare
gosar
reviewed
Aug 16, 2023
| * Validates that services with multiple @authDefinition traits applied also | ||
| * have an @auth trait applied. | ||
| */ | ||
| public class ServiceWithNoAuthTraitValidator extends AbstractValidator { |
There was a problem hiding this comment.
Instead of being so specific, I think this could be ServiceAuthDefinitionsValidator. In the future maybe we'll want to warn if service has 0 auth schemes?
There was a problem hiding this comment.
Updated. Also changed the javadoc for the class
Adds a validator that warns when there's a service shape that has multiple authDefinition traits applied, but no auth trait. This encourages the use of the auth trait so auth scheme priority is being modeled explicitly. It also allows for tooling to look for and use this validation event. Documentation was also updated to explain that without the auth trait, auth scheme ordering is alphabetical. A test for the auth trait (auth-trait-must-target-service-schemes) was updated to avoid getting the warning message from the new validator.
milesziemer
force-pushed
the
auth-schemes-with-no-auth-validator
branch
from
6b5489b to
8655119
Compare
gosar
approved these changes
Aug 16, 2023
syall
approved these changes
Aug 16, 2023
alextwoods
pushed a commit
to alextwoods/smithy
that referenced
this pull request
Sep 15, 2023
Adds a validator that warns when there's a service shape that has multiple authDefinition traits applied, but no auth trait. This encourages the use of the auth trait so auth scheme priority is being modeled explicitly. It also allows for tooling to look for and use this validation event. Documentation was also updated to explain that without the auth trait, auth scheme ordering is alphabetical. A test for the auth trait (auth-trait-must-target-service-schemes) was updated to avoid getting the warning message from the new validator.
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.
Adds a validator that warns when there's a service shape that has multiple authDefinition traits applied, but no auth trait. This encourages the use of the auth trait so auth scheme priority is being modeled explicitly. It also allows for tooling to look for and use this validation event.
Documentation was also updated to explain that without the auth trait, auth scheme ordering is alphabetical.
A test for the auth trait (auth-trait-must-target-service-schemes) was updated to avoid getting the warning message from the new validator.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.