docs(appsync): add mutation example and infrastructure fix

[heitorlessa]

Issue number: #1953

Summary

Changes

Please provide a summary of what's being changed

This PR extends the getting started example by adding a mutation. Previously, we only had queries, making it harder to work with mutations for newcomers of Event Handler AppSync.

• Add createTodo mutation in the schema
• Enable mutations in the GraphQL Schema (schema { mutation: Mutation })
• Updated code snippet to include a mutation event resolution (getting_started_graphql_api_resolver.py)
• Improved documentation experience when viewing multiple sample events with a new tab (Sample events)

It also improves the example infrastructure to ease reproducing it in the future:

• Replace Definition with DefinitionS3Location within TodosApiSchema AppSync API resource. This removes schema duplication and prevent error-prone updates by centralizing in a single source of truth
• Add cfn-lint exception since DefinitionS3Location only works with SAM CLI
• Add requirements.txt with dependencies used so it can be built with sam build --use-container
• Add samconfig.toml to ease deploying next time (sam deploy, or sam deploy -g in other accounts). On the fence about this one as someone else deploying will change the file; will keep it for now as it doesn't harm

User experience

Please share what the user experience looks like before and after this change

Schema extended

New Sample events tab

Sample resolver extended

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[tb102122]

@heitorlessa I think you like to remove "or Title under Todo" in the type explanation section or?
For completion we should also extend the event examples.

I assume something like this:

{
    "arguments": {
        "title": "Titel of DEMO ToDo"
    },
    "identity": null,
    "source": null,
    "request": {
        "headers": {
            "x-forwarded-for": "1.2.3.4, 5.6.7.8",
            "accept-encoding": "gzip, deflate, br",
            "cloudfront-viewer-country": "NL",
            "cloudfront-is-tablet-viewer": "false",
            "referer": "https://eu-west-1.console.aws.amazon.com/appsync/home?region=eu-west-1",
            "via": "2.0 9fce949f3749407c8e6a75087e168b47.cloudfront.net (CloudFront)",
            "cloudfront-forwarded-proto": "https",
            "origin": "https://eu-west-1.console.aws.amazon.com",
            "x-api-key": "da1-c33ullkbkze3jg5hf5ddgcs4fq",
            "content-type": "application/json",
            "x-amzn-trace-id": "Root=1-606eb2f2-1babc433453a332c43fb4494",
            "x-amz-cf-id": "SJw16ZOPuMZMINx5Xcxa9pB84oMPSGCzNOfrbJLvd80sPa0waCXzYQ==",
            "content-length": "114",
            "x-amz-user-agent": "AWS-Console-AppSync/",
            "x-forwarded-proto": "https",
            "host": "ldcvmkdnd5az3lm3gnf5ixvcyy.appsync-api.eu-west-1.amazonaws.com",
            "accept-language": "en-US,en;q=0.5",
            "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:78.0) Gecko/20100101 Firefox/78.0",
            "cloudfront-is-desktop-viewer": "true",
            "cloudfront-is-mobile-viewer": "false",
            "accept": "*/*",
            "x-forwarded-port": "443",
            "cloudfront-is-smarttv-viewer": "false"
        }
    },
    "prev": null,
    "info": {
        "parentTypeName": "Mutation",
        "selectionSetList": [
            "title",
            "id"
        ],
        "selectionSetGraphQL": "{\n  title\n  id\n}",
        "fieldName": "createTodo",
        "variables": {}
    },
    "stash": {}
}

[heitorlessa]

Great catch! I’ll fix these, generate an event just to be safe, and merge it. Thanks a lot again Tobias for helping us out

…

On Tue, 28 Feb 2023 at 21:46, Tobias Bruckert ***@***.***> wrote: @heitorlessa <https://github.com/heitorlessa> I think you like to remove "or Title under Todo" in the type explanation section or? For completion we should also extend the event examples. [image: image] <https://user-images.githubusercontent.com/62531735/221975130-d7c586d6-5dfa-4bf5-8ca4-7ed19c3966bd.png> I assume something like this: { "arguments": { "title": "Titel of DEMO ToDo" }, "identity": null, "source": null, "request": { "headers": { "x-forwarded-for": "1.2.3.4, 5.6.7.8", "accept-encoding": "gzip, deflate, br", "cloudfront-viewer-country": "NL", "cloudfront-is-tablet-viewer": "false", "referer": "https://eu-west-1.console.aws.amazon.com/appsync/home?region=eu-west-1", "via": "2.0 9fce949f3749407c8e6a75087e168b47.cloudfront.net (CloudFront)", "cloudfront-forwarded-proto": "https", "origin": "https://eu-west-1.console.aws.amazon.com", "x-api-key": "da1-c33ullkbkze3jg5hf5ddgcs4fq", "content-type": "application/json", "x-amzn-trace-id": "Root=1-606eb2f2-1babc433453a332c43fb4494", "x-amz-cf-id": "SJw16ZOPuMZMINx5Xcxa9pB84oMPSGCzNOfrbJLvd80sPa0waCXzYQ==", "content-length": "114", "x-amz-user-agent": "AWS-Console-AppSync/", "x-forwarded-proto": "https", "host": "ldcvmkdnd5az3lm3gnf5ixvcyy.appsync-api.eu-west-1.amazonaws.com", "accept-language": "en-US,en;q=0.5", "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:78.0) Gecko/20100101 Firefox/78.0", "cloudfront-is-desktop-viewer": "true", "cloudfront-is-mobile-viewer": "false", "accept": "*/*", "x-forwarded-port": "443", "cloudfront-is-smarttv-viewer": "false" } }, "prev": null, "info": { "parentTypeName": "Mutation", "selectionSetList": [ "title", "id" ], "selectionSetGraphQL": "{\n title\n id\n}", "fieldName": "createTodo", "variables": {} }, "stash": {} } — Reply to this email directly, view it on GitHub <#1964 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBC3AXMILZRB7D74ZSTWZZPZPANCNFSM6AAAAAAVK7W5PY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[heitorlessa]

Now it's ready @tb102122 - Added a sample createTodo JSON event (real event), grouped all events under a new tab Sample events to ease discoverability and improve reading experience.

Also fixed unrelated issues as I was reproducing it with our sample infrastructure.

[heitorlessa]

I'll assume the 🎉 reaction as approval ;) Since @leandrodamascena and @rubenfonseca are unavailable this week, I'm merging and rebuilding the latest doc to prevent any confusion until our next release.

Thanks a lot @tb102122 once again.