aws / aws/aws-appsync-community

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

Open
#292 2 comments 1 reaction 0 assignees View on GitHub
feature-request
Dominant language
HTML
Stars
507
Forks
37
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

Research direction

Start with the AWS AppSync schema-creation path through CloudFormation and SAM, then compare its failure reporting with the AppSync console's online editor. The issue names no repository files or tests, so first confirm whether this community repository contains an implementation entry point or only tracks service feedback. Done would require maintainers to confirm a more specific error description for invalid SDL.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, graphql
Domain
api, backend-api-design, cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.