serverless / serverless/serverless

Allow options like metrics, logs, tags, and tracing to work with externally defined Rest APIs for the AWS provider

Open
#11,441 4 comments 0 reactions 1 assignee View on GitHub

@dls314 is already working on this.

Since Oct 14, 2022.

question
Dominant language
JavaScript
Stars
46.9k
Forks
5.7k
Avg merge
10h 7m
Merged PRs (30d)
57

Description

Is there an existing issue for this?
  • I have searched existing issues, it hasn't been reported yet
Use case description

I would like to use some of the AWS provider's features for Rest APIs that are managed through updateStage for externally defined Rest APIs.

The protection in updateStage that guards against any of these features being used when the Rest API is externally defined seems very blunt given that some (perhaps all or most) of the features are stage-specific.

I would like to be able to enable all these options for an externally defined Rest API.

I am creating a basic Rest API and logging role externally so that the Rest API id remains stable even if the serverless project's stack is torn down, so that consumers can use the Rest API id, for example to create IAM policies. However, all other management of the Rest API is done through the serverless project.

Proposed solution (optional)

Make everything work normally for externally defined Rest APIs and add a note to the documentation about items that impact the Rest API as a whole versus those that impact just the stage

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.