extension_api: Add documentation to context server configuration (#29800)

Bennet Bo Fenner created 7 months ago

Release Notes:

- N/A

Change summary

crates/extension/src/types/context_server.rs             | 10 +++++-----
crates/extension_api/wit/since_v0.5.0/context-server.wit |  8 ++++----
2 files changed, 9 insertions(+), 9 deletions(-)

Detailed changes

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,
 }

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,
     }
 }