aws / aws/aws-appsync-community

Add a directive to hide a field from introspection

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

Description

We really need to have a directive to choose the field I want to hide from introspection, something like:

```graphql
type Mutation {

# This mutation is shown in introspection query.
shown(input: Input): Output

# This mutation is hidden from introspection query.
hidden(input: Input): Output @aws_hide_from_introspection

}
```

This is somewhat related to #20

I'm using `@deprecated` as an ugly workaround:

```graphql
type Mutation {

# This mutation is shown in introspection query.
shown(input: Input): Output

# This mutation is hidden from introspection query.
hidden(input: Input): Output @deprecated(reason: "Hidden")

}
```

`@deprecated` makes the field "hard" to find in GraphQL explorer

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the requested directive behavior in this issue and the related issue #20. Confirm how field introspection currently works in AWS AppSync and determine the design and compatibility requirements before implementation; done means a supported directive hides only the selected field from introspection without affecting its use.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.