Skip to content

Add documentation and test for additionalTypes in GraphQLSchema #4208

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.

Sign up for GitHub

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

Jump to bottom
Merged
andimarek merged 2 commits into from
Jan 19, 2026
Merged

Add documentation and test for additionalTypes in GraphQLSchema #4208

andimarek merged 2 commits into from
Jan 19, 2026
+229 −1

Conversation

@andimarek
Copy link
Member

@andimarek andimarek commented Jan 19, 2026 •
edited
Loading

Clarify additional types purpose.

@andimarek
Add documentation and test for additionalTypes in GraphQLSchema
6d61912 
- Add comprehensive JavaDoc to getAdditionalTypes() explaining when
  additional types are needed (interface implementations, SDL schemas,
  programmatic schemas with type references)
- Add JavaDoc to builder methods additionalTypes(), additionalType(),
  and clearAdditionalTypes()
- Document that there are no restrictions on what types can be added
- Add test demonstrating that additionalTypes accepts any type,
  including types already reachable from root operations
- Add .vscode to .gitignore
@github-actions
Copy link
Contributor

github-actions bot commented Jan 19, 2026 •
edited
Loading

Test Results

  327 files  ±0    327 suites  ±0   5m 12s ⏱️ -5s
5 228 tests +1  5 219 ✅ +1  9 💤 ±0  0 ❌ ±0 
5 317 runs  +1  5 308 ✅ +1  9 💤 ±0  0 ❌ ±0 

Results for commit c4fc1d0. ± Comparison against base commit 7fb2729.

This pull request removes 213 and adds 190 tests. Note that renamed tests count towards both. 
	?

	, expected: combo-\"\\\b\f\n\r\t, #4]
                __schema { types { fields { args { type { name fields { name }}}}}}
                __schema { types { fields { type { name fields { name }}}}}
                __schema { types { inputFields { type { inputFields { name }}}}}
                __schema { types { interfaces { fields { type { interfaces { name } } } } } }
                __schema { types { name} }
                __type(name : "t") { name }
                a1: __schema { types { name} }
                a1: __type(name : "t") { name }
…

graphql.AssertTest ‑ assertFalse with different number of error args but false does not throw assertions [toRun: <graphql.AssertTest$__spock_feature_0_21prov0_closure23@255eaa6b delegate=graphql.AssertTest@36a6bea6 owner=graphql.AssertTest@36a6bea6 thisObject=graphql.AssertTest@36a6bea6 resolveStrategy=0 directive=0 parameterTypes=[class java.lang.Object] maximumNumberOfParameters=1 bcw=null>, expectedMessage: error arg1, #0]
graphql.AssertTest ‑ assertFalse with different number of error args but false does not throw assertions [toRun: <graphql.AssertTest$__spock_feature_0_21prov0_closure24@476fe690 delegate=graphql.AssertTest@36a6bea6 owner=graphql.AssertTest@36a6bea6 thisObject=graphql.AssertTest@36a6bea6 resolveStrategy=0 directive=0 parameterTypes=[class java.lang.Object] maximumNumberOfParameters=1 bcw=null>, expectedMessage: error arg1 arg2, #1]
graphql.AssertTest ‑ assertFalse with different number of error args but false does not throw assertions [toRun: <graphql.AssertTest$__spock_feature_0_21prov0_closure25@7a0e7ecd delegate=graphql.AssertTest@36a6bea6 owner=graphql.AssertTest@36a6bea6 thisObject=graphql.AssertTest@36a6bea6 resolveStrategy=0 directive=0 parameterTypes=[class java.lang.Object] maximumNumberOfParameters=1 bcw=null>, expectedMessage: error arg1 arg2 arg3, #2]
graphql.AssertTest ‑ assertFalse with different number of error args throws assertions [toRun: <graphql.AssertTest$__spock_feature_0_20prov0_closure20@21bd20ee delegate=graphql.AssertTest@36a6bea6 owner=graphql.AssertTest@36a6bea6 thisObject=graphql.AssertTest@36a6bea6 resolveStrategy=0 directive=0 parameterTypes=[class java.lang.Object] maximumNumberOfParameters=1 bcw=null>, expectedMessage: error arg1, #0]
graphql.AssertTest ‑ assertFalse with different number of error args throws assertions [toRun: <graphql.AssertTest$__spock_feature_0_20prov0_closure21@26c47874 delegate=graphql.AssertTest@36a6bea6 owner=graphql.AssertTest@36a6bea6 thisObject=graphql.AssertTest@36a6bea6 resolveStrategy=0 directive=0 parameterTypes=[class java.lang.Object] maximumNumberOfParameters=1 bcw=null>, expectedMessage: error arg1 arg2, #1]
graphql.AssertTest ‑ assertFalse with different number of error args throws assertions [toRun: <graphql.AssertTest$__spock_feature_0_20prov0_closure22@421056e5 delegate=graphql.AssertTest@36a6bea6 owner=graphql.AssertTest@36a6bea6 thisObject=graphql.AssertTest@36a6bea6 resolveStrategy=0 directive=0 parameterTypes=[class java.lang.Object] maximumNumberOfParameters=1 bcw=null>, expectedMessage: error arg1 arg2 arg3, #2]
graphql.AssertTest ‑ assertNotNull with different number of  error args throws assertions [toRun: <graphql.AssertTest$__spock_feature_0_5prov0_closure3@35267fd4 delegate=graphql.AssertTest@36a6bea6 owner=graphql.AssertTest@36a6bea6 thisObject=graphql.AssertTest@36a6bea6 resolveStrategy=0 directive=0 parameterTypes=[class java.lang.Object] maximumNumberOfParameters=1 bcw=null>, expectedMessage: error arg1, #0]
graphql.AssertTest ‑ assertNotNull with different number of  error args throws assertions [toRun: <graphql.AssertTest$__spock_feature_0_5prov0_closure4@711d1a52 delegate=graphql.AssertTest@36a6bea6 owner=graphql.AssertTest@36a6bea6 thisObject=graphql.AssertTest@36a6bea6 resolveStrategy=0 directive=0 parameterTypes=[class java.lang.Object] maximumNumberOfParameters=1 bcw=null>, expectedMessage: error arg1 arg2, #1]
graphql.AssertTest ‑ assertNotNull with different number of  error args throws assertions [toRun: <graphql.AssertTest$__spock_feature_0_5prov0_closure5@67c5ac52 delegate=graphql.AssertTest@36a6bea6 owner=graphql.AssertTest@36a6bea6 thisObject=graphql.AssertTest@36a6bea6 resolveStrategy=0 directive=0 parameterTypes=[class java.lang.Object] maximumNumberOfParameters=1 bcw=null>, expectedMessage: error arg1 arg2 arg3, #2]
graphql.AssertTest ‑ assertNotNull with different number of error args with non null does not throw assertions [toRun: <graphql.AssertTest$__spock_feature_0_6prov0_closure6@7899de11 delegate=graphql.AssertTest@36a6bea6 owner=graphql.AssertTest@36a6bea6 thisObject=graphql.AssertTest@36a6bea6 resolveStrategy=0 directive=0 parameterTypes=[class java.lang.Object] maximumNumberOfParameters=1 bcw=null>, expectedMessage: error arg1, #0]
…

♻️ This comment has been updated with latest results.

bbakerman
bbakerman approved these changes Jan 19, 2026
View reviewed changes
Copy link
Member

@bbakerman bbakerman left a comment

Choose a reason for hiding this comment

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

Excellent

@andimarek andimarek merged commit 2766087 into master Jan 19, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bbakerman bbakerman bbakerman approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@andimarek @bbakerman