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

Remove GraphiQL Explorer; fix headers property #1174

Merged
merged 3 commits into from
Nov 28, 2024
Merged

Remove GraphiQL Explorer; fix headers property #1174

merged 3 commits into from
Nov 28, 2024

Conversation

Shane32
Copy link
Member

@Shane32 Shane32 commented Nov 28, 2024

Changes:

  • Removes GraphiQL Explorer due to incompatibility with GraphiQL 3.x
  • Marks ExplorerExtensionEnabled (which did nothing) as obsolete
  • Fixes HeaderEditorEnabled so it works properly

@Shane32 Shane32 self-assigned this Nov 28, 2024
@@ -286,7 +275,7 @@
onEditQuery: onEditQuery,
onEditVariables: onEditVariables,
onEditOperationName: onEditOperationName,
headerEditorEnabled: @Model.HeaderEditorEnabled,
isHeadersEditorEnabled: @Model.HeaderEditorEnabled,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The HeaderEditorEnabled property was ineffective because the react property name was incorrect. This change fixes the bug.

/// </summary>
[Obsolete("This property has no effect and will be removed in a future version.")]
public bool ExplorerExtensionEnabled { get; set; } = true;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was no code tied to this property within the entire codebase. So it could not be disabled.

Comment on lines -59 to -69
<script
src="https://unpkg.com/[email protected]/graphiqlWithExtensions.min.js"
integrity="sha384-TqI6gT2PjmSrnEOTvGHLad1U4Vm5VoyzMmcKK0C/PLCWTnwPyXhCJY6NYhC/tp19"
crossorigin="anonymous"
></script>
<link
rel="stylesheet"
href="https://unpkg.com/[email protected]/graphiqlWithExtensions.css"
integrity="sha384-GBqwox+q8UtVEyBLBKloN5QDlBDsQnuoSUfMeJH1ZtDiCrrk103D7Bg/WjIvl4ya"
crossorigin="anonymous"
/>
Copy link
Member Author

@Shane32 Shane32 Nov 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

graphiql-with-extensions was last released 5 years ago, and its package.json indicates that it was designed for version 0.14.2 of GraphiQL. It does not appear to be compatible with GraphiQL 3.x and so I removed it. GraphiQL does have a docs explorer built-in, although it does not have the checkbox functionality that the graphiql-explorer extension did.

See:

@Shane32 Shane32 added this to the 8.2.0 milestone Nov 28, 2024
@Shane32 Shane32 requested a review from gao-artur November 28, 2024 00:17
@Shane32 Shane32 merged commit 10e5833 into master Nov 28, 2024
7 checks passed
@Shane32 Shane32 deleted the fix_graphiql branch November 28, 2024 16:19
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