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

Add documentation for GraphQL Union field bug #397

Merged
merged 1 commit into from
Dec 26, 2023

Conversation

Orrison
Copy link
Collaborator

@Orrison Orrison commented Dec 22, 2023

Ticket(s) or GitHub Issue

Technical Description

There is no fix for this issue. It comes from our usage of Union types that share the same field names but no the same type definition for that field. There is currently no way around this, and it is much discussed in the GraphQL community. graphql/graphql-js#53

Technically, the specification is not hard on this limitation being required. So, I have opened an issue in the underlying PHP GraphQL package to see if it can be fixed. webonyx/graphql-php#1500

But I have added some documentation for now for the workaround.

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Content or styling update (Changes which don't affect functionality)
  • DevOps
  • Documentation

Screenshots (if appropriate)

Any deployment steps required?

A deployment step could be a command that needs to be executed or an ENV key that needs to be added, for example.

  • Yes, please specify
  • No

Before contributing and submitting this PR, make sure you have:

  • Read the contributing guidelines.
  • Title the PR with the ticket/issue number and a short description of the changes made. Or if no ticket/issue exists, title the PR with a short description of the changes made
  • Linked a relevant ticket or issue or describe the issue/feature which this PR resolves/implements.
  • Resolved all conflicts, if any.
  • Rebased your branch PR on top of the latest upstream develop branch.

Signed-off-by: Kevin Ullyott <[email protected]>
@Orrison Orrison requested a review from a team December 22, 2023 20:04
@Orrison Orrison self-assigned this Dec 22, 2023
@Orrison Orrison merged commit 4d2f59d into develop Dec 26, 2023
5 checks passed
@Orrison Orrison deleted the bugfix/ADVAPP-115-prospect-api-first_name-bug branch December 26, 2023 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants