Update docs & mention params (#201)

Update MentionParams to include `autoInclude` which will indicate whether the request is to get the default mentions automatically.
sourcegraph · Sep 5, 2024 · ee7f33e · ee7f33e
1 parent b2f1b82
commit ee7f33e
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/lib/protocol/src/openctx-protocol.schema.json b/lib/protocol/src/openctx-protocol.schema.json
@@ -259,6 +259,10 @@
         "codebase": {
           "description": "Name of the active codebase infered from .git.",
           "type": "string"
+        },
+        "autoInclude": {
+          "description": "Whether the request if to get auto include default context",
+          "type": "boolean"
         }
       }
     },

diff --git a/lib/protocol/src/openctx-protocol.schema.ts b/lib/protocol/src/openctx-protocol.schema.ts
@@ -139,6 +139,10 @@ export interface MentionsParams {
      * Name of the active codebase infered from .git.
      */
     codebase?: string
+    /**
+     * Whether the request if to get auto include default context
+     */
+    autoInclude?: boolean
 }
 export interface ItemsParams {
     /**

diff --git a/web/content/docs/protocol.mdx b/web/content/docs/protocol.mdx
@@ -124,6 +124,18 @@ export interface MentionsParams {
      * A search query that is interpreted by providers to filter the items in the result set.
      */
     query?: string
+    /**
+     * URI of the active document.
+     */
+    uri?: string
+    /**
+     * Name of the active codebase.
+     */
+    codebase?: string
+    /**
+     * Whether the request if to get automatically include default context.
+     */
+    autoInclude?: string
 }
 ```