From e6f6b351b73757b215664d7bde24a0181af6f3aa Mon Sep 17 00:00:00 2001 From: Bennet Bo Fenner Date: Fri, 2 May 2025 17:37:05 +0200 Subject: [PATCH] extension_api: Add documentation to context server configuration (#29800) Release Notes: - N/A --- crates/extension/src/types/context_server.rs | 10 +++++----- .../extension_api/wit/since_v0.5.0/context-server.wit | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/crates/extension/src/types/context_server.rs b/crates/extension/src/types/context_server.rs index e0bac5b0d9..2e3d20b047 100644 --- a/crates/extension/src/types/context_server.rs +++ b/crates/extension/src/types/context_server.rs @@ -1,10 +1,10 @@ -/// Configuration for a context server. +/// Configuration for context server setup and installation. #[derive(Debug, Clone)] pub struct ContextServerConfiguration { - /// Installation instructions for the user. + /// Installation instructions in Markdown format. pub installation_instructions: String, - /// Default settings for the context server. - pub default_settings: String, - /// JSON schema describing server settings. + /// JSON schema for settings validation. pub settings_schema: serde_json::Value, + /// Default settings template. + pub default_settings: String, } diff --git a/crates/extension_api/wit/since_v0.5.0/context-server.wit b/crates/extension_api/wit/since_v0.5.0/context-server.wit index 89dc99c85b..7234e0e6d0 100644 --- a/crates/extension_api/wit/since_v0.5.0/context-server.wit +++ b/crates/extension_api/wit/since_v0.5.0/context-server.wit @@ -1,11 +1,11 @@ interface context-server { - /// + /// Configuration for context server setup and installation. record context-server-configuration { - /// + /// Installation instructions in Markdown format. installation-instructions: string, - /// + /// JSON schema for settings validation. settings-schema: string, - /// + /// Default settings template. default-settings: string, } }