Merge pull request #421 from brjohnstmsft/search-indexers

Search SDK: Merging indexer support into v2-preview branch
Azure · Jul 22, 2016 · 6736f4e · 6736f4e
2 parents 8e98c69 + 5d88548
commit 6736f4e
Showing 1 changed file with 88 additions and 3 deletions.
diff --git a/search/2015-02-28-Preview/swagger/searchservice.json b/search/2015-02-28-Preview/swagger/searchservice.json
@@ -886,7 +886,7 @@
         },
         "query": {
           "type": "string",
-          "description": "A query that is applied to this data container. Only supported by DocumentDb datasources."
+          "description": "A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources."
         }
       },
       "required": [
@@ -964,6 +964,14 @@
         }
       }
     },
+    "DataSourceType": {
+      "properties": {
+        "name": {
+          "type": "string"
+        }
+      },
+      "x-ms-external": true
+    },
     "DataSource": {
       "properties": {
         "name": {
@@ -978,7 +986,7 @@
           "description": "The description of the datasource."
         },
         "type": {
-          "type": "string",
+          "$ref": "#/definitions/DataSourceType",
           "description": "The type of the datasource."
         },
         "credentials": {
@@ -1037,22 +1045,83 @@
     },
     "IndexingParameters": {
       "properties": {
+        "batchSize": {
+          "type": "integer",
+          "format": "int32",
+          "description": "The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type."
+        },
         "maxFailedItems": {
           "type": "integer",
           "format": "int32",
+          "default": 0,
           "description": "The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0."
         },
         "maxFailedItemsPerBatch": {
           "type": "integer",
           "format": "int32",
+          "default": 0,
           "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0."
         },
         "base64EncodeKeys": {
           "type": "boolean",
+          "default": false,
           "description": "Whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false."
+        },
+        "configuration": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object"
+          },
+          "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type."
+        }
+      },
+      "description": "Represents parameters for indexer execution.",
+      "x-ms-external": true
+    },
+    "FieldMappingFunction": {
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The name of the field mapping function."
+        },
+        "parameters": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object"
+          },
+          "description": "A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type."
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "description": "Represents a function that transforms a value from a data source before indexing.",
+      "externalDocs": {
+        "url": "https://azure.microsoft.com/documentation/articles/search-indexer-field-mappings/"
+      }
+    },
+    "FieldMapping": {
+      "properties": {
+        "sourceFieldName": {
+          "type": "string",
+          "description": "The name of the field in the data source."
+        },
+        "targetFieldName": {
+          "type": "string",
+          "description": "The name of the target field in the index. Same as the source field name by default."
+        },
+        "mappingFunction": {
+          "$ref": "#/definitions/FieldMappingFunction",
+          "description": "A function to apply to each source field value before indexing."
         }
       },
-      "description": "Represents parameters for indexer execution."
+      "required": [
+        "sourceFieldName"
+      ],
+      "description": "Defines a mapping between a field in a data source and a target field in an index.",
+      "externalDocs": {
+        "url": "https://azure.microsoft.com/documentation/articles/search-indexer-field-mappings/"
+      }
     },
     "Indexer": {
       "properties": {
@@ -1082,6 +1151,22 @@
         "parameters": {
           "$ref": "#/definitions/IndexingParameters",
           "description": "Parameters for indexer execution."
+        },
+        "fieldMappings": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/FieldMapping"
+          },
+          "description": "Defines mappings between fields in the data source and corresponding target fields in the index.",
+          "externalDocs": {
+            "url": "https://azure.microsoft.com/documentation/articles/search-indexer-field-mappings/"
+          }
+        },
+        "disabled": {
+          "x-ms-client-name": "IsDisabled",
+          "type": "boolean",
+          "default": false,
+          "description": "A value indicating whether the indexer is disabled. Default is false."
         }
       },
       "required": [