feat(website): add docs::warnings macro support and warn about no auth (#24866)

* feat(api): add docs::warnings macro support and warn about no auth on api endpoint

* Fix macro order

* Fix conflict in generated file

* Update src/config/api.rs

Co-authored-by: Pavlos Rontidis <pavlos.rontidis@gmail.com>

* Regenerate docs

---------

Co-authored-by: Pavlos Rontidis <pavlos.rontidis@gmail.com>

Author: thomasqueirozb

scripts/generate-component-docs.rb

@@ -781,6 +781,16 @@ def resolve_schema(root_schema, schema)
     resolved['required'] = is_required_field
   end
 
+  # Resolve any warnings attached to this option.
+  #
+  # Warnings can be specified in Rust via `#[configurable(metadata(docs::warnings = "..."))]`.
+  # Multiple warnings can be specified by repeating the attribute, and they will be emitted as an
+  # array in the CUE output.
+  warnings = get_schema_metadata(schema, 'docs::warnings')
+  if !warnings.nil?
+    resolved['warnings'] = warnings.is_a?(Array) ? warnings : [warnings]
+  end
+
   # Reconcile the resolve schema, which essentially gives us a chance to, once the schema is
   # entirely resolved, check it for logical inconsistencies, fix up anything that we reasonably can,
   # and so on.

src/config/api.rs

@@ -5,6 +5,9 @@ use vector_lib::configurable::configurable_component;
 
 /// API options.
 #[configurable_component]
+#[configurable(metadata(
+    docs::warnings = "The API currently does not support authentication. Only enable it in isolated environments or for debugging. It must not be exposed to untrusted clients."
+))]
 #[derive(Clone, Copy, Debug, Eq, PartialEq)]
 #[serde(default, deny_unknown_fields)]
 pub struct Options {

website/cue/reference/generated/configuration.cue

@@ -46,7 +46,8 @@ generated: configuration: {
 				}
 			}
 			description: "API options."
-			group:       "api"
+			warnings: ["The API currently does not support authentication. Only enable it in isolated environments or for debugging. It must not be exposed to untrusted clients."]
+			group: "api"
 		}
 		enrichment_tables: {
 			type: object: options: "*": {