switch field type to string to avoid unmarshal errors by marwanad · Pull Request #8919 · Azure/azure-rest-api-specs

marwanad · 2020-04-02T04:05:32Z

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and have all been fixed in this PR.
The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
adding/removing APIs.
adding/removing properties.
adding/removing API-version.
adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Please follow the link to find more details on API review process.

azure-pipelines · 2020-04-02T04:05:49Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-sdkautomation · 2020-04-02T04:07:03Z

azure-sdk-for-go - Release

⚠️ warning [Logs] [Expand Details]

⚠️ Generate from 01e3636 with merge commit 63284ad. SDK Automation 13.0.17.20200326.3
⚠️containerservice/mgmt/2017-07-01 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2017-08-31 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2017-09-30 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2018-03-31 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2019-02-01 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2019-04-30 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2019-06-01 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2019-08-01 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2019-10-01 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2019-11-01 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2020-01-01 [Logs]
```
No file is changed.
```
⚠️containerservice/mgmt/2020-02-01 [Logs]
```
No file is changed.
```
️✔️containerservice/mgmt/2020-03-01 [Logs] [Release SDK Changes]
- containerservice.mgmt.2020-03-01.zip
⚠️preview/containerservice/mgmt/2018-08-01-preview [Logs]
```
No file is changed.
```
⚠️preview/containerservice/mgmt/2018-09-30-preview [Logs]
```
No file is changed.
```
⚠️preview/containerservice/mgmt/2019-09-30-preview [Logs]
```
No file is changed.
```
⚠️preview/containerservice/mgmt/2019-10-27-preview [Logs]
```
No file is changed.
```

openapi-sdkautomation · 2020-04-02T04:07:03Z

azure-sdk-for-js - Release

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from 01e3636 with merge commit 63284ad. SDK Automation 13.0.17.20200326.3

️✔️@azure/arm-containerservice [Logs] [Release SDK Changes]

azure-arm-containerservice-11.0.0.tgz

[npmPack] npm WARN lifecycle @azure/arm-containerservice@11.0.0~prepack: cannot run in wd @azure/arm-containerservice@11.0.0 npm install && npm run build (wd=/z/work/azure-sdk-for-js/sdk/containerservice/arm-containerservice)

openapi-sdkautomation · 2020-04-02T04:07:05Z

azure-cli-extensions - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

openapi-sdkautomation · 2020-04-02T04:07:05Z

azure-sdk-for-python - Release

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from 01e3636 with merge commit 63284ad. SDK Automation 13.0.17.20200326.3

️✔️azure-mgmt-containerservice [Logs] [Release SDK Changes]

