Skip to content

Comments

[Hub Generated] Review request for Microsoft.Chaos to add version preview/2023-04-15-preview#24190

Merged
tadelesh merged 1 commit intomainfrom
RenzoPrettoMS-chaos-Microsoft.Chaos-2023-04-15-preview
Jun 12, 2023
Merged

[Hub Generated] Review request for Microsoft.Chaos to add version preview/2023-04-15-preview#24190
tadelesh merged 1 commit intomainfrom
RenzoPrettoMS-chaos-Microsoft.Chaos-2023-04-15-preview

Conversation

@RenzoPrettoMS
Copy link
Contributor

@RenzoPrettoMS RenzoPrettoMS commented May 26, 2023

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Changelog

Add a changelog entry for 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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
  • 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

@openapi-workflow-bot
Copy link

Hi, @RenzoPrettoMS 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 26, 2023

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    capabilityTypes.json 2023-04-01-preview(bdb1002) 2023-04-01-preview(main)
    capabilityTypes.json 2023-04-15-preview(bdb1002) 2023-04-15-preview(main)
    Rule Message
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'azureRBACActions' renamed or removed?
    New: preview/2023-04-01-preview/types/capabilityTypes.json#L38:7
    Old: preview/2023-04-01-preview/types/capabilityTypes.json#L38:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'azureRBACDataActions' renamed or removed?
    New: preview/2023-04-01-preview/types/capabilityTypes.json#L38:7
    Old: preview/2023-04-01-preview/types/capabilityTypes.json#L38:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'azureRBACActions' renamed or removed?
    New: preview/2023-04-15-preview/types/capabilityTypes.json#L38:7
    Old: preview/2023-04-15-preview/types/capabilityTypes.json#L38:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'azureRBACDataActions' renamed or removed?
    New: preview/2023-04-15-preview/types/capabilityTypes.json#L38:7
    Old: preview/2023-04-15-preview/types/capabilityTypes.json#L38:7
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v2.1.2) new version base version
    package-2023-04-15-preview package-2023-04-15-preview(bdb1002) package-2023-04-15-preview(main)
    package-2023-04-01-preview package-2023-04-01-preview(bdb1002) package-2023-04-01-preview(main)
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 26, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-python-track2 - track2_azure-mgmt-chaos - Approved - 1.0.0b6
    +	Model Selector no longer has parameter targets
    azure-sdk-for-js - @azure/arm-chaos - Approved - 1.0.0-beta.4
    +	Interface Selector no longer has parameter targets
    +	Type of parameter selectors of interface Experiment is changed from Selector[] to SelectorUnion[]
    +	Type of parameter type of interface Selector is changed from SelectorType to "List" | "Query"
    +	Type of parameter type of interface TargetReference is changed from "ChaosTarget" to TargetReferenceType
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1b33e81. 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
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.7.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.7.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.7.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-chaos [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation ExperimentsOperations.update
      info	[Changelog]   - Model CapabilityType has a new parameter azure_rbac_actions
      info	[Changelog]   - Model CapabilityType has a new parameter azure_rbac_data_actions
      info	[Changelog]   - Model ResourceIdentity has a new parameter user_assigned_identities
      info	[Changelog]   - Model Selector has a new parameter additional_properties
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model Selector no longer has parameter targets
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1b33e81. 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
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-chaos [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1b33e81. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sdk/resourcemanager/chaos/armchaos [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `ExperimentProperties.Selectors` has been changed from `[]*Selector` to `[]SelectorClassification`
      info	[Changelog] - Type of `TargetReference.Type` has been changed from `*string` to `*TargetReferenceType`
      info	[Changelog] - `SelectorTypePercent`, `SelectorTypeRandom`, `SelectorTypeTag` from enum `SelectorType` has been removed
      info	[Changelog] - Operation `*ExperimentsClient.BeginCancel` has been changed to non-LRO, use `*ExperimentsClient.Cancel` instead.
      info	[Changelog] - Operation `*ExperimentsClient.BeginCreateOrUpdate` has been changed to non-LRO, use `*ExperimentsClient.CreateOrUpdate` instead.
      info	[Changelog] - Field `Targets` of struct `Selector` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `ResourceIdentityTypeUserAssigned` added to enum type `ResourceIdentityType`
      info	[Changelog] - New value `SelectorTypeQuery` added to enum type `SelectorType`
      info	[Changelog] - New enum type `FilterType` with values `FilterTypeSimple`
      info	[Changelog] - New enum type `TargetReferenceType` with values `TargetReferenceTypeChaosTarget`
      info	[Changelog] - New function `*ExperimentsClient.Update(context.Context, string, string, ExperimentUpdate, *ExperimentsClientUpdateOptions) (ExperimentsClientUpdateResponse, error)`
      info	[Changelog] - New function `*Filter.GetFilter() *Filter`
      info	[Changelog] - New function `*ListSelector.GetSelector() *Selector`
      info	[Changelog] - New function `*QuerySelector.GetSelector() *Selector`
      info	[Changelog] - New function `*Selector.GetSelector() *Selector`
      info	[Changelog] - New function `*SimpleFilter.GetFilter() *Filter`
      info	[Changelog] - New struct `CapabilityTypePropertiesRuntimeProperties`
      info	[Changelog] - New struct `ExperimentUpdate`
      info	[Changelog] - New struct `ListSelector`
      info	[Changelog] - New struct `QuerySelector`
      info	[Changelog] - New struct `SimpleFilter`
      info	[Changelog] - New struct `SimpleFilterParameters`
      info	[Changelog] - New struct `UserAssignedIdentity`
      info	[Changelog] - New field `AzureRbacActions`, `AzureRbacDataActions`, `Kind`, `RuntimeProperties` in struct `CapabilityTypeProperties`
      info	[Changelog] - New field `UserAssignedIdentities` in struct `ResourceIdentity`
      info	[Changelog]
      info	[Changelog] Total 8 breaking change(s), 30 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1b33e81. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-chaos [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation Experiments.update
      info	[Changelog]   - Added Interface ExperimentsUpdateOptionalParams
      info	[Changelog]   - Added Interface ExperimentUpdate
      info	[Changelog]   - Added Interface ListSelector
      info	[Changelog]   - Added Interface QuerySelector
      info	[Changelog]   - Added Interface UserAssignedIdentity
      info	[Changelog]   - Added Type Alias ExperimentsUpdateResponse
      info	[Changelog]   - Added Type Alias SelectorUnion
      info	[Changelog]   - Added Type Alias TargetReferenceType
      info	[Changelog]   - Interface CapabilityType has a new optional parameter azureRbacActions
      info	[Changelog]   - Interface CapabilityType has a new optional parameter azureRbacDataActions
      info	[Changelog]   - Interface ResourceIdentity has a new optional parameter userAssignedIdentities
      info	[Changelog]   - Added Enum KnownSelectorType
      info	[Changelog]   - Added Enum KnownTargetReferenceType
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Interface Selector no longer has parameter targets
      info	[Changelog]   - Type of parameter selectors of interface Experiment is changed from Selector[] to SelectorUnion[]
      info	[Changelog]   - Type of parameter type of interface Selector is changed from SelectorType to "List" | "Query"
      info	[Changelog]   - Type of parameter type of interface TargetReference is changed from "ChaosTarget" to TargetReferenceType
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1b33e81. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      warn	No file changes detected after generation
    • ️✔️chaos [View full logs
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 1b33e81. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
      SSL error: syscall failure: Broken pipe
      Error: SSL error: syscall failure: Broken pipe
    • ️✔️Az.chaos.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.chaos.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 26, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/chaos/armchaos https://apiview.dev/Assemblies/Review/65b72c8d508648609bd07191b8b561b1
    Java azure-resourcemanager-chaos https://apiview.dev/Assemblies/Review/05165c6d599e4e61aa919e42e06afa68
    JavaScript @azure/arm-chaos https://apiview.dev/Assemblies/Review/ee3611df0f564e05a8b7cccc091bd533

    @openapi-workflow-bot
    Copy link

    Hi @RenzoPrettoMS, 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.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @kazrael2119
    Copy link
    Member

    @msyyc @MaryGao ,please help review sdk breaking changes, thanks

    @RenzoPrettoMS
    Copy link
    Contributor Author

    Hello @kazrael2119, are we looking ok to get this PR in? I got the approval from the ARM team and it looks like msyyc also approved.

    @kazrael2119
    Copy link
    Member

    Hello @kazrael2119, are we looking ok to get this PR in? I got the approval from the ARM team and it looks like msyyc also approved.

    please wait for js sdk breaking change review, thanks

    @kazrael2119
    Copy link
    Member

    @RenzoPrettoMS ,please tell me when you want to merge this pr,thanks

    @kazrael2119 kazrael2119 added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Jun 9, 2023
    @RenzoPrettoMS
    Copy link
    Contributor Author

    @kazrael2119 At your earliest convenience, thank you!

    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 Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates Approved-SdkBreakingChange-JavaScript Approved-SdkBreakingChange-Python BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-BreakingChange-JavaScript resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    7 participants