@redpanda-data/docs-extensions-and-macros

{ "$comment": "Overrides file for Redpanda property extraction. Supports two top-level keys: 'properties' for property overrides (descriptions, examples, etc.) and 'definitions' for type definition overrides (structs, enums with user-friendly names, etc.). Override definitions take precedence over dynamically extracted ones.", "definitions": { "client_group_quota": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/client_group_byte_rate_quota.h#L29", "type": "object", "properties": { "group_name": { "type": "string" }, "clients_prefix": { "type": "string" }, "quota": { "type": "integer", "minimum": -9223372036854775808, "maximum": 9223372036854775807 } } }, "config::broker_authn_endpoint": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/broker_authn_endpoint.h#L42", "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "port": { "type": "integer", "minimum": 0, "maximum": 4294967295 } } }, "config::endpoint_tls_config": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/endpoint_tls_config.h#L21", "type": "object", "properties": { "name": { "type": "string" }, "config": { "$ref": "#/definitions/config::tls_config" } } }, "config::tls_config": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/tls_config.h#L49", "type": "object", "properties": { "enabled": { "type": "boolean" }, "require_client_auth": { "type": "boolean" }, "key_file": { "type": "string" }, "cert_file": { "type": "string" }, "truststore_file": { "type": "string" } } }, "tls_config": { "$ref": "#/definitions/config::tls_config" }, "config::rest_authn_endpoint": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/rest_authn_endpoint.h#L42", "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "port": { "type": "integer", "minimum": 0, "maximum": 4294967295 }, "authentication_method": { "$ref": "#/definitions/config::rest_authn_method" } } }, "config::rest_authn_method": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/rest_authn_endpoint.h#L31", "enum": [ "none", "http_basic" ] }, "endpoint_tls_config": { "$ref": "#/definitions/config::endpoint_tls_config" }, "model::broker_endpoint": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L88", "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "port": { "type": "integer", "minimum": 0, "maximum": 4294967295 } } }, "model::cleanup_policy_bitflags": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/fundamental.h#L72", "enum": [ "none", "delete", "compact" ] }, "model::cloud_credentials_source": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L454", "enum": [ "config_file", "aws_instance_metadata", "sts", "gcp_instance_metadata" ] }, "model::cloud_storage_backend": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L481", "enum": [ "aws", "google_s3_compat", "azure", "minio", "unknown" ] }, "model::cloud_storage_chunk_eviction_strategy": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L524", "enum": [ "eager", "capped", "predictive" ] }, "model::compression": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/compression.h#L36", "enum": [ "none", "gzip", "snappy", "lz4", "zstd", "producer" ] }, "model::leader_balancer_mode": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L504", "enum": [ "greedy_balanced_shards", "random_hill_climbing" ] }, "model::node_id": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L36", "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "model::partition_autobalancing_mode": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L463", "enum": [ "off", "node_add", "continuous" ] }, "model::rack_id": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/metadata.h#L60", "type": "string" }, "model::timestamp_type": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/model/timestamp.h#L30", "enum": [ "create_time", "append_time" ] }, "net::unresolved_address": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/net/unresolved_address.h#L27", "properties": { "address": { "type": "string" }, "port": { "type": "integer", "minimum": 0, "maximum": 4294967295 } } }, "pandaproxy::schema_registry::schema_id_validation_mode": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/pandaproxy/schema_registry/schema_id_validation.h#L22", "enum": [ "none", "redpanda", "compat" ] }, "retention_duration_property": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/property.h#L878", "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }, "seed_server": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/seed_server.h#L24", "type": "object", "properties": { "host": { "$ref": "#/definitions/net::unresolved_address" } } }, "throughput_control_group": { "defined_in": "https://github.com/redpanda-data/redpanda/blob/dev/src/v/config/throughput_control_group.h#L36", "type": "object", "properties": { "name": { "type": "string" }, "client_id": { "type": "string" } } } } }