serverless/serverless

In serverless.yml, allow apiName and endpointType to be specified under apiGateway key

Open

#9 183 ouverte le 25 mars 2021

Voir sur GitHub
 (15 commentaires) (0 réactions) (0 assignés)JavaScript (46 915 stars) (5 734 forks)batch import
cat/aws-event-api-gatewaydeprecationenhancementgood first issuehelp wanted

Description

There's a warning that states that, in Serverless Framework 3.0, apiKeys, usagePlan and resourcePolicy keys are only going to be available under provider.apiGateway, however, there are some extra fields related to the API that are still leftover in the provider key, e.g apiName and endpointType and 1) there's no warning for them 2) it's not possible for use them inside apiGateway (have no effect).

Guide contributeur

Stack technique
javascriptnodejsawsrest api
Domaine
backendinfrastructuredevopscloud
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
serverless frameworkAWS API GatewayYAML configurationNode.js
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
45
Direction de recherche
Investigate the serverless framework's configuration handling for apiName and endpointType. Look at the source files related to API Gateway compilation, likely in the `lib/plugins/aws/package/compile/events/apiGateway/` directory. Check the provider schema to see how these properties are defined. Review issue comments for any maintainer guidance on implementation approach.