type
Options
Route, request budgets, resource overrides, extensions, and validation rules.
Properties
| Property | Type | Description |
|---|---|---|
Path | string | The Path value. |
MaxBodyBytes | int64 | The MaxBodyBytes value. |
MaxVariableBytes | int | The MaxVariableBytes value. |
MaxDepth | int | The MaxDepth value. |
MaxAliases | int | The MaxAliases value. |
MaxComplexity | int | The MaxComplexity value. |
MaxListLimit | int | The MaxListLimit value. |
AllowIntrospection | bool | The AllowIntrospection value. |
DisablePlayground | bool | DisablePlayground removes the GraphQL playground from the admin. The playground follows the admin's access policy and needs the @riducms/plugin-graphql admin package; disable it for an API-only application that does not install that package. |
Resources | map[string]ResourceOptions | Resources optionally renames or suppresses generated surfaces by collection/global slug. Omitted resources use their manifest labels and expose both queries and mutations. |
Queries | []ExtensionField | The Queries value. |
Mutations | []ExtensionField | The Mutations value. |
ValidationRules | []graphql.ValidationRuleFn | The ValidationRules value. |
How it works
Zero values select bounded secure defaults. Introspection is disabled unless explicitly enabled.
Resources keys are collection or global slugs. Overrides change only GraphQL names/surfaces, not manifest slugs or REST routes.
Full signature
type Options struct {
Path string
MaxBodyBytes int64
MaxVariableBytes int
MaxDepth int
MaxAliases int
MaxComplexity int
MaxListLimit int
AllowIntrospection bool
// DisablePlayground removes the GraphQL playground from the admin. The
// playground follows the admin's access policy and needs the
// @riducms/plugin-graphql admin package; disable it for an API-only
// application that does not install that package.
DisablePlayground bool
// Resources optionally renames or suppresses generated surfaces by
// collection/global slug. Omitted resources use their manifest labels and
// expose both queries and mutations.
Resources map[string]ResourceOptions
Queries []ExtensionField
Mutations []ExtensionField
ValidationRules []enginegraphql.ValidationRuleFn
}