chore(aws_s3 sink): Update metadata to match the editorial review for…

… the schema. (vectordotdev#17475)

<!--
**Your PR title must conform to the conventional commit spec!**

  <type>(<scope>)!: <description>

  * `type` = chore, enhancement, feat, fix, docs
  * `!` = OPTIONAL: signals a breaking change
* `scope` = Optional when `type` is "chore" or "docs", available scopes
https://github.com/vectordotdev/vector/blob/master/.github/semantic.yml#L20
  * `description` = short description of the change

Examples:

  * enhancement(file source): Add `sort` option to sort discovered files
  * feat(new source): Initial `statsd` source
  * fix(file source): Fix a bug discovering new files
  * chore(external docs): Clarify `batch_size` option
-->

lib/codecs/src/encoding/format/avro.rs

@@ -47,6 +47,7 @@ pub struct AvroSerializerOptions {
     #[configurable(metadata(
         docs::examples = r#"{ "type": "record", "name": "log", "fields": [{ "name": "message", "type": "string" }] }"#
     ))]
+    #[configurable(metadata(docs::human_name = "Schema JSON"))]
     pub schema: String,
 }
 

lib/vector-config-common/src/human_friendly.rs

@@ -48,7 +48,7 @@ static WELL_KNOWN_ACRONYMS: Lazy<HashSet<String>> = Lazy::new(|| {
         "api", "amqp", "aws", "ec2", "ecs", "gcp", "hec", "http", "https", "nats", "nginx", "s3",
         "sqs", "tls", "ssl", "otel", "gelf", "csv", "json", "rfc3339", "lz4", "us", "eu", "bsd",
         "vrl", "tcp", "udp", "id", "uuid", "kms", "uri", "url", "acp", "uid", "ip", "pid",
-        "ndjson", "ewma", "rtt", "cpu", "acl",
+        "ndjson", "ewma", "rtt", "cpu", "acl", "imds", "acl", "alpn",
     ];
 
     acronyms.iter().map(|s| s.to_lowercase()).collect()

lib/vector-core/src/tls/settings.rs

@@ -119,6 +119,7 @@ pub struct TlsConfig {
     /// The certificate must be in the DER or PEM (X.509) format. Additionally, the certificate can be provided as an inline string in PEM format.
     #[serde(alias = "ca_path")]
     #[configurable(metadata(docs::examples = "/path/to/certificate_authority.crt"))]
+    #[configurable(metadata(docs::human_name = "CA File Path"))]
     pub ca_file: Option<PathBuf>,
 
     /// Absolute path to a certificate file used to identify this server.
@@ -129,20 +130,23 @@ pub struct TlsConfig {
     /// If this is set, and is not a PKCS#12 archive, `key_file` must also be set.
     #[serde(alias = "crt_path")]
     #[configurable(metadata(docs::examples = "/path/to/host_certificate.crt"))]
+    #[configurable(metadata(docs::human_name = "Certificate File Path"))]
     pub crt_file: Option<PathBuf>,
 
     /// Absolute path to a private key file used to identify this server.
     ///
     /// The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.
     #[serde(alias = "key_path")]
     #[configurable(metadata(docs::examples = "/path/to/host_certificate.key"))]
+    #[configurable(metadata(docs::human_name = "Key File Path"))]
     pub key_file: Option<PathBuf>,
 
     /// Passphrase used to unlock the encrypted key file.
     ///
     /// This has no effect unless `key_file` is set.
     #[configurable(metadata(docs::examples = "${KEY_PASS_ENV_VAR}"))]
     #[configurable(metadata(docs::examples = "PassWord1"))]
+    #[configurable(metadata(docs::human_name = "Key File Password"))]
     pub key_pass: Option<String>,
 }
 

src/aws/auth.rs

@@ -117,6 +117,7 @@ pub enum AwsAuthentication {
         /// Relevant when the default credentials chain or `assume_role` is used.
         #[configurable(metadata(docs::type_unit = "seconds"))]
         #[configurable(metadata(docs::examples = 30))]
+        #[configurable(metadata(docs::human_name = "Load Timeout"))]
         load_timeout_secs: Option<u64>,
 
         /// Configuration for authenticating with AWS through IMDS.
@@ -141,6 +142,7 @@ pub enum AwsAuthentication {
         /// Relevant when the default credentials chain or `assume_role` is used.
         #[configurable(metadata(docs::type_unit = "seconds"))]
         #[configurable(metadata(docs::examples = 30))]
+        #[configurable(metadata(docs::human_name = "Load Timeout"))]
         load_timeout_secs: Option<u64>,
 
         /// Configuration for authenticating with AWS through IMDS.

src/sinks/aws_s3/config.rs

@@ -83,6 +83,7 @@ pub struct S3SinkConfig {
     /// This ensures there are no name collisions, and can be useful in high-volume workloads where
     /// object keys must be unique.
     #[serde(default = "crate::serde::default_true")]
+    #[configurable(metadata(docs::human_name = "Append UUID to Filename"))]
     pub filename_append_uuid: bool,
 
     /// The filename extension to use in the object key.