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

[Azure Search] Apply branding changes to stable/2019-05-06 and track1/stable/2019-05-06 #7511

Merged
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "SearchIndexClient",
"description": "Client that can be used to query an Azure Search index and upload, merge, or delete documents.",
"description": "Client that can be used to query an index and upload, merge, or delete documents.",
"version": "2019-05-06",
"x-ms-code-generation-settings": {
"useDateTimeOffset": true,
Expand Down Expand Up @@ -80,7 +80,7 @@
"$ref": "./examples/SearchIndexSearchDocumentsGet.json"
}
},
"description": "Searches for documents in the Azure Search index.",
"description": "Searches for documents in the index.",
"parameters": [
{
"name": "search",
Expand Down Expand Up @@ -312,7 +312,7 @@
"$ref": "./examples/SearchIndexSearchDocumentsPost.json"
}
},
"description": "Searches for documents in the Azure Search index.",
"description": "Searches for documents in the index.",
"parameters": [
{
"name": "searchRequest",
Expand Down Expand Up @@ -356,7 +356,7 @@
"$ref": "./examples/SearchIndexGetDocument.json"
}
},
"description": "Retrieves a document from the Azure Search index.",
"description": "Retrieves a document from the index.",
"parameters": [
{
"name": "key",
Expand Down Expand Up @@ -406,7 +406,7 @@
"$ref": "./examples/SearchIndexSuggestDocumentsGet.json"
}
},
"description": "Suggests documents in the Azure Search index that match the given partial query text.",
"description": "Suggests documents in the index that match the given partial query text.",
"parameters": [
{
"name": "search",
Expand Down Expand Up @@ -550,7 +550,7 @@
"$ref": "./examples/SearchIndexSuggestDocumentsPost.json"
}
},
"description": "Suggests documents in the Azure Search index that match the given partial query text.",
"description": "Suggests documents in the index that match the given partial query text.",
"parameters": [
{
"name": "suggestRequest",
Expand Down Expand Up @@ -593,7 +593,7 @@
"$ref": "./examples/SearchIndexIndexDocuments.json"
}
},
"description": "Sends a batch of document write actions to the Azure Search index.",
"description": "Sends a batch of document write actions to the index.",
"parameters": [
{
"name": "batch",
Expand Down Expand Up @@ -642,7 +642,7 @@
"$ref": "./examples/SearchIndexAutocompleteDocumentsGet.json"
}
},
"description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.",
"description": "Autocompletes incomplete query terms based on input text and matching terms in the index.",
"parameters": [
{
"$ref": "#/parameters/ClientRequestIdParameter"
Expand Down Expand Up @@ -780,7 +780,7 @@
"$ref": "./examples/SearchIndexAutocompleteDocumentsPost.json"
}
},
"description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.",
"description": "Autocompletes incomplete query terms based on input text and matching terms in the index.",
"parameters": [
{
"$ref": "#/parameters/ClientRequestIdParameter"
Expand Down Expand Up @@ -831,7 +831,7 @@
"description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request."
}
},
"description": "Response containing suggestion query results from an Azure Search index."
"description": "Response containing suggestion query results from an index."
},
"SuggestResult": {
"properties": {
Expand Down Expand Up @@ -864,7 +864,7 @@
"format": "int64",
"readOnly": true,
"x-ms-client-name": "Count",
"description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Search can't return all the requested documents in a single Search response."
"description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response."
},
"@search.coverage": {
"type": "number",
Expand All @@ -889,7 +889,7 @@
"$ref": "#/definitions/SearchRequest",
"readOnly": true,
"x-ms-client-name": "NextPageParameters",
"description": "Continuation JSON payload returned when Azure Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response."
"description": "Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response."
},
"value": {
"type": "array",
Expand All @@ -904,10 +904,10 @@
"type": "string",
"readOnly": true,
"x-ms-client-name": "NextLink",
"description": "Continuation URL returned when Azure Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response."
"description": "Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response."
}
},
"description": "Response containing search results from an Azure Search index."
"description": "Response containing search results from an index."
},
"SearchResult": {
"properties": {
Expand Down Expand Up @@ -949,7 +949,7 @@
"required": [
"value"
],
"description": "Contains a batch of document write actions to send to the Azure Search index."
"description": "Contains a batch of document write actions to send to the index."
},
"IndexAction": {
"properties": {
Expand Down Expand Up @@ -1310,7 +1310,7 @@
"required": true,
"type": "string",
"x-ms-skip-url-encoding": true,
"description": "The name of the Azure Search service.",
"description": "The name of the search service.",
"x-ms-parameter-location": "client"
},
"SearchDnsSuffixParameter": {
Expand All @@ -1320,7 +1320,7 @@
"type": "string",
"default": "search.windows.net",
"x-ms-skip-url-encoding": true,
"description": "The DNS suffix of the Azure Search service. The default is search.windows.net.",
"description": "The DNS suffix of the search service. The default is search.windows.net.",
"x-ms-parameter-location": "client"
},
"IndexNameParameter": {
Expand All @@ -1329,7 +1329,7 @@
"required": true,
"type": "string",
"x-ms-skip-url-encoding": false,
"description": "The name of the Azure Search index.",
"description": "The name of the index.",
"x-ms-parameter-location": "client"
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "SearchIndexClient",
"description": "Client that can be used to query an Azure Search index and upload, merge, or delete documents.",
"description": "Client that can be used to query an index and upload, merge, or delete documents.",
"version": "2019-05-06",
"x-ms-code-generation-settings": {
"useDateTimeOffset": true,
Expand Down Expand Up @@ -80,7 +80,7 @@
"$ref": "./examples/SearchIndexSearchDocumentsGet.json"
}
},
"description": "Searches for documents in the Azure Search index.",
"description": "Searches for documents in the index.",
"parameters": [
{
"name": "search",
Expand Down Expand Up @@ -312,7 +312,7 @@
"$ref": "./examples/SearchIndexSearchDocumentsPost.json"
}
},
"description": "Searches for documents in the Azure Search index.",
"description": "Searches for documents in the index.",
"parameters": [
{
"name": "searchRequest",
Expand Down Expand Up @@ -356,7 +356,7 @@
"$ref": "./examples/SearchIndexGetDocument.json"
}
},
"description": "Retrieves a document from the Azure Search index.",
"description": "Retrieves a document from the index.",
"parameters": [
{
"name": "key",
Expand Down Expand Up @@ -406,7 +406,7 @@
"$ref": "./examples/SearchIndexSuggestDocumentsGet.json"
}
},
"description": "Suggests documents in the Azure Search index that match the given partial query text.",
"description": "Suggests documents in the index that match the given partial query text.",
"parameters": [
{
"name": "search",
Expand Down Expand Up @@ -550,7 +550,7 @@
"$ref": "./examples/SearchIndexSuggestDocumentsPost.json"
}
},
"description": "Suggests documents in the Azure Search index that match the given partial query text.",
"description": "Suggests documents in the index that match the given partial query text.",
"parameters": [
{
"name": "suggestRequest",
Expand Down Expand Up @@ -593,7 +593,7 @@
"$ref": "./examples/SearchIndexIndexDocuments.json"
}
},
"description": "Sends a batch of document write actions to the Azure Search index.",
"description": "Sends a batch of document write actions to the index.",
"parameters": [
{
"name": "batch",
Expand Down Expand Up @@ -642,7 +642,7 @@
"$ref": "./examples/SearchIndexAutocompleteDocumentsGet.json"
}
},
"description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.",
"description": "Autocompletes incomplete query terms based on input text and matching terms in the index.",
"parameters": [
{
"$ref": "#/parameters/ClientRequestIdParameter"
Expand Down Expand Up @@ -780,7 +780,7 @@
"$ref": "./examples/SearchIndexAutocompleteDocumentsPost.json"
}
},
"description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.",
"description": "Autocompletes incomplete query terms based on input text and matching terms in the index.",
"parameters": [
{
"$ref": "#/parameters/ClientRequestIdParameter"
Expand Down Expand Up @@ -831,7 +831,7 @@
"description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request."
}
},
"description": "Response containing suggestion query results from an Azure Search index."
"description": "Response containing suggestion query results from an index."
},
"SuggestResult": {
"properties": {
Expand Down Expand Up @@ -864,7 +864,7 @@
"format": "int64",
"readOnly": true,
"x-ms-client-name": "Count",
"description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Search can't return all the requested documents in a single Search response."
"description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response."
},
"@search.coverage": {
"type": "number",
Expand All @@ -889,7 +889,7 @@
"$ref": "#/definitions/SearchRequest",
"readOnly": true,
"x-ms-client-name": "NextPageParameters",
"description": "Continuation JSON payload returned when Azure Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response."
"description": "Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response."
},
"value": {
"type": "array",
Expand All @@ -904,10 +904,10 @@
"type": "string",
"readOnly": true,
"x-ms-client-name": "NextLink",
"description": "Continuation URL returned when Azure Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response."
"description": "Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response."
}
},
"description": "Response containing search results from an Azure Search index."
"description": "Response containing search results from an index."
},
"SearchResult": {
"properties": {
Expand Down Expand Up @@ -949,7 +949,7 @@
"required": [
"value"
],
"description": "Contains a batch of document write actions to send to the Azure Search index."
"description": "Contains a batch of document write actions to send to the index."
},
"IndexAction": {
"properties": {
Expand Down Expand Up @@ -1310,7 +1310,7 @@
"required": true,
"type": "string",
"x-ms-skip-url-encoding": true,
"description": "The name of the Azure Search service.",
"description": "The name of the search service.",
"x-ms-parameter-location": "client"
},
"SearchDnsSuffixParameter": {
Expand All @@ -1320,7 +1320,7 @@
"type": "string",
"default": "search.windows.net",
"x-ms-skip-url-encoding": true,
"description": "The DNS suffix of the Azure Search service. The default is search.windows.net.",
"description": "The DNS suffix of the search service. The default is search.windows.net.",
"x-ms-parameter-location": "client"
},
"IndexNameParameter": {
Expand All @@ -1329,7 +1329,7 @@
"required": true,
"type": "string",
"x-ms-skip-url-encoding": false,
"description": "The name of the Azure Search index.",
"description": "The name of the index.",
"x-ms-parameter-location": "client"
}
}
Expand Down
Loading