I'm trying to add documentation to my GraphQL schema in AWS AppSync using the standard GraphQL documentation syntax with triple quotes ("""). While this is standard GraphQL functionality, it doesn't seem to work in AppSync.
Here's my schema example:
"""
Represents the entitlement data for a user.
"""
type EntitlementData {
"""
The unique identifier for the entitlement data.
"""
id: ID!
}
The schema is deployed via CloudFormation and deploys successfully, but the documentation doesn't show up in either:
Additionally, when trying to add these documentation strings directly in the AppSync Schema Editor UI, they disappear immediately after saving the schema.
I know I can add comments with #, and those are preserved in the schema editor, but they still don't show up in the AppSync Documentation Explorer.
Has anyone managed to get GraphQL documentation strings working in AppSync? If not, are there any known workarounds?
Created a ticket for to AWS. Got the answer that this is not (yet) possible.