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

fix(breaking): web/resource-manager/Microsoft.Web/AppServiceEnvironments #4508

Closed
wants to merge 1 commit into from
Closed

fix(breaking): web/resource-manager/Microsoft.Web/AppServiceEnvironments #4508

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
8 changes: 4 additions & 4 deletions ...fication/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1885,7 +1885,7 @@
}
},
"AppServiceEnvironmentPatchResource": {
"description": "ARM resource for a app service enviroment.",
"description": "ARM resource for a app service environment.",
"type": "object",
"allOf": [
{
Expand Down Expand Up @@ -1924,13 +1924,13 @@
"description": "Name/identifier of the diagnostics.",
"type": "string"
},
"diagnosicsOutput": {
"diagnosticsOutput": {
Copy link
Contributor

Choose a reason for hiding this comment

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

@nschonni - Any reason to make a breaking change in an already deployed api-version? Have you already deployed this change? This will make it increasingly difficult for customers to using Azure stack. I would expect you to not touch the old api version and make a breaking change in the new api version (which is the definition of a breaking change).

Copy link
Contributor

Choose a reason for hiding this comment

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

What happens if customers would send a request with old property names for api version 2016-09-01? Does the service alias both the property names on it's side?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No idea how the previous versions work or if there is a redirect functionality available in the API to forward the requests to the other endpoint. I think I'm going to move the "environment" fix to a separate PR since that part is straight forward.

Copy link
Contributor

Choose a reason for hiding this comment

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

@naveedaz - Can you take a look at this?

Copy link
Contributor

Choose a reason for hiding this comment

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

@nschonni What is the motivation to change the names of the properties? It is unfortunate that the property names have spelling issues but we cannot simply change it in the swagger file because the service will still send them with the misspelled names and then these properties will not be deserialized on the client end at all.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixing typo stuff on the documentation that lead me up to this repo through the sdk ones.
If you want to file bugs to fix this in the next version, that's fine with me.

"description": "Diagnostics output.",
"type": "string"
}
}
},
"MetricAvailabilily": {
"MetricAvailability": {
"description": "Metric availability and retention.",
"type": "object",
"properties": {
Expand Down Expand Up @@ -1975,7 +1975,7 @@
"description": "List of time grains supported for the metric together with retention period.",
"type": "array",
"items": {
"$ref": "#/definitions/MetricAvailabilily"
"$ref": "#/definitions/MetricAvailability"
},
"readOnly": true
},
Expand Down
8 changes: 4 additions & 4 deletions ...fication/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2132,7 +2132,7 @@
}
},
"AppServiceEnvironmentPatchResource": {
"description": "ARM resource for a app service enviroment.",
"description": "ARM resource for a app service environment.",
"type": "object",
"allOf": [
{
Expand Down Expand Up @@ -2171,13 +2171,13 @@
"description": "Name/identifier of the diagnostics.",
"type": "string"
},
"diagnosicsOutput": {
"diagnosticsOutput": {
"description": "Diagnostics output.",
"type": "string"
}
}
},
"MetricAvailabilily": {
"MetricAvailability": {
"description": "Metric availability and retention.",
"type": "object",
"properties": {
Expand Down Expand Up @@ -2217,7 +2217,7 @@
"description": "List of time grains supported for the metric together with retention period.",
"type": "array",
"items": {
"$ref": "#/definitions/MetricAvailabilily"
"$ref": "#/definitions/MetricAvailability"
},
"readOnly": true
},
Expand Down