aws / aws-appsync-community

The AWS AppSync community
https://aws.amazon.com/appsync
Apache License 2.0
506 stars 32 forks source link

Improve Error Descriptions during Schema Creation in AppSync with CloudFormation and SAM #292

Open aleguern opened 1 year ago

aleguern commented 1 year ago

Hello Maintainers,

I am an active user of AWS AppSync with CloudFormation and Serverless Application Model (SAM). While designing my schema, I frequently encounter an error: Schema Creation Status is FAILED with details: Failed to parse schema document - ensure it's a valid SDL- formatted document.

Upon investigation, I realized that the AppSync console provides a more specific error when the schema is directly pasted into its online editor. This specific error message is immensely helpful in identifying the problem with the schema.

Therefore, I propose a feature request: Would it be possible to enhance the error descriptions during schema creation in CloudFormation, similar to the ones in the AppSync console? This would improve the debugging experience by making error messages more informative and specific, thereby saving valuable development time.

I appreciate your attention to this matter and look forward to your feedback.

Best regards

onlybakam commented 1 year ago

Hey @aleguern , thanks for the feedback and feature request. You also mention SAM: would it be useful to have a check done before a stack deployment occurs? I'm not sure if this is possible in SAM, but maybe this could stop the deployment from happening altogether.

aleguern commented 1 year ago

It would be great ! Thank you