aws / aws/aws-appsync-community

Bug on enum value descriptions

Open
#55 9 comments 24 reactions 0 assignees View on GitHub
feature-request
Dominant language
HTML
Stars
507
Forks
37
PR merge metrics
No merged PRs in 30d

Description

Using descriptions on enum values is not working.

This schema makes AppSync schema parser going crazy

```graphql
# Represents the individual results of a search.
enum SearchType {
# Returns results matching objects.
OBJECT
# Returns results matching users.
USER
}
```

Gives:

![image](https://user-images.githubusercontent.com/4225430/65676101-92b6c300-e04f-11e9-95a1-b282dbcf6b4d.png)

I'm forced to remove all enum value descriptions in my schema...

```graphql
# Represents the individual results of a search.
enum SearchType {
OBJECT
USER
}
```

Is there any workaround to set description on enum values?

Maybe related to:
- https://github.com/aws/aws-appsync-community/issues/38

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the SearchType schema in the AppSync schema parser and compare it with the version without enum value descriptions. Read the related issue #38 for context; done means enum value descriptions are accepted without the parser failure, or a documented workaround is provided.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.