refactor: improve HttpApi authorizer validation#3899
Open
refactor: improve HttpApi authorizer validation#3899
Conversation
Contributor
|
For this #3817 (comment), it seems customer is using the schema defined for cloudformation apigatewayv2, not SAM's schema for http api, since sam http api doesn't support AuthorizerResultTtlInSeconds, rather this cache config is embedded into Identity's ReauthorizeEvery |
Contributor
|
There is still some tests failed. Otherwise LGTM. |
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
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.
Issue #, if available
Close #3817
Description of changes
Refactor HttpApi authorizer property validation in apigatewayv2.py from repetitive if/raise blocks to a data-driven approach using two declarative dicts (ALLOWED_PROPERTIES and PROPERTY_DISPLAY). This replaces
~40 lines of repetitive validation with a 4-line loop, making it easier to maintain and extend when new authorizer types or properties are added.
No behavior change — same properties are blocked for the same authorizer types. The only user-facing difference is improved error messages:
The IdentitySource property is intentionally only supported for OAuth2Authorizer per the SAM schema
(https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-httpapi-oauth2authorizer.html). For LambdaAuthorizer, the
Identity(https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-property-httpapi-lambdaauthorizationidentity.html) property (with Headers, QueryStrings, StageVariables, Context) is the
correct way to set identitySource. The updated error message now guides users to this.
Description of how you validated changes
get-authorizers
Checklist
Examples?
Please reach out in the comments if you want to add an example. Examples will be
added to sam init through aws/aws-sam-cli-app-templates (https://github.com/aws/aws-sam-cli-app-templates).
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.