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

Swagger completeness for Redis Cache #2537

Merged
merged 8 commits into from
Mar 2, 2018
Merged

Swagger completeness for Redis Cache #2537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
98db611
Default string modeled as parameter for auto generation to work corre…
Feb 12, 2018
48ccf3a
Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs
Feb 15, 2018
f41c9f3
Adding CheckNameAvailability and listUpgradeNotifications into swagge…
Feb 17, 2018
c46c547
Fixing code review comments
Feb 20, 2018
52d3098
remove "/" at end for list apis
Feb 23, 2018
adccbe1
Name change for notification
Feb 23, 2018
fdcb7d3
Fixing code review comments in PR
Mar 1, 2018
1f8b1a0
Fixing examples that are breaking the build
Mar 2, 2018
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
13 changes: 13 additions & 0 deletions ...e-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCacheCheckNameAvailability.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"parameters": {
"api-version": "2017-10-01",
"subscriptionId": "subid",
"parameters": {
"type": "Microsoft.Cache/Redis",
"name": "cacheName"
}
},
"responses": {
"200": {}
}
}
22 changes: 22 additions & 0 deletions ...anager/Microsoft.Cache/stable/2017-10-01/examples/RedisCacheListUpgradeNotifications.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"parameters": {
"name": "cache1",
"resourceGroupName": "rg1",
"api-version": "2017-10-01",
"subscriptionId": "subid",
"history": "5000"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "notification1",
"timestamp": "2017-02-16T23:20:50.52Z",
"upsellNotification": {}
}
]
}
}
}
}
1 change: 1 addition & 0 deletions ...er/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"parameters": {
"name": "cache1",
"resourceGroupName": "rg1",
"default": "default",
"api-version": "2017-10-01",
"subscriptionId": "subid",
"parameters": {
Expand Down
1 change: 1 addition & 0 deletions ...ce-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesDelete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"parameters": {
"name": "cache1",
"resourceGroupName": "rg1",
"default": "default",
"api-version": "2017-10-01",
"subscriptionId": "subid"
},
Expand Down
1 change: 1 addition & 0 deletions ...ource-manager/Microsoft.Cache/stable/2017-10-01/examples/RedisCachePatchSchedulesGet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"parameters": {
"name": "cache1",
"resourceGroupName": "rg1",
"default": "default",
"api-version": "2017-10-01",
"subscriptionId": "subid"
},
Expand Down
186 changes: 183 additions & 3 deletions specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,90 @@
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability": {
"post": {
"tags": [
"Redis"
],
"operationId": "Redis_CheckNameAvailability",
"x-ms-examples": {
"RedisCacheList": { "$ref": "./examples/RedisCacheCheckNameAvailability.json" }
},
"description": "Checks that the redis cache name is valid and is not already in use.",
"parameters": [
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CheckNameAvailabilityParameters"
},
"description": "Parameters supplied to the CheckNameAvailability Redis operation."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Name is available"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/listUpgradeNotifications": {
"get": {
"tags": [
"Redis"
],
"operationId": "Redis_ListUpgradeNotifications",
"x-ms-examples": {
"RedisCacheGet": { "$ref": "./examples/RedisCacheListUpgradeNotifications.json" }
},
"description": "Gets any upgrade notifications for a Redis cache.",
"parameters": [
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group."
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the Redis cache."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"name": "history",
"in": "query",
"required": true,
"type": "number",
"format": "double",
"description": "how many minutes in past to look for upgrade notifications"
}
],
"responses": {
"200": {
"description": "All upgrade notifications in given time range",
"schema": {
"$ref": "#/definitions/NotificationListResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}": {
"put": {
"tags": [
Expand Down Expand Up @@ -247,7 +331,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis": {
"get": {
"tags": [
"Redis"
Expand Down Expand Up @@ -285,7 +369,7 @@
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis/": {
"/subscriptions/{subscriptionId}/providers/Microsoft.Cache/Redis": {
"get": {
"tags": [
"Redis"
Expand Down Expand Up @@ -777,7 +861,7 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/default": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/patchSchedules/{default}": {
"put": {
"tags": [
"Redis"
Expand All @@ -802,6 +886,20 @@
"type": "string",
"description": "The name of the Redis cache."
},
{
"name": "default",
"in": "path",
"required": true,
"type": "string",
"description": "Default string modeled as parameter for auto generation to work correctly.",
"enum": [
"default"
],
"x-ms-enum": {
"name": "defaultName",
"modelAsString": true
}
},
{
"name": "parameters",
"in": "body",
Expand Down Expand Up @@ -857,6 +955,20 @@
"type": "string",
"description": "The name of the redis cache."
},
{
"name": "default",
"in": "path",
"required": true,
"type": "string",
"description": "Default string modeled as parameter for auto generation to work correctly.",
"enum": [
"default"
],
"x-ms-enum": {
"name": "defaultName",
"modelAsString": true
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
Expand Down Expand Up @@ -897,6 +1009,20 @@
"type": "string",
"description": "The name of the redis cache."
},
{
"name": "default",
"in": "path",
"required": true,
"type": "string",
"description": "Default string modeled as parameter for auto generation to work correctly.",
"enum": [
"default"
],
"x-ms-enum": {
"name": "defaultName",
"modelAsString": true
}
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
Expand Down Expand Up @@ -1832,6 +1958,60 @@
"description": "URL to get the next set of operation list results if there are any."
}
}
},
"CheckNameAvailabilityParameters": {
"description": "Parameters body to pass for name availability check.",
"properties": {
"name": {
"type": "string",
"description": "Resource name."
},
"type": {
"type": "string",
"description": "Resource type."
}
}
},
"UpgradeNotification": {
"properties": {
"name": {
"readOnly": true,
"type": "string",
"description": "Name of upgrade notification."
},
"timestamp": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "Timestamp when upgrade notification occured."
},
"upsellNotification": {
"readOnly": true,
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Details about this upgrade notification"
}
},
"description": "Properties of upgrade notification."
},
"NotificationListResponse": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/UpgradeNotification"
},
"description": "List of all notifications."
},
"nextLink": {
"type": "string",
"readOnly": true,
"description": "Link for next set of notifications."
}
},
"description": "The response of listUpgradeNotifications."
}
},
"parameters": {
Expand Down