docs: Appsync Events #117
Open
docs: Appsync Events #117
+257
−25
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying localstack-docs with
|
| Latest commit: |
73cf160
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a86ebde1.localstack-docs.pages.dev |
| Branch Preview URL: | https://appsync-event-docs.localstack-docs.pages.dev |
1. I think it's a better user experience to have the 2 ways to get started as subsections to one main Getting Started section.
2. For improved readability, I've numbered the items you need to do for each getting started option, like so:
|
|
Preview latest draft here: cc @cloutierMat |
quetzalliwrites
approved these changes
Jul 30, 2025
cloutierMat
commented
Jul 30, 2025
|
|
||
| LocalStack supports code evaluation endpoints: [`EvaluateCode`](https://docs.aws.amazon.com/appsync/latest/APIReference/API_EvaluateCode.html) and [`EvaluateMappingTemplate`](https://docs.aws.amazon.com/appsync/latest/APIReference/API_EvaluateMappingTemplate.html). | ||
|
|
||
| Code can be either passed in as a string, or from a file with the `file://` prefix for the `--template/--code` arguments. | ||
| See the AWS documentation for [`evaluate-mapping-template`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appsync/evaluate-mapping-template.html) and [`evaluate-code`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appsync/evaluate-code.html) for more details. | ||
|
|
||
| ### VTL resolver templates |
There was a problem hiding this comment.
We could change this as well for consistency
Suggested change
| ### VTL resolver templates | |
| ### VTL template evaluation |
cloutierMat
commented
Jul 30, 2025
There was a problem hiding this comment.
Thanks for the structure update. I was trying to avoid going 4 "#" deep as we lose it in the TOC... but it might be unavoidable....
Going trough the order, I understand that you are trying to avoid 2 "Getting Started", but I feel it might be necessary since right now the docs jump from GraphQL to Events and back multiple times, and that also seems confusing.
What do you think of the following order?
- Introduction
- GraqhQL API
-
- Getting Started
-
- Resolvers
-
- Configuring Endpoints
-
- Resource Browser
-
- Example
- Events API
-
- Getting Started
-
- Code Handlers
-
- Configuring Endpoints
-
- Resource Browser
- Shared configurations
-
- Custom API IDs
-
- Data Sources
- Evaluation Endpoints
- API Coverage
In time we can add more information to Events API with example and some extra details. Since both APIs are solving a different problems for different users, I think that having the docs grouped by APIs will be more beneficial.
curious to hear @simonrw's opinion as well
| LocalStack supports the resolver evaluation endpoints: [`EvaluateCode`](https://docs.aws.amazon.com/appsync/latest/APIReference/API_EvaluateCode.html) and [`EvaluateMappingTemplate`](https://docs.aws.amazon.com/appsync/latest/APIReference/API_EvaluateMappingTemplate.html). | ||
| ## Event handlers | ||
|
|
||
| LocalStack supports configuring [code handlers](https://docs.aws.amazon.com/appsync/latest/eventapi/runtime-reference-overview.html) for your channel namespace. Code handlers can be configured with or without [data sources](#data-sources). |
There was a problem hiding this comment.
That might be relevant to add a link for channel namespace as well
Suggested change
| LocalStack supports configuring [code handlers](https://docs.aws.amazon.com/appsync/latest/eventapi/runtime-reference-overview.html) for your channel namespace. Code handlers can be configured with or without [data sources](#data-sources). | |
| LocalStack supports configuring [code handlers](https://docs.aws.amazon.com/appsync/latest/eventapi/runtime-reference-overview.html) for your [channel namespace](#2-create-a-channelnamespace). Code handlers can be configured with or without [data sources](#data-sources). |
Comment on lines
+18
to
+28
| This guide is designed for users new to **AppSync** in LocalStack, and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script. | ||
|
|
||
| LocalStack supports two primary ways to work with AppSync: | ||
|
|
||
| * **GraphQL**: use schemas and resolvers to interact with data sources like DynamoDB. | ||
| * **Events API**: enable sending real-time event data to subscribed clients. | ||
|
|
||
| Start your LocalStack container using your preferred method, then jump into the section that matches your use case: | ||
|
|
||
| * [GraphQL API](#graphql-api): build query-based APIs with schema-first design. | ||
| * [Events API](#events-api): build with publish/subscribe style, real-time messaging. |
There was a problem hiding this comment.
We could move that section in Introduction So as to provide a quick way for users to get tot the API that is interesting to them
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pr introduces AppSync Events API documentation. As we are sharing the page with AppSync GraphQL APIs, some restructure is also added in the pr to help keeping a clear and understandable view of the docs