Fix Documentation for various languages in Discover (opensearch-proje…

…ct#8636) * Fix Documentation for various languages in Discover Signed-off-by: Suchit Sahoo <[email protected]> * Update Snapshots Signed-off-by: Suchit Sahoo <[email protected]> * Update the Lucene Language Reference Signed-off-by: Suchit Sahoo <[email protected]> --------- Signed-off-by: Suchit Sahoo <[email protected]>
CPTNB · Oct 18, 2024 · e5b7067 · e5b7067
1 parent 84f925b
commit e5b7067
Show file tree

Hide file tree

Showing 46 changed files with 413 additions and 3,448 deletions.
diff --git a/src/core/public/doc_links/doc_links_service.ts b/src/core/public/doc_links/doc_links_service.ts
@@ -620,6 +620,18 @@ export class DocLinksService {
             // https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/
             veirfyRepository: `${OPENSEARCH_WEBSITE_DOCS}/api-reference/snapshots/verify-snapshot-repository/`,
           },
+          lucene: {
+            // https://opensearch.org/docs/latest/query-dsl/full-text/query-string/
+            base: `${OPENSEARCH_WEBSITE_DOCS}/query-dsl/full-text/query-string/`,
+          },
+          ppl: {
+            // https://opensearch.org/docs/latest/search-plugins/sql/ppl/syntax/
+            base: `${OPENSEARCH_WEBSITE_DOCS}/search-plugins/sql/ppl/syntax/`,
+          },
+          sql: {
+            // https://opensearch.org/docs/latest/search-plugins/sql/sql/basic/
+            base: `${OPENSEARCH_WEBSITE_DOCS}/search-plugins/sql/sql/basic/`,
+          },
         },
       },
     });
@@ -962,6 +974,15 @@ export interface DocLinksStart {
         readonly cleanup: string;
         readonly veirfyRepository: string;
       };
+      readonly lucene: {
+        readonly base: string;
+      };
+      readonly sql: {
+        readonly base: string;
+      };
+      readonly ppl: {
+        readonly base: string;
+      };
     };
   };
 }
diff --git a/...ins/advanced_settings/public/management_app/__snapshots__/advanced_settings.test.tsx.snap b/...ins/advanced_settings/public/management_app/__snapshots__/advanced_settings.test.tsx.snap
diff --git a/...ic/application/components/dashboard_top_nav/__snapshots__/dashboard_top_nav.test.tsx.snap b/...ic/application/components/dashboard_top_nav/__snapshots__/dashboard_top_nav.test.tsx.snap
diff --git a/src/plugins/data/public/index.ts b/src/plugins/data/public/index.ts
@@ -493,6 +493,7 @@ export {
   QueryStateChange,
   QueryStart,
   PersistedLog,
+  LanguageReference,
 } from './query';
 
 export { AggsStart } from './search/aggs';

diff --git a/src/plugins/data/public/query/query_string/index.ts b/src/plugins/data/public/query/query_string/index.ts
@@ -44,4 +44,5 @@ export {
   QueryControls,
   QueryResult,
   QueryStatus,
+  LanguageReference,
 } from './language_service';
diff --git a/src/plugins/data/public/query/query_string/language_service/index.ts b/src/plugins/data/public/query/query_string/language_service/index.ts
@@ -5,4 +5,10 @@
 
 export * from './types';
 export { LanguageServiceContract, LanguageService } from './language_service';
-export { RecentQueriesTable, QueryControls, QueryResult, QueryStatus } from './lib';
+export {
+  RecentQueriesTable,
+  QueryControls,
+  QueryResult,
+  QueryStatus,
+  LanguageReference,
+} from './lib';
diff --git a/src/plugins/data/public/query/query_string/language_service/language_service.ts b/src/plugins/data/public/query/query_string/language_service/language_service.ts
@@ -14,7 +14,8 @@ import {
   UiEnhancements,
 } from '../../../ui';
 import { DataStorage, setOverrides as setFieldOverrides } from '../../../../common';
-import { createDefaultLanguageReference } from './lib/default_language_reference';
+import { dqlLanguageReference } from './lib/dql_language_reference';
+import { luceneLanguageReference } from './lib/lucene_language_reference';
 
 export class LanguageService {
   private languages: Map<string, LanguageConfig> = new Map();
@@ -35,22 +36,22 @@ export class LanguageService {
     }
   };
 
-  public createDefaultLanguageReference = () => {
-    return createDefaultLanguageReference();
-  };
-
   /**
    * Registers default handlers for index patterns and indices.
    */
   private registerDefaultLanguages() {
-    const defaultEditor = createEditor(
-      SingleLineInput,
-      SingleLineInput,
-      [this.createDefaultLanguageReference()],
-      DQLBody
+    this.registerLanguage(
+      getDQLLanguageConfig(
+        this.defaultSearchInterceptor,
+        createEditor(SingleLineInput, SingleLineInput, [dqlLanguageReference()], DQLBody)
+      )
+    );
+    this.registerLanguage(
+      getLuceneLanguageConfig(
+        this.defaultSearchInterceptor,
+        createEditor(SingleLineInput, SingleLineInput, [luceneLanguageReference()], DQLBody)
+      )
     );
-    this.registerLanguage(getDQLLanguageConfig(this.defaultSearchInterceptor, defaultEditor));
-    this.registerLanguage(getLuceneLanguageConfig(this.defaultSearchInterceptor, defaultEditor));
   }
 
   public registerLanguage(config: LanguageConfig): void {

diff --git a/...lugins/data/public/query/query_string/language_service/lib/default_language_reference.tsx b/...lugins/data/public/query/query_string/language_service/lib/default_language_reference.tsx