Skip to content

Address the issues with the redis API spec/examples found by new validation #883

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

Merged
vishrutshah merged 1 commit into from
Feb 17, 2017
Merged

Address the issues with the redis API spec/examples found by new validation #883

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
6 changes: 2 additions & 4 deletions arm-redis/2015-08-01/swagger/redis.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
"https"
],
"consumes": [
"application/json",
"text/json"
"application/json"
],
"produces": [
"application/json",
"text/json"
"application/json"
],
"security": [
{
Expand Down
4 changes: 4 additions & 0 deletions arm-redis/2016-04-01/examples/RedisCacheExport.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@
}
},
"responses": {
"200": {
},
"202": {
"headers": {
"location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..."
}
},
"204": {
}
}
}
1 change: 1 addition & 0 deletions arm-redis/2016-04-01/examples/RedisCacheForceReboot.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"responses": {
"200": {
"body": {
"Message": "reboot operation enqueued"
Copy link
Copy Markdown
Contributor

@vishrutshah vishrutshah Jan 26, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you really need this (Message) to be PascalCase?

Copy link
Copy Markdown
Member Author

@TimLovellSmith TimLovellSmith Jan 31, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added this in the example due to an unfortunate fact that it is returning pascal case on the wire today.
We did not formally document this member before the exercise with examples. In fact when we reviewed this REST API we did not document any response body. Perhaps the best thing to do here is document the API as returning an empty response, and treat the fact that RP returns a Message property as a bug?

Copy link
Copy Markdown
Member Author

@TimLovellSmith TimLovellSmith Feb 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vishrutshah my take, revised: it should never have been PascalCase but now that it is, it can't be fixed without it being breaking, so its stuck that way til next api-version.

Copy link
Copy Markdown
Contributor

@vishrutshah vishrutshah Feb 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TimLovellSmith I understand your concerns and makes sense to wait until next api-version. It's be great if you could please open and issue on that here and from your side as well, we do not miss this on next api-version.

Copy link
Copy Markdown
Member Author

@TimLovellSmith TimLovellSmith Feb 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened #935

}
}
}
Expand Down
4 changes: 4 additions & 0 deletions arm-redis/2016-04-01/examples/RedisCacheImport.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@
}
},
"responses": {
"200": {
},
"202": {
"headers": {
"location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..."
}
},
"204": {
}
}
}
60 changes: 44 additions & 16 deletions arm-redis/2016-04-01/swagger/redis.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@
"https"
],
"consumes": [
"application/json",
"text/json"
"application/json"
],
"produces": [
"application/json",
"text/json"
"application/json"
],
"security": [
{
Expand Down Expand Up @@ -80,13 +78,13 @@
],
"responses": {
"201": {
"description": "",
"description": "The new redis cache was successfully created. Check provisioningStatus to see detailed status.",
"schema": {
"$ref": "#/definitions/RedisResource"
}
},
"200": {
"description": "",
"description": "The existing redis cache was successfully updated. Check provisioningStatus to see detailed status.",
"schema": {
"$ref": "#/definitions/RedisResource"
}
Expand Down Expand Up @@ -429,10 +427,10 @@
],
"responses": {
"200": {
"description": ""
},
"204": {
"description": ""
"description": "Reboot operation successfully enqueued",
"schema": {
"$ref": "#/definitions/RedisForceRebootResponse"
}
}
}
}
Expand Down Expand Up @@ -481,7 +479,13 @@
],
"responses": {
"202": {
"description": ""
"description": "Import operation successfully enqueued; follow the Location header to poll for final outcome."
},
"200": {
"description": "Import operation succeeded."
},
"204": {
"description": "Import operation succeeded."
}
}
}
Expand Down Expand Up @@ -530,7 +534,13 @@
],
"responses": {
"202": {
"description": ""
"description": "Export operation successfully enqueued; follow the Location header to poll for final outcome."
},
"200": {
"description": "Export operation succeeded."
},
"204": {
"description": "Export operation succeeded."
}
}
}
Expand Down Expand Up @@ -578,7 +588,13 @@
],
"responses": {
"200": {
"description": "",
"description": "The patch schedule was successfully updated.",
"schema": {
"$ref": "#/definitions/RedisPatchSchedule"
}
},
"201": {
"description": "The patch schedule was successfully created.",
"schema": {
"$ref": "#/definitions/RedisPatchSchedule"
}
Expand Down Expand Up @@ -662,9 +678,6 @@
"schema": {
"$ref": "#/definitions/RedisPatchSchedule"
}
},
"404": {
"description": "Response of get patch schedules if it does not exist."
}
}
}
Expand Down Expand Up @@ -898,6 +911,11 @@
"type": "integer",
"format": "int32",
"description": "Redis SSL port."
},
"accessKeys": {
"$ref": "#/definitions/RedisAccessKeys",
"readOnly": true,
"description": "The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache"
}
},
"allOf": [
Expand Down Expand Up @@ -1109,6 +1127,16 @@
"properties"
],
"description": "Response to put/get patch schedules for Redis cache."
},
"RedisForceRebootResponse": {
"properties": {
"Message": {
Copy link
Copy Markdown
Contributor

@vishrutshah vishrutshah Jan 26, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you really need this (Message) to be PascalCase?

"readOnly": true,
"type": "string",
"description": "Status message"
}
},
"description": "Response to force reboot for Redis cache."
}
},
"parameters": {
Expand Down