[after_scripts|python] WARNING:__main__:Found too much API version: {'2019-04-01', '2017-07-01'} in label v2017_07_01
[after_scripts|python] WARNING:__main__:Guessing you want 2017-07-01 based on label v2017_07_01
[build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
[build_package]   warnings.warn(msg)
[build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
[build_package]   warnings.warn(msg)
[breaking_change_setup] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
[breaking_change_setup] Cannot uninstall requirement azure-nspkg, not installed
[breaking_change_setup] Command '['/usr/local/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
[ChangeLog] Size of delta 0.244% size of original (original: 55753 chars, delta: 136 chars)
[ChangeLog]

openapi-sdkautomation · 2020-04-02T04:07:07Z

azure-sdk-for-net - Release

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from 01e3636 with merge commit 63284ad. SDK Automation 13.0.17.20200326.3
️✔️Microsoft.Azure.Management.ContainerService [Logs] [Release SDK Changes]
- Microsoft.Azure.Management.ContainerService.1.0.0-preview.nupkg
- Microsoft.Azure.Management.ContainerService.1.0.0-preview.snupkg

openapi-sdkautomation · 2020-04-02T04:07:12Z

azure-sdk-for-java - Release

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from 01e3636 with merge commit 63284ad. SDK Automation 13.0.17.20200326.3
️✔️sdk/containerservice/mgmt-v2019_06_01 [Logs] [Release SDK Changes]
️✔️sdk/containerservice/mgmt-v2019_08_01 [Logs] [Release SDK Changes]
️✔️sdk/containerservice/mgmt-v2019_10_01 [Logs] [Release SDK Changes]
️✔️sdk/containerservice/mgmt-v2019_11_01 [Logs] [Release SDK Changes]
️✔️sdk/containerservice/mgmt-v2020_01_01 [Logs] [Release SDK Changes]
️✔️sdk/containerservice/mgmt-v2020_02_01 [Logs] [Release SDK Changes]
️✔️sdk/containerservice/mgmt-v2020_03_01 [Logs] [Release SDK Changes]

azuresdkci · 2020-04-02T04:24:06Z

Can one of the admins verify this patch?

majastrz · 2020-04-02T05:12:50Z

          "type": "object",
          "properties": {
            "balance-similar-node-groups": {
-              "type": "boolean"


boolean [](start = 23, length = 7)

I discussed this over IM and while this appears to be a breaking change, this property never worked right in the service. As a result, I'm considering this more of a swagger bug fix.

From past API reviews, I recall this was basically a property bag of string properties, so coercing the bool into a string is fine here.

majastrz

Signed off from ARM side.

fengzhou-msft · 2020-04-02T07:17:38Z

@NullMDR Please check the above comment about the breaking change and force merge the PR.

PhoenixHe-NV · 2020-04-05T09:08:27Z

@akning-ms Please help to merge this PR with breaking change approved

aristosvo · 2020-04-24T22:23:13Z

@marwanad @jluk I don't understand why this is merged and not handled in the backend. The solution is now customer-facing and non-consistent with the other boolean options in the api specs.

Other than that are the other fields of the autoScaleProfile are not typed (duration, int32), but all implemented as strings. Seems like there is some room for improvement for the next release!

marwanad · 2020-04-29T20:43:36Z

@aristosvo I agree and apologize for the inconvenience. In hindsight, it would've been better to handle on the backend.

To answer your question about typing, we can't enforce Go's time.Duration in Swagger so the generated SDK would have to resort to string type. The best-case scenario would be a mix of strings with validations (for all the duration ones) and a boolean (for the balance one). Almost all the flags were durations and strings, hence the decision. We will re-evaluate this as we open up more config options.

FYI, you should be able to use v42.0.0 for the SDK which contains the fix to unblock your PR.

switch field type to string to avoid unmarshal errors

01e3636

openapi-assignment-bot Bot assigned fengzhou-msft Apr 2, 2020

xizha162 approved these changes Apr 2, 2020

View reviewed changes

majastrz reviewed Apr 2, 2020

View reviewed changes

majastrz added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Apr 2, 2020

majastrz approved these changes Apr 2, 2020

View reviewed changes

fengzhou-msft approved these changes Apr 2, 2020

View reviewed changes

PhoenixHe-NV added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Apr 5, 2020

akning-ms merged commit 63284ad into Azure:master Apr 7, 2020

aristosvo mentioned this pull request Apr 24, 2020

kubernetes_cluster - Add support for auto_scale_profile hashicorp/terraform-provider-azurerm#6620

Closed

aristosvo mentioned this pull request May 6, 2020

Enable AKS AAD integration v2 + SDK version bump hashicorp/terraform-provider-azurerm#6530

Closed

marwanad mentioned this pull request May 11, 2020

[AKS] Apply patch from 0301 API version to 0401 #9412

Merged

4 tasks

00Kai0 pushed a commit to 00Kai0/azure-rest-api-specs that referenced this pull request Oct 12, 2020

switch field type to string to avoid unmarshal errors (Azure#8919)

d13f133

Uh oh!

Conversation

marwanad commented Apr 2, 2020

Latest improvements:

Contribution checklist:

ARM API Review Checklist

Uh oh!

azure-pipelines Bot commented Apr 2, 2020

Uh oh!

openapi-sdkautomation Bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-sdk-for-go - Release

Uh oh!

openapi-sdkautomation Bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-sdk-for-js - Release

Uh oh!

openapi-sdkautomation Bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-cli-extensions - Release

Uh oh!

openapi-sdkautomation Bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-sdk-for-python - Release

Uh oh!

openapi-sdkautomation Bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-sdk-for-net - Release

Uh oh!

openapi-sdkautomation Bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-sdk-for-java - Release

Uh oh!

azuresdkci commented Apr 2, 2020

Uh oh!

majastrz Apr 2, 2020

Choose a reason for hiding this comment

Uh oh!

majastrz left a comment

Choose a reason for hiding this comment

Uh oh!

fengzhou-msft commented Apr 2, 2020

Uh oh!

PhoenixHe-NV commented Apr 5, 2020

Uh oh!

aristosvo commented Apr 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marwanad commented Apr 29, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

openapi-sdkautomation Bot commented Apr 2, 2020 •

edited

Loading

openapi-sdkautomation Bot commented Apr 2, 2020 •

edited

Loading

openapi-sdkautomation Bot commented Apr 2, 2020 •

edited

Loading

openapi-sdkautomation Bot commented Apr 2, 2020 •

edited

Loading

openapi-sdkautomation Bot commented Apr 2, 2020 •

edited

Loading

openapi-sdkautomation Bot commented Apr 2, 2020 •

edited

Loading

aristosvo commented Apr 24, 2020 •

edited

Loading