latest--ogen.jsonschema

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/ogen/_shared/latest--ogen.jsonschema.json
Parent schema ogen
Type: object

JSON Schema for ogen code generator configuration. See https://ogen.dev/docs/config.

Properties

parser object

Parser configuration options.

6 nested properties
infer_types boolean

Enables type inference for schemas. Schema parser will try to detect schema type by its properties.

Default: false
allow_remote boolean

Enables remote references resolving. See https://github.com/ogen-go/ogen/issues/385.

Default: false
depth_limit integer

Maximum depth of schema generation.

Default: 1000
min=1
authentication_schemes string[]

Allowed HTTP Authorization schemes in a Security Scheme Object. If empty, the ones registered in https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml are used.

Default:
[
  "basic",
  "bearer",
  "concealed",
  "digest",
  "dpop",
  "gnap",
  "hoba",
  "mutual",
  "negotiate",
  "oauth",
  "privatetoken",
  "scram-sha-1",
  "scram-sha-256",
  "vapid"
]
allow_cross_type_constraints boolean

Enables interpretation of cross-type schema constraints. When enabled, constraints like pattern on numbers or maximum on strings are allowed and interpreted during code generation.

Default: true
disallow_duplicate_method_paths boolean

Enables strict duplicate normalized path checks. When enabled, duplicate normalized paths are always rejected per strict OpenAPI interpretation. Otherwise, paths with different parameter names and different HTTP methods are allowed, and operations are disambiguated by path + params + method.

Default: false
generator object

Generator configuration options.

6 nested properties
features object

Generator features configuration.

3 nested properties
enable string[]

Features to enable. Applied after disable list, so entries here take priority.

Default:
[
  "paths/client",
  "paths/server",
  "webhooks/client",
  "webhooks/server",
  "ogen/otel",
  "ogen/unimplemented"
]
disable string[]

Features to disable. Applied before enable list, so entries in enable list take priority.

Default:
[]
disable_all boolean

Start from an empty feature set instead of default features before applying disable and enable lists.

Default: false
filters object

Operation filtering configuration options.

2 nested properties
path_regex string

Regular expression to filter paths. If empty, all paths are accepted.

Default: ""
methods string[]

HTTP methods to keep. If empty, all methods are accepted.

Default:
[]
ignore_not_implemented string[]

Functions that are not yet implemented and should be skipped during generation. "all" is a special list value that skips all not-implemented functions.

Default:
[]
convenient_errors string

Controls convenient error helper generation. See https://ogen.dev/docs/concepts/convenient_errors.

Default: "auto"
Values: "on" "off" "auto"
content_type_aliases Record<string, string>

Maps exact content types to known encodings.

Default:
{}
wildcard_content_type_default string

Default encoding to use for wildcard content types (e.g. / or application/*) when the schema is not binary. If empty, wildcard content types are treated as unsupported.

Default: ""
expand string

Path to write the expanded OpenAPI spec file. If empty, the expanded spec is not written.

Default: ""