Developer and user help around maxResults/defaultFetchSize/defaultPageLimitSize

[molexx]

• Please can defaultMaxResults, defaultFetchSize and defaultPageLimitSize be documented - it's a bit confusing working out the differences between them.

• if defaultPageLimitSize is greater than defaultMaxResults, defaultMaxResults is used. Maybe defaultMaxResults should be raised to match defaultPageLimitSize if it is greater?

• Please note a breaking change in the changelog as now by default results will be restricted to 100, whether the query includes paging or not.

• Is there a way to notify the caller that their requested page {limit} has been ignored because it is over the defaultPageLimitSize? Or if they did not specify paging that their results are restricted by the default? I'm not sure about creating an item in the errors array for it but there doesn't seem to be a place for warnings.

[igdianov]

@molexx Good points. The rationale for applying defaultMaxResults to override user specified page limit size is to provide a circuit breaker in case the user want to retrieve unreasonable number of records that may result in OoM.

The defaultPageLimitSize is applied if the user does not specify page size for backward compatibility.

I think it may be a good idea to provide warnings in the errors to notify the user about limits.

At the moment defaultLimitSize and defaultPageSize are set to 100.

[molexx]

Makes sense, thanks.

What about defaultFetchSize?

Also, what happens when multiple schemas are stitched together by GraphQLSchemaRegistration? Does each one keep its own limits or are they merged somehow?

[hump]

Can the user/developer change these default ofs 100 in his application?