Skip to content

Commit

Permalink
Search: Adding examples to arm-search spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@brjohnstmsft
brjohnstmsft committed Oct 28, 2016
1 parent c6eff9c commit 9b23f29
Showing 1 changed file with 155 additions and 3 deletions.
158 changes: 155 additions & 3 deletions arm-search/2015-08-19/swagger/search.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@
"description": "The admin keys were successfully retrieved and are in the response. You can use either the primary or secondary key as the value of the 'api-key' parameter in the Azure Search Service REST API or SDK to perform any operations on your Search service, including privileged operations. Privileged operations include managing resources like indexes and data sources as well as uploading, modifying, or deleting data in your indexes.",
"schema": {
"$ref": "#/definitions/AdminKeyResult"
},
"examples": {
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
},
"default": {
Expand Down Expand Up @@ -126,6 +130,10 @@
"description": "The specified admin key was successfully regenerated. Both admin keys are included in the response, including the newly-regenerated key.",
"schema": {
"$ref": "#/definitions/AdminKeyResult"
},
"examples": {
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
},
"default": {
Expand Down Expand Up @@ -176,7 +184,11 @@
"description": "The query key was successfully created and is in the response. You can use the query key as the value of the 'api-key' parameter in the Azure Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.",
"schema": {
"$ref": "#/definitions/QueryKey"
}
},
"examples": {
"name": "Query key for browser-based clients",
"key": "<a query API key>"
}
},
"default": {
"description": "HTTP 404 (Not Found): The subscription, resource group, or Search service could not be found. HTTP 409 (Conflict): The specified subscription is disabled.",
Expand Down Expand Up @@ -222,6 +234,19 @@
"description": "All query keys for the given Search service were successfully retrieved and are in the response. You can use any of the query keys as the value of the 'api-key' parameter in the Azure Search Service REST API or SDK to perform read-only operations on your Search indexes such as querying and looking up documents by ID.",
"schema": {
"$ref": "#/definitions/ListQueryKeysResult"
},
"examples": {
"value": [
{
"name": "Query key for browser-based clients",
"key": "<a query API key>"
},
{
"name": "Query key for mobile clients",
"key": "<another query API key>"
}
],
"nextLink": null
}
},
"default": {
Expand Down Expand Up @@ -331,12 +356,52 @@
"description": "The existing service definition was successfully updated. If you changed the number of replicas or partitions, the scale operation will happen asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.",
"schema": {
"$ref": "#/definitions/SearchService"
},
"examples": {
"id": "/subscriptions/<your subscription ID here>/resourceGroups/Default-ResourceGroup/providers/Microsoft.Search/searchServices/azs-test",
"name": "azs-test",
"location": "westus",
"type": "Microsoft.Search/searchServices",
"tags": {
"app-name": "My e-commerce app"
},
"sku": {
"name": "standard"
},
"properties":{
"replicaCount": 3,
"partitionCount": 1,
"status": "provisioning",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "provisioning"
}
}
},
"201": {
"description": "If you requested creation of a free Search service, the service is now provisioned and ready to use, subject to DNS propagation delay. For other SKU types, provisioning happens asynchronously. You can periodically get your service definition and monitor progress via the provisioningState property.",
"schema": {
"$ref": "#/definitions/SearchService"
},
"examples": {
"id": "/subscriptions/<your subscription ID here>/resourceGroups/Default-ResourceGroup/providers/Microsoft.Search/searchServices/azs-test",
"name": "azs-test",
"location": "westus",
"type": "Microsoft.Search/searchServices",
"tags": {
"app-name": "My e-commerce app"
},
"sku": {
"name": "standard"
},
"properties":{
"replicaCount": 3,
"partitionCount": 1,
"status": "provisioning",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "provisioning"
}
}
},
"default": {
Expand Down Expand Up @@ -378,6 +443,26 @@
"description": "The Search service definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.",
"schema": {
"$ref": "#/definitions/SearchService"
},
"examples": {
"id": "/subscriptions/<your subscription ID here>/resourceGroups/Default-ResourceGroup/providers/Microsoft.Search/searchServices/azs-test",
"name": "azs-test",
"location": "westus",
"type": "Microsoft.Search/searchServices",
"tags": {
"app-name": "My e-commerce app"
},
"sku": {
"name": "standard"
},
"properties":{
"replicaCount": 3,
"partitionCount": 1,
"status": "running",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "succeeded"
}
}
},
"default": {
Expand Down Expand Up @@ -465,6 +550,50 @@
"description": "The operation succeeded. The response contains the list of all Search service definitions for the given resource group.",
"schema": {
"$ref": "#/definitions/SearchServiceListResult"
},
"examples": {
"value": [
{
"id": "/subscriptions/<your subscription ID here>/resourceGroups/Default-ResourceGroup/providers/Microsoft.Search/searchServices/azs-test",
"name": "azs-test",
"location": "westus",
"type": "Microsoft.Search/searchServices",
"tags": {
"app-name": "My e-commerce app"
},
"sku": {
"name": "standard"
},
"properties":{
"replicaCount": 3,
"partitionCount": 1,
"status": "running",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "succeeded"
}
},
{
"id": "/subscriptions/<your subscription ID here>/resourceGroups/Default-ResourceGroup/providers/Microsoft.Search/searchServices/azs-test-backup",
"name": "azs-test-backup",
"location": "eastus",
"type": "Microsoft.Search/searchServices",
"tags": {
"app-name": "My e-commerce app"
},
"sku": {
"name": "basic"
},
"properties":{
"replicaCount": 1,
"partitionCount": 1,
"status": "running",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "succeeded"
}
}
]
}
},
"default": {
Expand Down Expand Up @@ -512,6 +641,11 @@
"description": "The name check completed. The response contains details of whether the name is valid and available. If the name is invalid, the response also contains a message explaining why not.",
"schema": {
"$ref": "#/definitions/CheckNameAvailabilityOutput"
},
"examples": {
"nameAvailable": false,
"reason": "AlreadyExists",
"message": ""
}
},
"default": {
Expand Down Expand Up @@ -548,7 +682,11 @@
}
}
},
"description": "Input of check name availability API."
"description": "Input of check name availability API.",
"example": {
"name": "azs-test",
"type": "searchServices"
}
},
"CheckNameAvailabilityOutput": {
"type": "object",
Expand Down Expand Up @@ -670,7 +808,21 @@
"$ref": "#/definitions/Resource"
}
],
"description": "Describes an Azure Search service and its current state."
"description": "Describes an Azure Search service and its current state.",
"example": {
"location": "westus",
"tags":{
"app-name": "My e-commerce app"
},
"sku":{
"name": "standard"
},
"properties":{
"replicaCount": 3,
"partitionCount": 1,
"hostingMode": "default"
}
}
},
"SearchServiceProperties": {
"properties": {
Expand Down

0 comments on commit 9b23f29

Please sign in to comment.