fix(apiGateway): support object form for apiKeys entries (#716)

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 #431

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: VirtueMe

lib/deploy/events/apiGateway/apiKeys.js

@@ -15,8 +15,8 @@ module.exports = {
       _.forEach(apiKeys, (apiKey, i) => {
         const apiKeyNumber = i + 1;
 
-        if (typeof apiKey !== 'string' && (typeof apiKey !== 'object' || !apiKey.name)) {
-          throw new this.serverless.classes.Error('API Keys must be strings or objects with a name property');
+        if (typeof apiKey !== 'string' && typeof apiKey !== 'object') {
+          throw new this.serverless.classes.Error('API Keys must be strings or objects');
         }
 
         const apiKeyName = typeof apiKey === 'object' ? apiKey.name : apiKey;

lib/deploy/events/apiGateway/apiKeys.test.js

@@ -105,6 +105,21 @@ describe('#methods()', () => {
     });
   });
 
+  it('should compile api key resource when apiKey is an object with value only', () => {
+    serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = [
+      { value: 'my-secret-value' },
+    ];
+    return serverlessStepFunctions.compileApiKeys().then(() => {
+      const resource = serverlessStepFunctions.serverless.service.provider
+        .compiledCloudFormationTemplate.Resources[
+          serverlessStepFunctions.provider.naming.getApiKeyLogicalId(1)
+        ];
+      expect(resource.Type).to.equal('AWS::ApiGateway::ApiKey');
+      expect(resource.Properties.Name).to.equal(undefined);
+      expect(resource.Properties.Value).to.equal('my-secret-value');
+    });
+  });
+
   it('should compile api key resource when apiKey is an object with name only', () => {
     serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = [
       { name: 'my-api-key' },

lib/deploy/events/apiGateway/usagePlanKeys.js

@@ -15,8 +15,8 @@ module.exports = {
       _.forEach(apiKeys, (apiKey, i) => {
         const usagePlanKeyNumber = i + 1;
 
-        if (typeof apiKey !== 'string') {
-          throw new this.serverless.classes.Error('API Keys must be strings');
+        if (typeof apiKey !== 'string' && typeof apiKey !== 'object') {
+          throw new this.serverless.classes.Error('API Keys must be strings or objects');
         }
 
         const usagePlanKeyLogicalId = this.provider.naming

lib/deploy/events/apiGateway/usagePlanKeys.test.js

@@ -70,8 +70,42 @@ describe('#compileUsagePlanKeys()', () => {
     expect(() => serverlessStepFunctions.compileUsagePlanKeys()).to.throw(Error);
   });
 
-  it('throw error if an apiKey is not a string', () => {
+  it('throw error if an apiKey is not a string or object', () => {
     serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = [2];
     expect(() => serverlessStepFunctions.compileUsagePlanKeys()).to.throw(Error);
   });
+
+  it('should compile usage plan key resource when apiKey is an object with value only', () => {
+    serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = [
+      { value: 'myKeyValue' },
+    ];
+    return serverlessStepFunctions.compileUsagePlanKeys().then(() => {
+      expect(
+        serverlessStepFunctions.serverless.service.provider.compiledCloudFormationTemplate
+          .Resources[
+            serverlessStepFunctions.provider.naming.getUsagePlanKeyLogicalId(1)
+          ].Type,
+      ).to.equal('AWS::ApiGateway::UsagePlanKey');
+    });
+  });
+
+  it('should compile usage plan key resource when apiKey is an object with name and value', () => {
+    serverlessStepFunctions.serverless.service.provider.apiGateway.apiKeys = [
+      { name: 'myKey', value: 'myKeyValue' },
+    ];
+    return serverlessStepFunctions.compileUsagePlanKeys().then(() => {
+      expect(
+        serverlessStepFunctions.serverless.service.provider.compiledCloudFormationTemplate
+          .Resources[
+            serverlessStepFunctions.provider.naming.getUsagePlanKeyLogicalId(1)
+          ].Type,
+      ).to.equal('AWS::ApiGateway::UsagePlanKey');
+      expect(
+        serverlessStepFunctions.serverless.service.provider.compiledCloudFormationTemplate
+          .Resources[
+            serverlessStepFunctions.provider.naming.getUsagePlanKeyLogicalId(1)
+          ].Properties.KeyId.Ref,
+      ).to.equal('ApiGatewayApiKey1');
+    });
+  });
 });