Add additionalTypes to generateSchema

[de55]

📝 Description

Additional types cannot be edited, but comments suggest that is the appropriate way to add additional types before generateAdditionalTypes() is called:

    /**
     * Generate the GraphQL type for all the `additionalTypes`. They are generated as non-inputs and not as IDs.
     * If you need to provide more custom additional types that were not picked up from reflection of the schema objects,
     * you can modify the set of `additionalTypes` before you call this method.
     *
     * This function is recursive because while generating the additionalTypes it is possible to create additional types that need to be processed.
     */

🔗 Related Issues

#615

[smyrick]

@de55 I was just looking at this last night and realized our mistake. Thank you for all being on top of changes as an active community member.

How about instead of changing the scope of additionalTypes we add a new optional argument to generateSchema that will allow you to add these.

open fun generateSchema(
        queries: List<TopLevelObject>,
        mutations: List<TopLevelObject> = emptyList(),
        subscriptions: List<TopLevelObject> = emptyList(),
        additionalTypes: Set<KType> = emptySet()
): GraphQLSchema {

    this.additionalTypes.addAll(additionalTypes)
    val builder = GraphQLSchema.newSchema()
    // ... rest of code
}

Then we can make generateAdditionalTypes just protected and not protected open.

[smyrick]

If you update the scope of generateAdditionalTypes can you also change the javadocs to the following:

    /**
     * Generate the GraphQL type for all the `additionalTypes`. They are generated as non-inputs and not as IDs.
     * If you need to provide more custom additional types that were not picked up from reflection of the schema objects,
     * you can provide more types to be added through [generateSchema].
     *
     * This function loops because while generating the additionalTypes it is possible to create more additional types that need to be processed.
     */

[smyrick]

This is a major change on the master branch since we removed the open modified on generateAdditionalTypes but that was only added in on the 2.0 branch so we are back to being backwards compatible with 1.x for this method call at least