gqlgen.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "gqlgen Configuration",
  "description": "Configuration file for gqlgen code generation",
  "type": "object",
  "properties": {
    "schema": {
      "description": "Where are all the schema files located? globs are supported",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "exec": {
      "description": "Where should the generated server code go?",
      "type": "object",
      "properties": {
        "filename": {
          "type": "string",
          "description": "Path to the generated file (required for single-file layout)"
        },
        "package": {
          "type": "string",
          "description": "The go package name"
        },
        "layout": {
          "type": "string",
          "enum": ["single-file", "follow-schema"],
          "default": "single-file"
        },
        "dir": {
          "type": "string",
          "description": "Directory for generated files (required for follow-schema layout)"
        },
        "filename_template": {
          "type": "string",
          "default": "{name}.generated.go",
          "description": "Template for filenames (required for follow-schema layout)"
        },
        "worker_limit": {
          "type": "integer",
          "description": "Maximum number of goroutines in concurrency to use per child resolvers",
          "default": 1000
        }
      }
    },
    "federation": {
      "description": "Federation configuration",
      "type": "object",
      "properties": {
        "filename": { "type": "string" },
        "package": { "type": "string" },
        "version": { "type": "integer" },
        "options": {
          "type": "object",
          "properties": {
            "explicit_requires": {
              "type": "boolean",
              "description": "Generate a function in the execution context to populate fields using the @requires directive into the entity. Cannot be used together with computed_requires.",
              "default": false
            },
            "computed_requires": {
              "type": "boolean",
              "description": "Generate resolver functions to compute values for fields using the @requires directive. Requires federation version 2 and call_argument_directives_with_null to be true. Cannot be used together with explicit_requires.",
              "default": false
            },
            "entity_resolver_multi": {
              "type": "boolean",
              "description": "Default engine for entityResolver generation. Can be overridden per entity with @entityResolver(multi: Boolean) directive.",
              "default": false
            }
          }
        },
        "model_template": { "type": "string" }
      }
    },
    "model": {
      "description": "Where should any generated models go?",
      "type": "object",
      "properties": {
        "filename": { "type": "string" },
        "package": { "type": "string" },
        "model_template": { "type": "string" },
        "version": { "type": "integer" },
        "options": {
          "type": "object",
          "additionalProperties": { "type": "boolean" }
        }
      }
    },
    "resolver": {
      "description": "Where should the resolver implementations go?",
      "type": "object",
      "properties": {
        "layout": {
          "type": "string",
          "enum": ["single-file", "follow-schema"],
          "default": "follow-schema"
        },
        "package": { "type": "string" },
        "dir": { "type": "string" },
        "filename": { "type": "string" },
        "filename_template": {
          "type": "string",
          "default": "{name}.resolvers.go"
        },
        "omit_template_comment": { "type": "boolean" },
        "resolver_template": { "type": "string" },
        "preserve_resolver": { "type": "boolean" },
        "batch": {
          "description": "Enable batch resolver generation for all fields as if they had @goField(batch: true). Individual fields can opt out with @goField(batch: false).",
          "oneOf": [
            { "type": "boolean" },
            {
              "type": "object",
              "properties": {
                "enabled": { "type": "boolean", "default": false }
              }
            }
          ]
        },
        "type": {
          "type": "string",
          "description": "The name of the resolver struct type",
          "default": "Resolver"
        }
      }
    },
    "autobind": {
      "description": "gqlgen will search for any type names in the schema in these go packages",
      "type": "array",
      "items": { "type": "string" }
    },
    "autobind_getter_haser": {
      "description": "Enable getter/haser methods for autobind",
      "type": "boolean",
      "default": false
    },
    "models": {
      "description": "Type mapping between the GraphQL and go type systems",
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "model": {
            "type": "array",
            "items": { "type": "string" }
          },
          "forceGenerate": {
            "type": "boolean",
            "description": "Force generation of this type even if it is mapped to a model"
          },
          "fields": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "Go type for this field"
                },
                "resolver": { "type": "boolean" },
                "fieldName": { "type": "string" },
                "omittable": {
                  "type": "boolean",
                  "description": "Wrap this field with Omittable"
                },
                "autoBindGetterHaser": {
                  "type": "boolean",
                  "description": "Enable getter/haser auto-binding for this field"
                },
                "batch": {
                  "type": "boolean",
                  "description": "Enable batch resolver generation for this field to reduce N+1 queries"
                },
                "forceGenerate": {
                  "type": "boolean",
                  "description": "Force generate this field in the model even when OmitResolverFields is enabled"
                }
              }
            }
          },
          "enum_values": {
            "type": "object",
            "description": "Custom enum value mappings",
            "additionalProperties": {
              "type": "object"
            }
          },
          "extraFields": {
            "type": "object",
            "description": "Additional named fields to add to the generated model",
            "additionalProperties": {
              "type": "object",
              "properties": {
                "type": { "type": "string", "description": "Go type of the extra field" },
                "overrideTags": { "type": "string", "description": "Override the Go struct tag" },
                "description": { "type": "string", "description": "Go doc-comment for the field" }
              }
            }
          },
          "embedExtraFields": {
            "type": "array",
            "description": "Embeddable extra fields to add to the generated model",
            "items": {
              "type": "object",
              "properties": {
                "type": { "type": "string", "description": "Go type of the extra field" },
                "overrideTags": { "type": "string", "description": "Override the Go struct tag" },
                "description": { "type": "string", "description": "Go doc-comment for the field" }
              }
            }
          }
        }
      }
    },
    "struct_tag": {
      "description": "Tag to use for model fields (e.g. json)",
      "type": "string",
      "default": "json"
    },
    "embedded_structs_prefix": {
      "description": "Prefix for embedded structs",
      "type": "string",
      "default": "Base"
    },
    "directives": {
      "description": "Custom directive configuration",
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "skip_runtime": {
            "type": "boolean",
            "description": "Skip runtime directive hook generation"
          },
          "implementation": {
            "type": "string",
            "description": "Static implementation function for the directive"
          }
        }
      }
    },
    "local_prefix": {
      "description": "Local package prefix for import sorting",
      "type": "string"
    },
    "omit_slice_element_pointers": {
      "description": "Turn on to use []Thing instead of []*Thing",
      "type": "boolean",
      "default": false
    },
    "omit_getters": {
      "description": "Turn on to omit getter methods on models",
      "type": "boolean",
      "default": false
    },
    "omit_interface_checks": {
      "description": "Turn on to omit Is<Name>() methods to interface and unions",
      "type": "boolean",
      "default": true
    },
    "omit_complexity": {
      "description": "Turn on to skip generation of ComplexityRoot struct content and Complexity function",
      "type": "boolean",
      "default": false
    },
    "omit_gqlgen_file_notice": {
      "description": "Turn on to not generate any file notice comments in generated files",
      "type": "boolean",
      "default": false
    },
    "omit_gqlgen_version_in_file_notice": {
      "description": "Turn on to exclude the gqlgen version in the generated file notice",
      "type": "boolean",
      "default": false
    },
    "omit_root_models": {
      "description": "Turn on to exclude root models such as Query and Mutation from the generated models file",
      "type": "boolean",
      "default": false
    },
    "omit_resolver_fields": {
      "description": "Turn on to exclude resolver fields from the generated models file",
      "type": "boolean",
      "default": false
    },
    "omit_panic_handler": {
      "description": "Turn on to omit panic handler in the generated server",
      "type": "boolean",
      "default": false
    },
    "omit_enum_json_marshalers": {
      "description": "Turn on to omit JSON marshaler/unmarshaler generation for enums",
      "type": "boolean",
      "default": false
    },
    "struct_fields_always_pointers": {
      "description": "Turn off to make struct-type struct fields not use pointers",
      "type": "boolean",
      "default": true
    },
    "resolvers_always_return_pointers": {
      "description": "Turn off to make resolvers return values instead of pointers for structs",
      "type": "boolean",
      "default": true
    },
    "return_pointers_in_unmarshalinput": {
      "description": "Turn on to return pointers instead of values in unmarshalInput",
      "type": "boolean",
      "default": false
    },
    "nullable_input_omittable": {
      "description": "Wrap nullable input fields with Omittable",
      "type": "boolean",
      "default": true
    },
    "enable_model_json_omitempty_tag": {
      "description": "Enable adding omitempty to the json tag of generated model fields",
      "type": "boolean",
      "default": false
    },
    "enable_model_json_omitzero_tag": {
      "description": "Enable adding omitzero to the json tag of generated model fields",
      "type": "boolean",
      "default": false
    },
    "skip_validation": {
      "description": "Set to speed up generation time by not performing a final validation pass",
      "type": "boolean",
      "default": false
    },
    "skip_mod_tidy": {
      "description": "Set to skip running 'go mod tidy' when generating server code",
      "type": "boolean",
      "default": false
    },
    "fast_validation": {
      "description": "Use -gcflags=\"-N -l\" during validation to disable compiler optimizations for faster cold cache builds",
      "type": "boolean",
      "default": false
    },
    "skip_import_grouping": {
      "description": "Use go/format.Source instead of imports.Process for formatting (faster but no import grouping)",
      "type": "boolean",
      "default": false
    },
    "use_buffer_pooling": {
      "description": "Reuse byte buffers via sync.Pool during code formatting to reduce GC pressure",
      "type": "boolean",
      "default": false
    },
    "call_argument_directives_with_null": {
      "description": "Argument directives decorating a field with a null value will still be called",
      "type": "boolean",
      "default": true
    },
    "use_function_syntax_for_execution_context": {
      "description": "Use function syntax for execution context instead of receiver methods",
      "type": "boolean",
      "default": false
    },
    "subscription_context_field": {
      "description": "Enable subscription context propagation for every subscription field. When enabled, subscription resolvers return (<-chan graphql.Event[T], error) instead of (<-chan T, error), matching the behavior of @subscriptionContext without annotating each field.",
      "type": "boolean",
      "default": false
    },
    "go_build_tags": {
      "description": "Set build tags that will be used to load packages",
      "type": "array",
      "items": { "type": "string" }
    },
    "go_initialisms": {
      "description": "Set to modify the initialisms regarded for Go names",
      "type": "object",
      "properties": {
        "replace_defaults": { "type": "boolean" },
        "initialisms": {
          "type": "array",
          "items": { "type": "string" }
        }
      }
    }
  }
}