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.

Sign up for GitHub

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

Jump to bottom

Search SDK: Swagger specs for SearchIndexClient and SearchServiceClient #14

Merged
merged 1 commit into from
Aug 27, 2015
Merged

Search SDK: Swagger specs for SearchIndexClient and SearchServiceClient #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
324 changes: 324 additions & 0 deletions search/2015-02-28/swagger/searchindex.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,324 @@
{
"swagger": "2.0",
"info": {
"title": "SearchIndexClient",
"description": "Client that can be used to query an Azure Search index and upload, merge, or delete documents.",
"version": "2015-02-28"
},
"consumes": [
"application/json",
"text/json"
],
"produces": [
"application/json",
"text/json"
],
"paths": {
"/docs/$count": {
"get": {
"tags": [
"Documents"
],
"operationId": "Documents_Count",
"description": "Queries the number of documents in the Azure Search index.",
"externalDocs": {
"url": "https://msdn.microsoft.com/library/azure/dn798924.aspx"
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "integer",
"format": "int64"
}
}
}
}
}
},
"definitions": {
"IndexResult": {
"properties": {}
},
"DocumentIndexResult": {
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/IndexResult"
},
"description": "Gets the list of status information for each document in the indexing request."
},
"statusCode": {
"type": "string",
"enum": [
"Continue",
"SwitchingProtocols",
"OK",
"Created",
"Accepted",
"NonAuthoritativeInformation",
"NoContent",
"ResetContent",
"PartialContent",
"MultipleChoices",
"Ambiguous",
"MovedPermanently",
"Moved",
"Found",
"Redirect",
"SeeOther",
"RedirectMethod",
"NotModified",
"UseProxy",
"Unused",
"TemporaryRedirect",
"RedirectKeepVerb",
"BadRequest",
"Unauthorized",
"PaymentRequired",
"Forbidden",
"NotFound",
"MethodNotAllowed",
"NotAcceptable",
"ProxyAuthenticationRequired",
"RequestTimeout",
"Conflict",
"Gone",
"LengthRequired",
"PreconditionFailed",
"RequestEntityTooLarge",
"RequestUriTooLong",
"UnsupportedMediaType",
"RequestedRangeNotSatisfiable",
"ExpectationFailed",
"UpgradeRequired",
"InternalServerError",
"NotImplemented",
"BadGateway",
"ServiceUnavailable",
"GatewayTimeout",
"HttpVersionNotSupported"
],
"x-ms-enum": "HttpStatusCode"
},
"requestId": {
"type": "string"
}
},
"description": "Response containing the status of operations for all documents in the indexing request."
},
"SearchParameters": {
"properties": {
"filter": {
"externalDocs": {
"url": "https://msdn.microsoft.com/library/azure/dn798921.aspx"
},
"type": "string",
"description": "Gets or sets the OData $filter expression to apply to the search query."
},
"highlightFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting."
},
"highlightPostTag": {
"type": "string",
"description": "Gets or sets a string tag that is appended to hit highlights. Must be set with HighlightPreTag. Default is </em>."
},
"highlightPreTag": {
"type": "string",
"description": "Gets or sets a string tag that is prepended to hit highlights. Must be set with HighlightPostTag. Default is <em>."
},
"includeTotalResultCount": {
"type": "boolean",
"description": "Gets or sets a value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation."
},
"minimumCoverage": {
"type": "number",
"format": "double",
"description": "Gets or sets a number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100."
},
"orderBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to the geo.distance() function. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 Orderby clauses."
},
"scoringParameters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name:value. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation:-122.2,44.8\"(without the quotes)."
},
"scoringProfile": {
"type": "string",
"description": "Gets or sets the name of a scoring profile to evaluate match scores for matching documents in order to sort the results."
},
"searchFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the list of field names to include in the full-text search."
},
"searchMode": {
"type": "string",
"description": "Gets or sets a value that specifies whether any or all of the search terms must be matched in order to count the document as a match.",
"enum": [
"any",
"all"
],
"x-ms-enum": "SearchMode"
},
"select": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included."
},
"skip": {
"type": "integer",
"format": "int32",
"description": "Gets or sets the number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use Skip due to this limitation, consider using OrderBy on a totally-ordered key and Filter with a range query instead."
},
"top": {
"externalDocs": {
"url": "https://msdn.microsoft.com/en-us/library/azure/dn798927.aspx"
},
"type": "integer",
"format": "int32",
"description": "Gets or sets the number of search results to retrieve. This can be used in conjunction with Skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be passed to ContinueSearch to retrieve the next page of results. See DocumentSearchResponse.ContinuationToken for more information."
}
},
"description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors."
},
"SuggestParameters": {
"properties": {
"filter": {
"externalDocs": {
"url": "https://msdn.microsoft.com/library/azure/dn798921.aspx"
},
"type": "string",
"description": "Gets or sets the OData $filter expression to apply to the suggestions query."
},
"highlightPostTag": {
"type": "string",
"description": "Gets or sets a string tag that is appended to hit highlights. Must be set with HighlightPreTag. If omitted, hit highlighting of suggestions is disabled."
},
"highlightPreTag": {
"type": "string",
"description": "Gets or sets a string tag that is prepended to hit highlights. Must be set with HighlightPostTag. If omitted, hit highlighting of suggestions is disabled."
},
"minimumCoverage": {
"type": "number",
"format": "double",
"description": "Gets or sets a number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80."
},
"orderBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to the geo.distance() function. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 Orderby clauses."
},
"searchFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the list of field names to consider when querying for suggestions."
},
"select": {
"type": "array",
"items": {
"type": "string"
},
"description": "Gets or sets the list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included."
},
"top": {
"type": "integer",
"format": "int32",
"description": "Gets or sets the number of suggestions to retrieve. This must be a value between 1 and 100. The default is to 5."
},
"useFuzzyMatching": {
"type": "boolean",
"description": "Gets or sets a value indicating whether to use fuzzy matching for the suggestion query. Default is false. when set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources."
}
},
"description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors."
},
"Resource": {
"properties": {
"id": {
"readOnly": true,
"type": "string",
"description": "Resource Id"
},
"name": {
"readOnly": true,
"type": "string",
"description": "Resource name"
},
"type": {
"readOnly": true,
"type": "string",
"description": "Resource type"
},
"location": {
"type": "string",
"description": "Resource location"
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Resource tags"
}
},
"required": [
"location"
],
"x-ms-external": true
},
"SubResource": {
"properties": {
"id": {
"type": "string",
"description": "Resource Id"
}
},
"x-ms-external": true
}
},
"parameters": {
"SubscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
"required": true,
"type": "string",
"description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "Client Api Version."
}
}
}
Loading