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

Jump to bottom

Fixed order of operations parameters #13077

Merged
merged 1 commit into from
Feb 22, 2021
Merged

Fixed order of operations parameters #13077

merged 1 commit into from
Feb 22, 2021

Conversation

rononiwu
Copy link
Contributor

@rononiwu rononiwu commented Feb 21, 2021 •
edited
Loading

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
    • 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, @rononiwu 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
    Copy link

    openapi-pipeline-app bot commented Feb 21, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]

    Rule Message
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'origin' in response that was not found in the old version.
    New: Microsoft.MixedReality/preview/2021-03-01-preview/proxy.json#L162:7
    Old: Microsoft.MixedReality/preview/2021-03-01-preview/proxy.json#L162:7
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'properties' in response that was not found in the old version.
    New: Microsoft.MixedReality/preview/2021-03-01-preview/proxy.json#L162:7
    Old: Microsoft.MixedReality/preview/2021-03-01-preview/proxy.json#L162:7
    ️⚠️LintDiff: 1 Warnings warning [Detail]

    Rule Message
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.MixedReality/preview/2021-03-01-preview/proxy.json#L179
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️🔄[Staging] SDK Track2 Validation inProgress [Detail]
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 21, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️🔄 azure-sdk-for-java inProgress [Detail]
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2df8b07. 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
    • ️✔️azure-mgmt-mixedreality [View full logs]  [Release SDK Changes] 
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group ObjectAnchorsAccountsOperations
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2df8b07. 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
    • ️✔️mixedreality/mgmt/2021-01-01/mixedreality [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️preview/mixedreality/mgmt/2021-03-01-preview/mixedreality [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Struct `Properties` has been removed
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New struct `OperationProperties`
info	[Changelog] - New field `Origin` in struct `Operation`
info	[Changelog] - New field `Properties` in struct `Operation`
info	[Changelog]
info	[Changelog] Total 2 breaking change(s), 3 additive change(s).
info	[Changelog]
    • ️✔️preview/mixedreality/mgmt/2020-05-01-preview/mixedreality [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 30 items here, please refer to log for details.
      info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New const `Key`
info	[Changelog] - New const `ManagedIdentity`
info	[Changelog] - New const `Application`
info	[Changelog] - New const `User`
info	[Changelog] - New function `AccountProperties.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `PossibleCreatedByTypeValues() []CreatedByType`
info	[Changelog] - New struct `LogSpecification`
info	[Changelog] - New struct `MetricDimension`
info	[Changelog] - New struct `MetricSpecification`
info	[Changelog] - New struct `OperationProperties`
info	[Changelog] - New struct `ServiceSpecification`
info	[Changelog] - New struct `SystemData`
info	[Changelog] - New field `Identity` in struct `SpatialAnchorsAccount`
info	[Changelog] - New field `Plan` in struct `SpatialAnchorsAccount`
info	[Changelog] - New field `Sku` in struct `SpatialAnchorsAccount`
info	[Changelog] - New field `Kind` in struct `SpatialAnchorsAccount`
info	[Changelog] - New field `SystemData` in struct `SpatialAnchorsAccount`
info	[Changelog] - New field `Properties` in struct `Operation`
info	[Changelog] - New field `IsDataAction` in struct `Operation`
info	[Changelog] - New field `Origin` in struct `Operation`
info	[Changelog] - New field `StorageAccountName` in struct `AccountProperties`
info	[Changelog] - New field `Kind` in struct `RemoteRenderingAccount`
info	[Changelog] - New field `Sku` in struct `RemoteRenderingAccount`
info	[Changelog] - New field `SystemData` in struct `RemoteRenderingAccount`
info	[Changelog] - New field `Plan` in struct `RemoteRenderingAccount`
info	[Changelog]
info	[Changelog] Total 8 breaking change(s), 22 additive change(s).
info	[Changelog]
    • ️✔️preview/mixedreality/mgmt/2019-02-28/mixedreality [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2df8b07. Schema Automation 14.0.0 
      warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/mixedreality/resource-manager/readme.md
    • ️✔️mixedreality [View full logs]  [Release Schema Changes] 
      cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN
cmderr	[resource-manager] Using request for node-pre-gyp https download
cmderr	[resource-manager]  WARN template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2df8b07. 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/mixedreality/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.MixedReality [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2df8b07. 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/mixedreality/resource-manager/readme.md
    • ️✔️@azure/arm-mixedreality [View full logs]  [Release SDK Changes] 
      cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/mixedRealityClient.js → ./dist/arm-mixedreality.js...
cmderr	[npmPack] created ./dist/arm-mixedreality.js in 336ms
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    This was referenced Feb 21, 2021
    Closed
    Closed
    Closed
    @rononiwu
    Copy link
    Contributor Author

    Fixing issue related to this comment by @JonathanCrd in this PR

    @rononiwu rononiwu mentioned this pull request Feb 21, 2021
    Merged
    11 tasks
    This was referenced Feb 21, 2021
    Closed
    Closed
    @leni-msft leni-msft added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 22, 2021
    @leni-msft leni-msft merged commit 2df8b07 into Azure:master Feb 22, 2021
    This was referenced Feb 22, 2021
    Closed
    Closed
    Closed
    Closed
    Merged
    Closed
    Closed
    Closed
    Closed
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @rononiwu @raonon @mkarmark
    Fixed order of operations parameters (Azure#13077)
    ad26bf9 
    Co-authored-by: Raymond Ononiwu <raonon@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @vriveras vriveras vriveras approved these changes

    @allenjzhang allenjzhang Awaiting requested review from allenjzhang

    @JonathanCrd JonathanCrd Awaiting requested review from JonathanCrd

    Assignees

    @leni-msft leni-msft

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @rononiwu @vriveras @leni-msft @raonon