Skip to content

Fix provider tags on AWS::ApiGateway::RestApi #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+46 −6
Open

Fix provider tags on AWS::ApiGateway::RestApi #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1862607
Allow provider tags on `AWS::ApiGateway::RestApi`
tazorax Oct 31, 2025
e0fb3d9
add tests + doc
tazorax Oct 31, 2025
b7f78f1
remove option
tazorax Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions lib/plugins/aws/package/compile/events/api-gateway/lib/rest-api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,27 @@ module.exports = {
const DisableExecuteApiEndpoint =
apiGateway.disableDefaultEndpoint == null ? undefined : apiGateway.disableDefaultEndpoint;

const properties = {
Name: this.provider.naming.getApiGatewayName(),
BinaryMediaTypes,
DisableExecuteApiEndpoint,
EndpointConfiguration,
};

// Tags
if (this.serverless.service.provider.tags) {
properties.Tags = Object.entries(this.serverless.service.provider.tags).map(
([Key, Value]) => ({
Key,
Value,
})
);
}

_.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Resources, {
[this.apiGatewayRestApiLogicalId]: {
Type: 'AWS::ApiGateway::RestApi',
Properties: {
Name: this.provider.naming.getApiGatewayName(),
BinaryMediaTypes,
DisableExecuteApiEndpoint,
EndpointConfiguration,
},
Properties: properties,
},
});

Expand Down
28 changes: 28 additions & 0 deletions test/unit/lib/plugins/aws/package/compile/events/api-gateway/lib/rest-api.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,34 @@ describe('#compileRestApi()', () => {
});
});

it('should create a REST API resource with tags', () => {
awsCompileApigEvents.serverless.service.provider.tags = {
tagKey1: 'tagValue1',
tagKey2: 'tagValue2',
};

awsCompileApigEvents.compileRestApi();
const resources =
awsCompileApigEvents.serverless.service.provider.compiledCloudFormationTemplate.Resources;

expect(resources.ApiGatewayRestApi).to.deep.equal({
Type: 'AWS::ApiGateway::RestApi',
Properties: {
BinaryMediaTypes: undefined,
DisableExecuteApiEndpoint: undefined,
Name: 'dev-new-service',
EndpointConfiguration: {
Types: ['EDGE'],
},
Policy: '',
Tags: [
{ Key: 'tagKey1', Value: 'tagValue1' },
{ Key: 'tagKey2', Value: 'tagValue2' },
],
},
});
});

it('should create a REST API resource with resource policy', () => {
awsCompileApigEvents.serverless.service.provider.apiGateway = {
resourcePolicy: [
Expand Down