Skip to content

Commit 9351e7a

Browse files
dsmith3197dsmith3197
committed
update documentation
1 parent 2a2b893 commit 9351e7a

19 files changed

+39
-1
lines changed

‎lib/codecs/src/decoding/format/json.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,16 @@ pub struct JsonDeserializerConfig {
2727
pub json: JsonDeserializerOptions,
2828
}
2929

30-
/// Options for building a `JsonDeserializer`.
30+
/// JSON-specific decoding options.
3131
#[configurable_component]
3232
#[derive(Debug, Clone, PartialEq, Eq, Derivative)]
3333
#[derivative(Default)]
3434
pub struct JsonDeserializerOptions {
3535
/// Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
3636
///
3737
/// When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
38+
///
39+
/// [U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
3840
#[serde(
3941
default = "default_lossy",
4042
skip_serializing_if = "vector_core::serde::skip_serializing_if_default"

‎website/cue/reference/components/sources/base/amqp.cue

+2
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ base: components: sources: amqp: configuration: {
104104
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
105105
106106
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
107+
108+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
107109
"""
108110
required: false
109111
type: bool: default: true

‎website/cue/reference/components/sources/base/aws_kinesis_firehose.cue

+2
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ base: components: sources: aws_kinesis_firehose: configuration: {
107107
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
108108
109109
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
110+
111+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
110112
"""
111113
required: false
112114
type: bool: default: true

‎website/cue/reference/components/sources/base/aws_s3.cue

+2
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,8 @@ base: components: sources: aws_s3: configuration: {
193193
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
194194
195195
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
196+
197+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
196198
"""
197199
required: false
198200
type: bool: default: true

‎website/cue/reference/components/sources/base/aws_sqs.cue

+2
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,8 @@ base: components: sources: aws_sqs: configuration: {
188188
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
189189
190190
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
191+
192+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
191193
"""
192194
required: false
193195
type: bool: default: true

‎website/cue/reference/components/sources/base/datadog_agent.cue

+2
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ base: components: sources: datadog_agent: configuration: {
8989
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
9090
9191
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
92+
93+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
9294
"""
9395
required: false
9496
type: bool: default: true

‎website/cue/reference/components/sources/base/demo_logs.cue

+2
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ base: components: sources: demo_logs: configuration: {
6868
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
6969
7070
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
71+
72+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
7173
"""
7274
required: false
7375
type: bool: default: true

‎website/cue/reference/components/sources/base/exec.cue

+2
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ base: components: sources: exec: configuration: {
6464
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
6565
6666
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
67+
68+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
6769
"""
6870
required: false
6971
type: bool: default: true

‎website/cue/reference/components/sources/base/file_descriptor.cue

+2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ base: components: sources: file_descriptor: configuration: {
5959
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
6060
6161
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
62+
63+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
6264
"""
6365
required: false
6466
type: bool: default: true

‎website/cue/reference/components/sources/base/gcp_pubsub.cue

+2
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,8 @@ base: components: sources: gcp_pubsub: configuration: {
135135
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
136136
137137
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
138+
139+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
138140
"""
139141
required: false
140142
type: bool: default: true

‎website/cue/reference/components/sources/base/heroku_logs.cue

+2
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,8 @@ base: components: sources: heroku_logs: configuration: {
101101
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
102102
103103
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
104+
105+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
104106
"""
105107
required: false
106108
type: bool: default: true

‎website/cue/reference/components/sources/base/http.cue

+2
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ base: components: sources: http: configuration: {
102102
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
103103
104104
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
105+
106+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
105107
"""
106108
required: false
107109
type: bool: default: true

‎website/cue/reference/components/sources/base/http_client.cue

+2
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,8 @@ base: components: sources: http_client: configuration: {
101101
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
102102
103103
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
104+
105+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
104106
"""
105107
required: false
106108
type: bool: default: true

‎website/cue/reference/components/sources/base/http_server.cue

+2
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ base: components: sources: http_server: configuration: {
102102
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
103103
104104
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
105+
106+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
105107
"""
106108
required: false
107109
type: bool: default: true

‎website/cue/reference/components/sources/base/kafka.cue

+2
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,8 @@ base: components: sources: kafka: configuration: {
113113
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
114114
115115
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
116+
117+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
116118
"""
117119
required: false
118120
type: bool: default: true

‎website/cue/reference/components/sources/base/nats.cue

+2
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,8 @@ base: components: sources: nats: configuration: {
156156
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
157157
158158
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
159+
160+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
159161
"""
160162
required: false
161163
type: bool: default: true

‎website/cue/reference/components/sources/base/redis.cue

+2
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ base: components: sources: redis: configuration: {
7474
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
7575
7676
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
77+
78+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
7779
"""
7880
required: false
7981
type: bool: default: true

‎website/cue/reference/components/sources/base/socket.cue

+2
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ base: components: sources: socket: configuration: {
7676
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
7777
7878
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
79+
80+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
7981
"""
8082
required: false
8183
type: bool: default: true

‎website/cue/reference/components/sources/base/stdin.cue

+2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ base: components: sources: stdin: configuration: {
5959
Determines whether or not to replace invalid UTF-8 sequences instead of returning an error.
6060
6161
When true, invalid UTF-8 sequences are replaced with the [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
62+
63+
[U+FFFD]: https://en.wikipedia.org/wiki/Specials_(Unicode_block)#Replacement_character
6264
"""
6365
required: false
6466
type: bool: default: true

0 commit comments

Comments
 (0)