Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Augmented schema is missing description for relationship fields #764

Closed
Roei-Levi opened this issue Jan 10, 2022 · 2 comments · Fixed by #820
Closed

Augmented schema is missing description for relationship fields #764

Roei-Levi opened this issue Jan 10, 2022 · 2 comments · Fixed by #820
Labels
bug Something isn't working confirmed Confirmed bug

Comments

@Roei-Levi
Copy link

Roei-Levi commented Jan 10, 2022

Describe the bug
Every field in a GraphQL schema can have a description associated with it. However, the augmented schema doesn't seem to include the description on fields with the "relationship" directive specified to them.

Type definitions

type Application {
	"Application ID"
	id: ID

	**"Related Object Description"
	object: [Service] @relationship(type: "has_object", direction: OUT)**
}
type Service{
	"Service ID"
	id: ID
}

To Reproduce
Run the server with a GraphQL schema similar to the one above. The description property is missing from the "object" field.

Expected behavior
The description "Related Object Description" should be shown in the graphQL documentation of the "object" field.

Additional context
I presume that the description is dropped when the function createRelationshipFields() is executed to create relationship fields.

@Roei-Levi Roei-Levi added the bug Something isn't working label Jan 10, 2022
@neo4j-team-graphql
Copy link
Collaborator

Many thanks for raising this bug report @Roei-Levi. 🐛 We will now attempt to reproduce the bug based on the steps you have provided.

Please ensure that you've provided the necessary information for a minimal reproduction, including but not limited to:

  • Type definitions
  • Resolvers
  • Query and/or Mutation (or multiple) needed to reproduce

Thanks again! 🙏

@neo4j-team-graphql neo4j-team-graphql added the confirmed Confirmed bug label Jan 10, 2022
@neo4j-team-graphql
Copy link
Collaborator

We've been able to confirm this bug using the steps to reproduce that you provided - many thanks @Roei-Levi! 🙏 We will now prioritise the bug and address it appropriately.

@darrellwarde darrellwarde linked a pull request Jan 19, 2022 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working confirmed Confirmed bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants