Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Search SDK: Merging indexer support into v2-preview branch #421

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 88 additions & 3 deletions search/2015-02-28-Preview/swagger/searchservice.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down Expand Up @@ -964,6 +964,14 @@
}
}
},
"DataSourceType": {
"properties": {
"name": {
"type": "string"
}
},
"x-ms-external": true
},
"DataSource": {
"properties": {
"name": {
Expand All @@ -978,7 +986,7 @@
"description": "The description of the datasource."
},
"type": {
"type": "string",
"$ref": "#/definitions/DataSourceType",
"description": "The type of the datasource."
},
"credentials": {
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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": [
Expand Down