(@aws-cdk/aws-appsync): support for GraphQL documentation

[fab-mindflow]

Description

It looks like there is no support in code first approach to add documentation (block strings) to generated GraphQL schemas.

Use Case

Generated GraphQL would contain documentation on fields and types.
Tools can then use introspection queries to display documentation from GraphQL schemas generated by @aws-cdk/aws-appsync (we have the use case for our platform).

Proposed Solution

Add an attribute to FieldOptions, IntermediateTypeOptions and more to allow documenting types and fields.

const demo = new appsync.ObjectType('Demo', {
  description: "THIS IS SOME DOCUMENTATION",
  interfaceTypes: [ node ],
  definition: {
    version: appsync.GraphqlType.string({ isRequired: true }),
  },
});

That would result in GraphQL schema:

"""THIS IS SOME DOCUMENTATION"""
type demo {
  id: String!
  version: String!
}

Other information

No response

Acknowledge

• I may be able to implement this feature request
• This feature might incur a breaking change

[otaviomacedo]

It seems that AppSync doesn't support this feature yet: aws/aws-appsync-community#38.

[github-actions]

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.