awslabs / aws-api-gateway-developer-portal

A Serverless Developer Portal for easily publishing and cataloging APIs
Apache License 2.0
928 stars 401 forks source link

Handle APIs deleted in API GW more gracefully #307

Open echo-bravo-yahoo opened 5 years ago

echo-bravo-yahoo commented 5 years ago

Currently, if customers delete an API in API Gateway, but leave it "Revealed" in the developer portal, they can no longer "Hide" the API in the admin panel, and much of the functionality for end users fails to work (e.g., "Try it out!").

Proposed solution:

When an admin logs in, check the API Gateway service call's APIs list against the catalog list. If the catalog contains any APIs that do not exist in the API Gateway call, prompt the admin with a modal. That modal should offer something like: "It appears that api {name (id)} has been deleted. Would you like to remove that API from the catalog or convert it to a generic API?"

Customers right now encountering this issue:

Make any change that causes the catalog to be re-generated. This could be showing or hiding any API, uploading a generic API, etc. This will flush the deleted API out of the catalog.