diff --git a/changelog.d/18669_csv_documentation_u8_display.fix.md b/changelog.d/18669_csv_documentation_u8_display.fix.md new file mode 100644 index 00000000000000..2db44f8ee75f13 --- /dev/null +++ b/changelog.d/18669_csv_documentation_u8_display.fix.md @@ -0,0 +1,4 @@ +Fixing the representation of the ascii character configuration in the csv encoder documentation so +that they are shown as human readable characters contrary to integers. + +author scMarkus diff --git a/lib/codecs/src/encoding/format/csv.rs b/lib/codecs/src/encoding/format/csv.rs index dee3c32c236666..9456184988f212 100644 --- a/lib/codecs/src/encoding/format/csv.rs +++ b/lib/codecs/src/encoding/format/csv.rs @@ -75,6 +75,7 @@ impl CsvSerializerConfig { #[derive(Debug, Clone)] pub struct CsvSerializerOptions { /// The field delimiter to use when writing CSV. + #[configurable(metadata(docs::type_override = "ascii_char"))] #[serde( default = "default_delimiter", with = "vector_core::serde::ascii_char", @@ -98,6 +99,7 @@ pub struct CsvSerializerOptions { /// like \ (instead of escaping quotes by doubling them). /// /// To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. + #[configurable(metadata(docs::type_override = "ascii_char"))] #[serde( default = "default_escape", with = "vector_core::serde::ascii_char", @@ -106,6 +108,7 @@ pub struct CsvSerializerOptions { pub escape: u8, /// The quote character to use when writing CSV. + #[configurable(metadata(docs::type_override = "ascii_char"))] #[serde( default = "default_escape", with = "vector_core::serde::ascii_char", diff --git a/scripts/generate-component-docs.rb b/scripts/generate-component-docs.rb index b6aa51ce2503f7..8f55d3e048a50a 100755 --- a/scripts/generate-component-docs.rb +++ b/scripts/generate-component-docs.rb @@ -744,9 +744,19 @@ def resolve_schema(root_schema, schema) # # We intentially set no actual definition for these types, relying on the documentation generation # process to provide the actual details. We only need to specify the custom type name. + # + # To handle u8 types as ascii characters and not there uint representation between 0 and 255 we + # added a special handling of these exact values. This means + # `#[configurable(metadata(docs::type_override = "ascii_char"))]` should only be used consciously + # for rust u8 type. See lib/codecs/src/encoding/format/csv.rs for an example and + # https://github.com/vectordotdev/vector/pull/20498 type_override = get_schema_metadata(schema, 'docs::type_override') if !type_override.nil? - resolved = { 'type' => { type_override.to_s => {} } } + if type_override == 'ascii_char' + resolved = { 'type' => { type_override.to_s => { 'default' => schema['default'].chr } } } + else + resolved = { 'type' => { type_override.to_s => {} } } + end description = get_rendered_description_from_schema(schema) resolved['description'] = description unless description.empty? return resolved diff --git a/website/cue/reference/components/sinks/base/amqp.cue b/website/cue/reference/components/sinks/base/amqp.cue index f6636096e5875a..686b1030813cec 100644 --- a/website/cue/reference/components/sinks/base/amqp.cue +++ b/website/cue/reference/components/sinks/base/amqp.cue @@ -157,7 +157,7 @@ base: components: sinks: amqp: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -179,7 +179,7 @@ base: components: sinks: amqp: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -197,7 +197,7 @@ base: components: sinks: amqp: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue b/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue index 214248b03ba3b2..6f1ec464d2512e 100644 --- a/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue +++ b/website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue @@ -333,7 +333,7 @@ base: components: sinks: aws_cloudwatch_logs: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -355,7 +355,7 @@ base: components: sinks: aws_cloudwatch_logs: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -373,7 +373,7 @@ base: components: sinks: aws_cloudwatch_logs: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue b/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue index d752b12153a25b..6bef2e4c59b271 100644 --- a/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue +++ b/website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue @@ -312,7 +312,7 @@ base: components: sinks: aws_kinesis_firehose: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -334,7 +334,7 @@ base: components: sinks: aws_kinesis_firehose: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -352,7 +352,7 @@ base: components: sinks: aws_kinesis_firehose: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue b/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue index a683d120eb3be7..62fe07bb143321 100644 --- a/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue +++ b/website/cue/reference/components/sinks/base/aws_kinesis_streams.cue @@ -312,7 +312,7 @@ base: components: sinks: aws_kinesis_streams: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -334,7 +334,7 @@ base: components: sinks: aws_kinesis_streams: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -352,7 +352,7 @@ base: components: sinks: aws_kinesis_streams: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/aws_s3.cue b/website/cue/reference/components/sinks/base/aws_s3.cue index e04ba5e1c04517..036208ce631782 100644 --- a/website/cue/reference/components/sinks/base/aws_s3.cue +++ b/website/cue/reference/components/sinks/base/aws_s3.cue @@ -421,7 +421,7 @@ base: components: sinks: aws_s3: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -443,7 +443,7 @@ base: components: sinks: aws_s3: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -461,7 +461,7 @@ base: components: sinks: aws_s3: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/aws_sns.cue b/website/cue/reference/components/sinks/base/aws_sns.cue index c4798bbe1e2cbd..027ee098a6ced6 100644 --- a/website/cue/reference/components/sinks/base/aws_sns.cue +++ b/website/cue/reference/components/sinks/base/aws_sns.cue @@ -243,7 +243,7 @@ base: components: sinks: aws_sns: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -265,7 +265,7 @@ base: components: sinks: aws_sns: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -283,7 +283,7 @@ base: components: sinks: aws_sns: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/aws_sqs.cue b/website/cue/reference/components/sinks/base/aws_sqs.cue index 88440bd4959156..5db5ebb6126ca7 100644 --- a/website/cue/reference/components/sinks/base/aws_sqs.cue +++ b/website/cue/reference/components/sinks/base/aws_sqs.cue @@ -243,7 +243,7 @@ base: components: sinks: aws_sqs: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -265,7 +265,7 @@ base: components: sinks: aws_sqs: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -283,7 +283,7 @@ base: components: sinks: aws_sqs: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/azure_blob.cue b/website/cue/reference/components/sinks/base/azure_blob.cue index bc0afd1f92535b..df71c8bc78928c 100644 --- a/website/cue/reference/components/sinks/base/azure_blob.cue +++ b/website/cue/reference/components/sinks/base/azure_blob.cue @@ -275,7 +275,7 @@ base: components: sinks: azure_blob: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -297,7 +297,7 @@ base: components: sinks: azure_blob: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -315,7 +315,7 @@ base: components: sinks: azure_blob: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/console.cue b/website/cue/reference/components/sinks/base/console.cue index 1082c6a2a85eb3..752324554eee2b 100644 --- a/website/cue/reference/components/sinks/base/console.cue +++ b/website/cue/reference/components/sinks/base/console.cue @@ -141,7 +141,7 @@ base: components: sinks: console: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -163,7 +163,7 @@ base: components: sinks: console: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -181,7 +181,7 @@ base: components: sinks: console: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/databend.cue b/website/cue/reference/components/sinks/base/databend.cue index 97611c0f759150..3f0b220bfff148 100644 --- a/website/cue/reference/components/sinks/base/databend.cue +++ b/website/cue/reference/components/sinks/base/databend.cue @@ -160,7 +160,7 @@ base: components: sinks: databend: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -182,7 +182,7 @@ base: components: sinks: databend: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -200,7 +200,7 @@ base: components: sinks: databend: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/file.cue b/website/cue/reference/components/sinks/base/file.cue index eb83f9673e973c..ce23bf893b7aa1 100644 --- a/website/cue/reference/components/sinks/base/file.cue +++ b/website/cue/reference/components/sinks/base/file.cue @@ -161,7 +161,7 @@ base: components: sinks: file: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -183,7 +183,7 @@ base: components: sinks: file: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -201,7 +201,7 @@ base: components: sinks: file: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue b/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue index 4089702f320050..ba4a40bb4700af 100644 --- a/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue +++ b/website/cue/reference/components/sinks/base/gcp_chronicle_unstructured.cue @@ -210,7 +210,7 @@ base: components: sinks: gcp_chronicle_unstructured: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -232,7 +232,7 @@ base: components: sinks: gcp_chronicle_unstructured: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -250,7 +250,7 @@ base: components: sinks: gcp_chronicle_unstructured: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue b/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue index 22b86cfe60cae4..7c625f2b6ec5a6 100644 --- a/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue +++ b/website/cue/reference/components/sinks/base/gcp_cloud_storage.cue @@ -299,7 +299,7 @@ base: components: sinks: gcp_cloud_storage: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -321,7 +321,7 @@ base: components: sinks: gcp_cloud_storage: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -339,7 +339,7 @@ base: components: sinks: gcp_cloud_storage: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/gcp_pubsub.cue b/website/cue/reference/components/sinks/base/gcp_pubsub.cue index f132ee545598bd..de74393ea1431d 100644 --- a/website/cue/reference/components/sinks/base/gcp_pubsub.cue +++ b/website/cue/reference/components/sinks/base/gcp_pubsub.cue @@ -208,7 +208,7 @@ base: components: sinks: gcp_pubsub: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -230,7 +230,7 @@ base: components: sinks: gcp_pubsub: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -248,7 +248,7 @@ base: components: sinks: gcp_pubsub: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/http.cue b/website/cue/reference/components/sinks/base/http.cue index c28aa0a594e431..d23cf2717d35bc 100644 --- a/website/cue/reference/components/sinks/base/http.cue +++ b/website/cue/reference/components/sinks/base/http.cue @@ -254,7 +254,7 @@ base: components: sinks: http: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -276,7 +276,7 @@ base: components: sinks: http: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -294,7 +294,7 @@ base: components: sinks: http: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/humio_logs.cue b/website/cue/reference/components/sinks/base/humio_logs.cue index 5eb9352aa509e9..6f87b112d274be 100644 --- a/website/cue/reference/components/sinks/base/humio_logs.cue +++ b/website/cue/reference/components/sinks/base/humio_logs.cue @@ -207,7 +207,7 @@ base: components: sinks: humio_logs: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -229,7 +229,7 @@ base: components: sinks: humio_logs: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -247,7 +247,7 @@ base: components: sinks: humio_logs: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/kafka.cue b/website/cue/reference/components/sinks/base/kafka.cue index fda5542d4a3b13..a51da3672da225 100644 --- a/website/cue/reference/components/sinks/base/kafka.cue +++ b/website/cue/reference/components/sinks/base/kafka.cue @@ -196,7 +196,7 @@ base: components: sinks: kafka: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -218,7 +218,7 @@ base: components: sinks: kafka: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -236,7 +236,7 @@ base: components: sinks: kafka: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/loki.cue b/website/cue/reference/components/sinks/base/loki.cue index 6e406f81da836c..d3457fe0b0fe58 100644 --- a/website/cue/reference/components/sinks/base/loki.cue +++ b/website/cue/reference/components/sinks/base/loki.cue @@ -256,7 +256,7 @@ base: components: sinks: loki: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -278,7 +278,7 @@ base: components: sinks: loki: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -296,7 +296,7 @@ base: components: sinks: loki: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/mqtt.cue b/website/cue/reference/components/sinks/base/mqtt.cue index 74c7cebc160c25..7a06e32c4f3206 100644 --- a/website/cue/reference/components/sinks/base/mqtt.cue +++ b/website/cue/reference/components/sinks/base/mqtt.cue @@ -151,7 +151,7 @@ base: components: sinks: mqtt: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -173,7 +173,7 @@ base: components: sinks: mqtt: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -191,7 +191,7 @@ base: components: sinks: mqtt: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/nats.cue b/website/cue/reference/components/sinks/base/nats.cue index 175089fdf93240..48aa9285a1a239 100644 --- a/website/cue/reference/components/sinks/base/nats.cue +++ b/website/cue/reference/components/sinks/base/nats.cue @@ -241,7 +241,7 @@ base: components: sinks: nats: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -263,7 +263,7 @@ base: components: sinks: nats: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -281,7 +281,7 @@ base: components: sinks: nats: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/papertrail.cue b/website/cue/reference/components/sinks/base/papertrail.cue index b3131ca8f635db..1917a8bfb9b3f4 100644 --- a/website/cue/reference/components/sinks/base/papertrail.cue +++ b/website/cue/reference/components/sinks/base/papertrail.cue @@ -141,7 +141,7 @@ base: components: sinks: papertrail: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -163,7 +163,7 @@ base: components: sinks: papertrail: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -181,7 +181,7 @@ base: components: sinks: papertrail: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/pulsar.cue b/website/cue/reference/components/sinks/base/pulsar.cue index 9dc1adfe7e212e..d0ef9666ca8149 100644 --- a/website/cue/reference/components/sinks/base/pulsar.cue +++ b/website/cue/reference/components/sinks/base/pulsar.cue @@ -235,7 +235,7 @@ base: components: sinks: pulsar: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -257,7 +257,7 @@ base: components: sinks: pulsar: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -275,7 +275,7 @@ base: components: sinks: pulsar: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/redis.cue b/website/cue/reference/components/sinks/base/redis.cue index 7b82723ab71c7a..d4eade0b63ef34 100644 --- a/website/cue/reference/components/sinks/base/redis.cue +++ b/website/cue/reference/components/sinks/base/redis.cue @@ -194,7 +194,7 @@ base: components: sinks: redis: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -216,7 +216,7 @@ base: components: sinks: redis: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -234,7 +234,7 @@ base: components: sinks: redis: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/socket.cue b/website/cue/reference/components/sinks/base/socket.cue index 0e0f0f604a293a..36ac1a25fff484 100644 --- a/website/cue/reference/components/sinks/base/socket.cue +++ b/website/cue/reference/components/sinks/base/socket.cue @@ -153,7 +153,7 @@ base: components: sinks: socket: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -175,7 +175,7 @@ base: components: sinks: socket: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -193,7 +193,7 @@ base: components: sinks: socket: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/splunk_hec_logs.cue b/website/cue/reference/components/sinks/base/splunk_hec_logs.cue index c0f238141d0840..d769849bd14288 100644 --- a/website/cue/reference/components/sinks/base/splunk_hec_logs.cue +++ b/website/cue/reference/components/sinks/base/splunk_hec_logs.cue @@ -257,7 +257,7 @@ base: components: sinks: splunk_hec_logs: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -279,7 +279,7 @@ base: components: sinks: splunk_hec_logs: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -297,7 +297,7 @@ base: components: sinks: splunk_hec_logs: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/webhdfs.cue b/website/cue/reference/components/sinks/base/webhdfs.cue index 75e2fcd19005f1..94d3c2c34ac202 100644 --- a/website/cue/reference/components/sinks/base/webhdfs.cue +++ b/website/cue/reference/components/sinks/base/webhdfs.cue @@ -207,7 +207,7 @@ base: components: sinks: webhdfs: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -229,7 +229,7 @@ base: components: sinks: webhdfs: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -247,7 +247,7 @@ base: components: sinks: webhdfs: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data." diff --git a/website/cue/reference/components/sinks/base/websocket.cue b/website/cue/reference/components/sinks/base/websocket.cue index 13a9dd8eeadeee..eff3c2af449344 100644 --- a/website/cue/reference/components/sinks/base/websocket.cue +++ b/website/cue/reference/components/sinks/base/websocket.cue @@ -188,7 +188,7 @@ base: components: sinks: websocket: configuration: { delimiter: { description: "The field delimiter to use when writing CSV." required: false - type: uint: default: 44 + type: ascii_char: default: "," } double_quote: { description: """ @@ -210,7 +210,7 @@ base: components: sinks: websocket: configuration: { To use this, `double_quotes` needs to be disabled as well otherwise it is ignored. """ required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } fields: { description: """ @@ -228,7 +228,7 @@ base: components: sinks: websocket: configuration: { quote: { description: "The quote character to use when writing CSV." required: false - type: uint: default: 34 + type: ascii_char: default: "\"" } quote_style: { description: "The quoting style to use when writing CSV data."