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

Disable sdl comments in executable schema #1935

Merged
merged 1 commit into from
Jun 25, 2024

Conversation

kailyak
Copy link
Contributor

@kailyak kailyak commented Jun 10, 2024

Pull Request type

  • Bugfix
  • Feature
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Other (please describe):

Changes in this PR

Added configuration option to toggle showing graphql SDL comments in introspection query results.
This feature is only on spring-graphql version of dgs-framework.

By default, SDL comments are shown but are configurable in SchemaOptions.

Descriptions: https://spec.graphql.org/June2018/#sec-Descriptions
SDL Comments: https://spec.graphql.org/June2018/#sec-Comments

Config option:
dgs.graphql.introspection.show-sdl-comments: Boolean

Issue # 1031

Testing Done

Manual testing on dgs-spring-graphql sample app via toggling feature and running introspection query, added code tests.

Copy link
Collaborator

@paulbakker paulbakker left a comment

Choose a reason for hiding this comment

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

See comments about the some unrelated changes in the PR, but the change itself looks good.

@kailyak kailyak requested a review from paulbakker June 10, 2024 16:25
Copy link
Contributor

@srinivasankavitha srinivasankavitha left a comment

Choose a reason for hiding this comment

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

Overall looks good to me. I agree with the requested change to add this only for spring-graphql

graphql-dgs-spring-graphql/build.gradle.kts Outdated Show resolved Hide resolved
Remove from graphql-dgs-spring-boot-oss-autoconfigure

Add configuration property to dgs spring graphql integration
@kailyak kailyak force-pushed the disable-sdl-comments-in-executable-schema branch from ad8ab0d to 4449ea1 Compare June 25, 2024 00:39
@kailyak kailyak merged commit 7c37a22 into master Jun 25, 2024
3 checks passed
@kailyak kailyak deleted the disable-sdl-comments-in-executable-schema branch June 25, 2024 00:53
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.

None yet

3 participants