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.

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

Force delete optional parameter for orchestrator resource #14718

Merged
merged 1 commit into from
Jun 10, 2021

Conversation

tamilmani1989
Copy link
Member

@tamilmani1989 tamilmani1989 commented Jun 8, 2021

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.

  1. 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
  2. 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.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. 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:

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
Copy link

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-workflow-bot
    Copy link

    [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
    Copy link

    openapi-pipeline-app bot commented Jun 8, 2021

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    1043 - AddingOptionalParameter The optional parameter 'forceDelete' was added in the new version.
    New: Microsoft.DelegatedNetwork/stable/2021-03-15/orchestrators.json#L145:9
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    R4009 - RequiredReadOnlySystemData The response of operation:'Controller_GetDetails' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.DelegatedNetwork/stable/2021-03-15/controller.json#L38
    R4009 - RequiredReadOnlySystemData The response of operation:'OrchestratorInstanceService_GetDetails' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.DelegatedNetwork/stable/2021-03-15/orchestrators.json#L38
    R4009 - RequiredReadOnlySystemData The response of operation:'DelegatedSubnetService_GetDetails' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.DelegatedNetwork/stable/2021-03-15/delegatedSubnets.json#L38
    R4009 - RequiredReadOnlySystemData The response of operation:'Controller_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.DelegatedNetwork/stable/2021-03-15/controller.json#L78
    R4009 - RequiredReadOnlySystemData The response of operation:'OrchestratorInstanceService_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.DelegatedNetwork/stable/2021-03-15/orchestrators.json#L78
    R4009 - RequiredReadOnlySystemData The response of operation:'DelegatedSubnetService_PutDetails' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.DelegatedNetwork/stable/2021-03-15/delegatedSubnets.json#L78
    R4009 - RequiredReadOnlySystemData The response of operation:'Controller_Patch' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.DelegatedNetwork/stable/2021-03-15/controller.json#L178
    R4009 - RequiredReadOnlySystemData The response of operation:'OrchestratorInstanceService_Patch' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.DelegatedNetwork/stable/2021-03-15/orchestrators.json#L181
    R4009 - RequiredReadOnlySystemData The response of operation:'DelegatedSubnetService_PatchDetails' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.DelegatedNetwork/stable/2021-03-15/delegatedSubnets.json#L134
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'DelegatedSubnetService_PutDetails' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.DelegatedNetwork/stable/2021-03-15/delegatedSubnets.json#L88
    ️️✔️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

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"dnc/resource-manager/readme.md",
    "tag":"package-2021-03-15",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"dnc/resource-manager/readme.md",
    "tag":"package-2021-03-15",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"dnc/resource-manager/readme.md",
    "tag":"package-2021-03-15",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 8, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-dnc - first release
    azure-sdk-for-go - delegatednetwork/mgmt/2021-03-15/delegatednetwork - v55.1.0
    +	Function `OrchestratorInstanceServiceClient.DeletePreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    +	Function `OrchestratorInstanceServiceClient.Delete` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    azure-sdk-for-go - preview/delegatednetwork/mgmt/2020-08-08-preview/delegatednetwork - v55.1.0
    +	Field `Properties` of struct `Operation` has been removed
    +	Function `DelegatedSubnetServiceClient.DeleteDetailsPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    +	Function `DelegatedSubnetServiceClient.DeleteDetails` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
    +	Function `ErrorDefinition.MarshalJSON` has been removed
    +	Struct `ControllerDetailsModel` has been removed
    +	Struct `ErrorDefinition` has been removed
    +	Type of `DelegatedSubnetProperties.ControllerDetails` has been changed from `*ControllerDetailsModel` to `*ControllerDetails`
    +	Type of `ErrorResponse.Error` has been changed from `*ErrorDefinition` to `*ErrorDetail`
    +	Type of `Operation.Origin` has been changed from `*string` to `Origin`
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a33ba1f. 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 a33ba1f. 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]
      info	[Changelog]   - Initial Release
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a33ba1f. 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-06-10 05:59:05 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-06-10 05:59:05 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-06-10 05:59:05 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-06-10 05:59:32 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-delegatednetwork
      cmderr	[generate.py] 2021-06-10 05:59:32 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-06-10 05:59:32 INFO [POM][Skip] pom already has module azure-resourcemanager-delegatednetwork
      cmderr	[generate.py] 2021-06-10 05:59:32 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-06-10 05:59:32 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-06-10 05:59:32 INFO [POM][Skip] pom already has module sdk/delegatednetwork
      cmderr	[generate.py] 2021-06-10 05:59:32 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-delegatednetwork [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-06-10 06:01:38 DEBUG Got artifact_id: azure-resourcemanager-delegatednetwork
      cmderr	[Inst] 2021-06-10 06:01:38 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-06-10 06:01:38 DEBUG Got artifact: azure-resourcemanager-delegatednetwork-1.0.0-beta.2-javadoc.jar
      cmderr	[Inst] 2021-06-10 06:01:38 DEBUG Got artifact: azure-resourcemanager-delegatednetwork-1.0.0-beta.2-sources.jar
      cmderr	[Inst] 2021-06-10 06:01:38 DEBUG Got artifact: azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-06-10 06:01:38 DEBUG Match jar package: azure-resourcemanager-delegatednetwork-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-06-10 06:01:38 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14718/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 a33ba1f. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../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 `OrchestratorInstanceServiceClient.DeletePreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog] - Function `OrchestratorInstanceServiceClient.Delete` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog]
      info	[Changelog] Total 2 breaking change(s), 0 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.DeleteDetailsPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      info	[Changelog] - Function `DelegatedSubnetServiceClient.DeleteDetails` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, *bool)`
      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] - Type of `DelegatedSubnetProperties.ControllerDetails` has been changed from `*ControllerDetailsModel` to `*ControllerDetails`
      info	[Changelog] - Function `ErrorDefinition.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 `System`
      info	[Changelog] - New const `Internal`
      info	[Changelog] - New function `PossibleActionTypeValues() []ActionType`
      info	[Changelog] - New function `ErrorAdditionalInfo.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PossibleOriginValues() []Origin`
      info	[Changelog] - New function `ErrorDetail.MarshalJSON() ([]byte, error)`
      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), 13 additive change(s).
      info	[Changelog]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a33ba1f. 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.6.0 --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
    Copy link

    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.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jun 9, 2021
    Copy link
    Contributor

    @j5lim j5lim left a comment

    Choose a reason for hiding this comment

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

    Please work with the PR assignee to get it merged.

    @tamilmani1989
    Copy link
    Member Author

    @PhoenixHe-msft can you please approve and merge?

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants