Remove x-ms-flatten setting for resource properties #14550

tamilmani1989 · 2021-05-26T04:05:20Z

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

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2021-05-26T04:05:22Z

Hi, @tamilmani1989 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2021-05-26T04:05:23Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-05-26T04:05:23Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2021-05-26T04:05:24Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

️⌛[Staging] SDK Breaking Change Tracking pending [Detail]

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from e3aff4b. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/dnc/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.DelegatedNetwork [View full logs] [Release SDK Changes]
```
warn	Skip artifact folder because it doesn't exist: artifacts/packages
```

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from e3aff4b. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️track2_azure-mgmt-dnc [View full logs] [Release SDK Changes]
- azure-mgmt-dnc-1.0.0b1.zip
- azure_mgmt_dnc-1.0.0b1-py2.py3-none-any.whl
```
info	[Changelog]   - Initial Release
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from e3aff4b. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-05-26 07:38:36 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-delegatednetwork;1.0.0-beta.1;1.0.0-beta.2"
cmderr	[generate.py] 2021-05-26 07:38:36 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
cmderr	[generate.py] 2021-05-26 07:38:36 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.29 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/delegatednetwork/azure-resourcemanager-delegatednetwork --java.namespace=com.azure.resourcemanager.delegatednetwork   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/dnc/resource-manager/readme.md
cmderr	[generate.py] 2021-05-26 07:39:17 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-delegatednetwork
cmderr	[generate.py] 2021-05-26 07:39:17 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-05-26 07:39:17 INFO [POM][Skip] pom already has module azure-resourcemanager-delegatednetwork
cmderr	[generate.py] 2021-05-26 07:39:17 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-05-26 07:39:17 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-05-26 07:39:17 INFO [POM][Skip] pom already has module sdk/delegatednetwork
cmderr	[generate.py] 2021-05-26 07:39:17 INFO [POM][Success] Write to root pom

️✔️azure-resourcemanager-delegatednetwork [View full logs] [Release SDK Changes]

cmderr	[Inst] 2021-05-26 07:42:16 DEBUG Got artifact_id: azure-resourcemanager-delegatednetwork
cmderr	[Inst] 2021-05-26 07:42:16 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-05-26 07:42:16 DEBUG Got artifact: azure-resourcemanager-delegatednetwork-1.0.0-beta.2-javadoc.jar
cmderr	[Inst] 2021-05-26 07:42:16 DEBUG Got artifact: azure-resourcemanager-delegatednetwork-1.0.0-beta.2-sources.jar
cmderr	[Inst] 2021-05-26 07:42:16 DEBUG Got artifact: azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar
cmderr	[Inst] 2021-05-26 07:42:16 DEBUG Match jar package: azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar
cmderr	[Inst] 2021-05-26 07:42:16 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14550/azure-sdk-for-java/azure-resourcemanager-delegatednetwork/azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar\" -o azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-delegatednetwork -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
```"}

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from e3aff4b. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️delegatednetwork/mgmt/2021-03-15/delegatednetwork [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `*Orchestrator.UnmarshalJSON` has been removed
info	[Changelog] - Function `*DelegatedSubnet.UnmarshalJSON` has been removed
info	[Changelog] - Function `*DelegatedController.UnmarshalJSON` has been removed
info	[Changelog] - Field `*OrchestratorResourceProperties` of struct `Orchestrator` has been removed
info	[Changelog] - Field `*DelegatedControllerProperties` of struct `DelegatedController` has been removed
info	[Changelog] - Field `*DelegatedSubnetProperties` of struct `DelegatedSubnet` has been removed
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New field `Properties` in struct `DelegatedSubnet`
info	[Changelog] - New field `Properties` in struct `Orchestrator`
info	[Changelog] - New field `Properties` in struct `DelegatedController`
info	[Changelog]
info	[Changelog] Total 6 breaking change(s), 3 additive change(s).
info	[Changelog]

️✔️preview/delegatednetwork/mgmt/2020-08-08-preview/delegatednetwork [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `DelegatedSubnetServiceClient.DeleteDetails` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
info	[Changelog] - Function `DelegatedSubnetServiceClient.DeleteDetailsPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
info	[Changelog] - Type of `DelegatedSubnetProperties.ControllerDetails` has been changed from `*ControllerDetailsModel` to `*ControllerDetails`
info	[Changelog] - Type of `ErrorResponse.Error` has been changed from `*ErrorDefinition` to `*ErrorDetail`
info	[Changelog] - Type of `Operation.Origin` has been changed from `*string` to `Origin`
info	[Changelog] - Function `OperationListResult.MarshalJSON` has been removed
info	[Changelog] - Struct `ControllerDetailsModel` has been removed
info	[Changelog] - Struct `ErrorDefinition` has been removed
info	[Changelog] - Field `Properties` of struct `Operation` has been removed
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New const `Usersystem`
info	[Changelog] - New const `User`
info	[Changelog] - New const `Internal`
info	[Changelog] - New const `System`
info	[Changelog] - New function `PossibleOriginValues() []Origin`
info	[Changelog] - New function `PossibleActionTypeValues() []ActionType`
info	[Changelog] - New struct `ErrorAdditionalInfo`
info	[Changelog] - New struct `ErrorDetail`
info	[Changelog] - New field `ActionType` in struct `Operation`
info	[Changelog]
info	[Changelog] Total 11 breaking change(s), 11 additive change(s).
info	[Changelog]

️⚠️ azure-sdk-for-js warning [Detail]

⚠️Warning [Logs]Release - Generate from e3aff4b. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/dnc/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-05-26T04:33:43Z

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

openapi-workflow-bot · 2021-05-26T04:50:22Z

Hi @tamilmani1989, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

leni-msft · 2021-05-26T05:26:50Z

@msyyc could you check the failure of generating python sdk?

[dnc] python configuration

RAY-316 · 2021-05-26T07:32:47Z

/azp run

mikhailshilkov · 2021-05-26T19:26:15Z

Why is this not considered a breaking change? It does break any client that respects the annotation...

tamilmani1989 · 2021-05-26T19:28:21Z

hey i removed the breaking change and will create separate PR for that

weidongxu-microsoft · 2021-05-27T02:01:47Z

This is a massive breaking change!

weidongxu-microsoft · 2021-05-27T04:50:41Z

@tamilmani1989

Why this change?

mikhailshilkov · 2021-05-28T08:14:00Z

i removed the breaking change and will create separate PR for that

@tamilmani1989 any hints on when this will ship? this is blocking our integration right now.

* Disabled flatten setting for properties * added forceDelete parameter for orchestrator resource * remove forcedelete * config Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Disabled flatten setting for properties

2906309

openapi-assignment-bot bot assigned leni-msft May 26, 2021

openapi-pipeline-app bot added the CI-BreakingChange-Go label May 26, 2021

added forceDelete parameter for orchestrator resource

1b8639a

openapi-pipeline-app bot added the NewApiVersionRequired label May 26, 2021

leni-msft added the BreakingChangeReviewRequired label May 26, 2021

remove forcedelete

bb2cb13

leni-msft removed BreakingChangeReviewRequired labels May 26, 2021

openapi-pipeline-app bot added the NewApiVersionRequired label May 26, 2021

leni-msft removed the NewApiVersionRequired label May 26, 2021

openapi-pipeline-app bot added the NewApiVersionRequired label May 26, 2021

msyyc and others added 2 commits May 26, 2021 13:47

config

e6b0213

Merge pull request #1 from msyyc/python-config-2021-05-26

a85c1d0

[dnc] python configuration

tamilmani1989 requested review from 00Kai0, jsntcy, msyyc, RAY-316 and zhangyan133 as code owners May 26, 2021 05:58

openapi-sdkautomation bot mentioned this pull request May 26, 2021

[AutoPR track2_azure-mgmt-dnc] Remove x-ms-flatten setting for resource properties AzureSDKAutomation/azure-sdk-for-python#5731

Closed

leni-msft approved these changes May 26, 2021

View reviewed changes

leni-msft merged commit e3aff4b into Azure:master May 26, 2021

heaths mentioned this pull request Jun 16, 2021

Initial 2021-05-01-preview version #14855

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove x-ms-flatten setting for resource properties #14550

Remove x-ms-flatten setting for resource properties #14550

tamilmani1989 commented May 26, 2021

openapi-workflow-bot bot commented May 26, 2021

openapi-pipeline-app bot commented May 26, 2021 •

edited

Loading

openapi-workflow-bot bot commented May 26, 2021

openapi-pipeline-app bot commented May 26, 2021 •

edited

Loading

openapi-workflow-bot bot commented May 26, 2021

openapi-workflow-bot bot commented May 26, 2021

leni-msft commented May 26, 2021

RAY-316 commented May 26, 2021

mikhailshilkov commented May 26, 2021

tamilmani1989 commented May 26, 2021

weidongxu-microsoft commented May 27, 2021

weidongxu-microsoft commented May 27, 2021

mikhailshilkov commented May 28, 2021

Remove x-ms-flatten setting for resource properties #14550

Remove x-ms-flatten setting for resource properties #14550

Conversation

tamilmani1989 commented May 26, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 26, 2021

openapi-pipeline-app bot commented May 26, 2021 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented May 26, 2021

openapi-pipeline-app bot commented May 26, 2021 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented May 26, 2021

openapi-workflow-bot bot commented May 26, 2021

leni-msft commented May 26, 2021

RAY-316 commented May 26, 2021

mikhailshilkov commented May 26, 2021

tamilmani1989 commented May 26, 2021

weidongxu-microsoft commented May 27, 2021

weidongxu-microsoft commented May 27, 2021

mikhailshilkov commented May 28, 2021

openapi-pipeline-app bot commented May 26, 2021 •

edited

Loading

openapi-pipeline-app bot commented May 26, 2021 •

edited

Loading