[DOCS] Adds description to the Search Application APIs. (#2266)

Author: szabosteve

output/schema/schema.json

@@ -21,7 +21,7 @@ import { IndexName, Name } from '@_types/common'
 
 export class AnalyticsCollection {
   /**
-   * Data stream for the collection
+   * Data stream for the collection.
    */
   event_data_stream: EventDataStream
 }

specification/search_application/_types/BehavioralAnalytics.ts

@@ -23,27 +23,30 @@ import { InlineScript } from '@_types/Scripting'
 
 export class SearchApplication {
   /**
-   * Search Application name
+   * Search Application name.
    */
   name: Name
   /**
-   * Indices that are part of the Search Application
+   * Indices that are part of the Search Application.
    */
   indices: IndexName[]
   /**
-   * Last time the Search Application was updated
+   * Last time the Search Application was updated.
    */
   updated_at_millis: EpochTime<UnitMillis>
   /**
-   * Analytics collection associated to the Search Application
+   * Analytics collection associated to the Search Application.
    */
   analytics_collection_name?: Name
   /**
-   * Search template to use on search operations
+   * Search template to use on search operations.
    */
   template?: SearchApplicationTemplate
 }
 
 export class SearchApplicationTemplate {
+  /**
+   * The associated mustache template.
+   */
   script: InlineScript
 }

specification/search_application/_types/SearchApplication.ts

@@ -28,15 +28,16 @@ import { integer } from '@_types/Numeric'
 export interface Request extends RequestBase {
   query_parameters: {
     /**
-     * Query in the Lucene query string syntax"
+     * Query in the Lucene query string syntax.
      */
     q?: string
     /**
-     * Starting offset (default: 0)
+     * Starting offset.
+     * @server_default 0
      */
     from?: integer
     /**
-     * specifies a max number of results to get
+     * Specifies a max number of results to get.
      */
     size?: integer
   }

specification/search_application/list/SearchApplicationsListRequest.ts

@@ -29,18 +29,19 @@ import { SearchApplication } from '../_types/SearchApplication'
 export interface Request extends RequestBase {
   path_parts: {
     /**
-     * The name of the search application to be created or updated
+     * The name of the search application to be created or updated.
      */
     name: Name
   }
   query_parameters: {
     /**
-     * If true, requires that a search application with the specified resource_id does not already exist. (default: false)
+     * If `true`, this request cannot replace or update existing Search Applications.
+     * @server_default false
      */
     create?: boolean
   }
   /**
-   * The search application information to update
+   * Contains parameters for a search application.
    */
   /** @codegen_name search_application */
   body: SearchApplication

specification/search_application/put/SearchApplicationsPutRequest.ts

@@ -20,15 +20,15 @@ import { RequestBase } from '@_types/Base'
 import { Name } from '@_types/common'
 
 /**
- * Creates a behavioral analytics collection
+ * Creates a behavioral analytics collection.
  * @rest_spec_name search_application.put_behavioral_analytics
  * @availability stack since=8.8.0 stability=experimental
  * @availability serverless stability=experimental visibility=public
  */
 export interface Request extends RequestBase {
   path_parts: {
     /**
-     * The name of the analytics collection to be created or updated
+     * The name of the analytics collection to be created or updated.
      */
     name: Name
   }

specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts

@@ -22,19 +22,22 @@ import { Dictionary } from '@spec_utils/Dictionary'
 import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
 
 /**
- * Perform a search against a search application
+ * Perform a search against a search application.
  * @rest_spec_name search_application.search
  * @availability stack since=8.8.0 stability=beta
  * @availability serverless stability=beta visibility=public
  */
 export interface Request extends RequestBase {
   path_parts: {
     /**
-     * The name of the search application to be searched
+     * The name of the search application to be searched.
      */
     name: Name
   }
   body: {
+    /**
+     * Query parameters specific to this request, which will override any defaults specified in the template.
+     */
     params?: Dictionary<string, UserDefinedValue>
   }
 }