fix(apiGateway): support object form for apiKeys entries#716
Merged
zirkelc merged 1 commit intoserverless-operations:masterfrom Mar 26, 2026
Merged
Conversation
Both apiKeys.js and usagePlanKeys.js now accept objects without requiring a name property, allowing value-only keys where AWS auto-generates the name. Fixes serverless-operations#431 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
commit: |
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
2 participants
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.
Summary
Fixes #431
usagePlanKeys.jswas still rejecting any non-stringapiKeyentry with "API Keys must be strings", causing deployment failures when using the object form ({ name, value }).apiKeys.jshad already been updated to accept objects (in #699), butusagePlanKeys.jswas missed.This PR:
usagePlanKeys.jsto accept both strings and objects, consistent withapiKeys.jsnameproperty — value-only objects ({ value: '...' }) are valid since AWS auto-generates the key nameTest plan
apiKeys: ['myKeyName']— plain string array still worksapiKeys: [{ name: 'myKey', value: 'myValue' }]— name + value object worksapiKeys: [{ value: 'myValue' }]— value-only object works (AWS auto-generates name)apiKeys: [{ name: 'myKey' }]— name-only object worksapiKeys: [2]— non-string, non-object still throws🤖 Generated with Claude Code