-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Azure Search] New GA data-plane API spec for version 2019-05-06 (#5782)
* [Azure Search] Copy 2017-11-11-Preview specs to 2019-05-06 * [Azure Search] Update 2019-05-06 spec to reflect new GA API Made the following changes to specs and examples: 1. Changed version number from 2017-11-11-Preview to 2019-05-06. 2. Removed encryptionKey from Index and SynonymMap, as well as supporting types and examples. Encryption with customer-managed keys is still in preview. 3. Added statusCode to IndexError since this was added to the 2019-05-06 API. 4. Made DataSourceCredentials.connectionString an optional property to suppress generation of client-side validation code. This will make it easier for customers to write correct code that updates their data sources. This is especially important now that Create and CreateOrUpdate do not return the connection string. No further changes are required because all other features from 2017-11-11-Preview are now GA in 2019-05-06.
- Loading branch information
1 parent
1660bb5
commit da72486
Showing
44 changed files
with
9,986 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
...oft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexAutocompleteDocumentsGet.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
{ | ||
"parameters": { | ||
"searchServiceName": "myservice", | ||
"searchDnsSuffix": "search.windows.net", | ||
"indexName": "myindex", | ||
"api-version": "2019-05-06", | ||
"autocompleteMode": "oneTerm", | ||
"search": "washington medic", | ||
"suggesterName": "sg", | ||
"filter": "search.in(docId,'101,102,105')", | ||
"fuzzy": false, | ||
"highlightPostTag": "</em>", | ||
"highlightPreTag": "<em>", | ||
"minimumCoverage": 80, | ||
"searchFields": ["title", "description"], | ||
"top": 10 | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": [ | ||
{ | ||
"text": "medicaid", | ||
"queryPlusText": "washington medicaid" | ||
}, | ||
{ | ||
"text": "medicare", | ||
"queryPlusText": "washington medicare" | ||
}, | ||
{ | ||
"text": "medicine", | ||
"queryPlusText": "washington medicine" | ||
} | ||
] | ||
} | ||
} | ||
} |
37 changes: 37 additions & 0 deletions
37
...ft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexAutocompleteDocumentsPost.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
{ | ||
"parameters": { | ||
"searchServiceName": "myservice", | ||
"searchDnsSuffix": "search.windows.net", | ||
"indexName": "myindex", | ||
"api-version": "2017-11-11-Preview", | ||
"autocompleteRequest": { | ||
"autocompleteMode": "oneTerm", | ||
"search": "washington medic", | ||
"suggesterName": "sg", | ||
"filter": "search.in(docId,'101,102,105')", | ||
"highlightPostTag": "</em>", | ||
"highlightPreTag": "<em>", | ||
"minimumCoverage": 80, | ||
"searchFields": "title,description", | ||
"top": 10 | ||
} | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": [ | ||
{ | ||
"text": "medicaid", | ||
"queryPlusText": "washington medicaid" | ||
}, | ||
{ | ||
"text": "medicare", | ||
"queryPlusText": "washington medicare" | ||
}, | ||
{ | ||
"text": "medicine", | ||
"queryPlusText": "washington medicine" | ||
} | ||
] | ||
} | ||
} | ||
} |
13 changes: 13 additions & 0 deletions
13
...ane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexCountDocuments.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"parameters": { | ||
"searchServiceName": "myservice", | ||
"searchDnsSuffix": "search.windows.net", | ||
"indexName": "myindex", | ||
"api-version": "2017-11-11-Preview" | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": 427 | ||
} | ||
} | ||
} |
19 changes: 19 additions & 0 deletions
19
...-plane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexGetDocument.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
{ | ||
"parameters": { | ||
"searchServiceName": "myservice", | ||
"searchDnsSuffix": "search.windows.net", | ||
"indexName": "myindex", | ||
"api-version": "2019-05-06", | ||
"key": "1", | ||
"$select": ["docId", "title", "description"] | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"description": "Cheapest hotel in town", | ||
"docId": "1", | ||
"title": "Nice Hotel" | ||
} | ||
} | ||
} | ||
} |
94 changes: 94 additions & 0 deletions
94
...ane/Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexIndexDocuments.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
{ | ||
"parameters": { | ||
"searchServiceName": "myservice", | ||
"searchDnsSuffix": "search.windows.net", | ||
"indexName": "myindex", | ||
"api-version": "2019-05-06", | ||
"batch": { | ||
"value": [ | ||
{ | ||
"@search.action": "upload", | ||
"docId": "1", | ||
"title": "Fancy Stay", | ||
"description": "Best hotel in town" | ||
}, | ||
{ | ||
"@search.action": "merge", | ||
"docId": "2", | ||
"title": "Roach Motel" | ||
}, | ||
{ | ||
"@search.action": "mergeOrUpload", | ||
"docId": "3", | ||
"title": "Econo Motel" | ||
}, | ||
{ | ||
"@search.action": "delete", | ||
"docId": "4" | ||
} | ||
] | ||
} | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"value": [ | ||
{ | ||
"key": "1", | ||
"status": true, | ||
"errorMessage": null, | ||
"statusCode": 201 | ||
}, | ||
{ | ||
"key": "2", | ||
"status": true, | ||
"errorMessage": null, | ||
"statusCode": 200 | ||
}, | ||
{ | ||
"key": "3", | ||
"status": true, | ||
"errorMessage": null, | ||
"statusCode": 200 | ||
}, | ||
{ | ||
"key": "4", | ||
"status": true, | ||
"errorMessage": null, | ||
"statusCode": 200 | ||
} | ||
] | ||
} | ||
}, | ||
"207": { | ||
"body": { | ||
"value": [ | ||
{ | ||
"key": "1", | ||
"status": true, | ||
"errorMessage": null, | ||
"statusCode": 200 | ||
}, | ||
{ | ||
"key": "2", | ||
"status": false, | ||
"errorMessage": "Document not found.", | ||
"statusCode": 404 | ||
}, | ||
{ | ||
"key": "3", | ||
"status": true, | ||
"errorMessage": null, | ||
"statusCode": 200 | ||
}, | ||
{ | ||
"key": "4", | ||
"status": true, | ||
"errorMessage": null, | ||
"statusCode": 200 | ||
} | ||
] | ||
} | ||
} | ||
} | ||
} |
65 changes: 65 additions & 0 deletions
65
...Microsoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSearchDocumentsGet.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
{ | ||
"parameters": { | ||
"searchServiceName": "myservice", | ||
"searchDnsSuffix": "search.windows.net", | ||
"indexName": "myindex", | ||
"api-version": "2019-05-06", | ||
"$count": true, | ||
"facet": [ "category,count:10,sort:count" ], | ||
"$filter": "rating gt 10", | ||
"highlight": [ "title" ], | ||
"highlightPostTag": "</em>", | ||
"highlightPreTag": "<em>", | ||
"minimumCoverage": 80, | ||
"$orderby": [ "search.score() desc", "rating desc" ], | ||
"queryType": "simple", | ||
"scoringParameters": [ "currentLocation--122.123,44.77233" ], | ||
"scoringProfile": "sp", | ||
"search": "nice hotels", | ||
"searchFields": [ "title", "description" ], | ||
"searchMode": "any", | ||
"$select": [ "docId", "title", "description" ], | ||
"$skip": 100, | ||
"$top": 10 | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"@odata.count": 25, | ||
"@search.coverage": 80, | ||
"@search.facets": { | ||
"category": [ | ||
{ | ||
"count": 1, | ||
"value": "Economy" | ||
}, | ||
{ | ||
"count": 1, | ||
"value": "Luxury" | ||
} | ||
] | ||
}, | ||
"value": [ | ||
{ | ||
"@search.score": 1.50, | ||
"@search.highlights": { | ||
"title": [ "<em>Nice</em> <em>Hotel</em>" ] | ||
}, | ||
"description": "Cheapest hotel in town", | ||
"docId": "1", | ||
"title": "Nice Hotel" | ||
}, | ||
{ | ||
"@search.score": 0.70, | ||
"@search.highlights": { | ||
"title": [ "Fancy <em>Hotel</em>" ] | ||
}, | ||
"description": "Best hotel in town", | ||
"docId": "2", | ||
"title": "Fancy Hotel" | ||
} | ||
] | ||
} | ||
} | ||
} | ||
} |
86 changes: 86 additions & 0 deletions
86
...icrosoft.Azure.Search.Data/stable/2019-05-06/examples/SearchIndexSearchDocumentsPost.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
{ | ||
"parameters": { | ||
"searchServiceName": "myservice", | ||
"searchDnsSuffix": "search.windows.net", | ||
"indexName": "myindex", | ||
"api-version": "2019-05-06", | ||
"searchRequest": { | ||
"count": true, | ||
"facets": [ "category,count:10,sort:count" ], | ||
"filter": "rating gt 4.0", | ||
"highlight": "title", | ||
"highlightPostTag": "</em>", | ||
"highlightPreTag": "<em>", | ||
"minimumCoverage": null, | ||
"orderby": "search.score() desc,rating desc", | ||
"queryType": "simple", | ||
"scoringParameters": [ "currentLocation--122.123,44.77233" ], | ||
"scoringProfile": "sp", | ||
"search": "nice hotels", | ||
"searchFields": "title,description", | ||
"searchMode": "any", | ||
"select": "docId,title,description", | ||
"skip": 0, | ||
"top": 10 | ||
} | ||
}, | ||
"responses": { | ||
"200": { | ||
"body": { | ||
"@odata.count": 25, | ||
"@search.facets": { | ||
"category": [ | ||
{ | ||
"count": 1, | ||
"value": "Economy" | ||
}, | ||
{ | ||
"count": 1, | ||
"value": "Luxury" | ||
} | ||
] | ||
}, | ||
"@search.nextPageParameters": { | ||
"count": true, | ||
"facets": [ "category,count:10,sort:count" ], | ||
"filter": "rating gt 4.0", | ||
"highlight": "title", | ||
"highlightPostTag": "</em>", | ||
"highlightPreTag": "<em>", | ||
"minimumCoverage": null, | ||
"orderby": "search.score() desc,rating desc", | ||
"queryType": "simple", | ||
"scoringParameters": [ "currentLocation--122.123,44.77233" ], | ||
"scoringProfile": "sp", | ||
"search": "nice hotels", | ||
"searchFields": "title,description", | ||
"searchMode": "any", | ||
"select": "docId,title,description", | ||
"skip": 2, | ||
"top": 8 | ||
}, | ||
"value": [ | ||
{ | ||
"@search.score": 1.50, | ||
"@search.highlights": { | ||
"title": [ "<em>Nice</em> <em>Hotel</em>" ] | ||
}, | ||
"description": "Cheapest hotel in town", | ||
"docId": "1", | ||
"title": "Nice Hotel" | ||
}, | ||
{ | ||
"@search.score": 0.70, | ||
"@search.highlights": { | ||
"title": [ "Fancy <em>Hotel</em>" ] | ||
}, | ||
"description": "Best hotel in town", | ||
"docId": "2", | ||
"title": "Fancy Hotel" | ||
} | ||
], | ||
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2019-05-06" | ||
} | ||
} | ||
} | ||
} |
Oops, something went wrong.