From 5880029ffc0146c82e1a19e425f08a623a731f9d Mon Sep 17 00:00:00 2001 From: Chris Arnott Date: Mon, 5 Aug 2024 11:51:37 +0100 Subject: [PATCH] Update docs --- src/sources/http_server.rs | 3 +++ .../cue/reference/components/sources/base/http.cue | 14 ++++++++++++++ .../components/sources/base/http_server.cue | 14 ++++++++++++++ 3 files changed, 31 insertions(+) diff --git a/src/sources/http_server.rs b/src/sources/http_server.rs index 1d647fd069eca4..9972c056f86690 100644 --- a/src/sources/http_server.rs +++ b/src/sources/http_server.rs @@ -102,6 +102,9 @@ pub struct SimpleHttpConfig { /// Custom response headers to be added to the HTTP response #[serde(default)] #[configurable(metadata(docs::examples = "example_custom_response_headers()"))] + #[configurable(metadata( + docs::additional_props_description = "A custom response header key-value pair" + ))] custom_response_headers: HashMap, /// A list of URL query parameters to include in the log event. diff --git a/website/cue/reference/components/sources/base/http.cue b/website/cue/reference/components/sources/base/http.cue index 73ae0efbe4ac76..2b7e6c9fb118d6 100644 --- a/website/cue/reference/components/sources/base/http.cue +++ b/website/cue/reference/components/sources/base/http.cue @@ -47,6 +47,20 @@ base: components: sources: http: configuration: { } } } + custom_response_headers: { + description: "Custom response headers to be added to the HTTP response" + required: false + type: object: { + examples: [{ + "Access-Control-Allow-Origin": "my-cool-server" + }] + options: "*": { + description: "A custom response header key-value pair" + required: true + type: string: {} + } + } + } decoding: { description: "Configures how events are decoded from raw bytes." required: false diff --git a/website/cue/reference/components/sources/base/http_server.cue b/website/cue/reference/components/sources/base/http_server.cue index 3837266a941993..69a58674003cad 100644 --- a/website/cue/reference/components/sources/base/http_server.cue +++ b/website/cue/reference/components/sources/base/http_server.cue @@ -47,6 +47,20 @@ base: components: sources: http_server: configuration: { } } } + custom_response_headers: { + description: "Custom response headers to be added to the HTTP response" + required: false + type: object: { + examples: [{ + "Access-Control-Allow-Origin": "my-cool-server" + }] + options: "*": { + description: "A custom response header key-value pair" + required: true + type: string: {} + } + } + } decoding: { description: "Configures how events are decoded from raw bytes." required: false