Skip to content

Add new API version "2022-07-01-preview" for CapabilityType#19489

Merged
jianyexi merged 24 commits intoAzure:mainfrom
victoriachenm:dev-chaos-Microsoft.Chaos-2022-07-01-preview
Jul 14, 2022
Merged

Add new API version "2022-07-01-preview" for CapabilityType#19489
jianyexi merged 24 commits intoAzure:mainfrom
victoriachenm:dev-chaos-Microsoft.Chaos-2022-07-01-preview

Conversation

@victoriachenm
Copy link
Contributor

@victoriachenm victoriachenm commented Jun 16, 2022

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

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. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the 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 refresh required 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

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 appy 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
      -[x] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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, @victoriachenm 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 Jun 16, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 2 Warnings warning [Detail]
    compared swaggers (via Oad v0.9.6)] new version base version
    capabilities.json 2022-07-01(e6d71c4) 2021-09-15(main)
    capabilityTypes.json 2022-07-01(e6d71c4) 2021-09-15(main)
    experiments.json 2022-07-01(e6d71c4) 2021-09-15(main)
    operations.json 2022-07-01(e6d71c4) 2021-09-15(main)
    targetTypes.json 2022-07-01(e6d71c4) 2021-09-15(main)
    targets.json 2022-07-01(e6d71c4) 2021-09-15(main)
    capabilities.json 2022-07-01(e6d71c4) 2021-09-15(main)
    capabilityTypes.json 2022-07-01(e6d71c4) 2021-09-15(main)
    common.json 2022-07-01(e6d71c4) 2021-09-15(main)
    experiments.json 2022-07-01(e6d71c4) 2021-09-15(main)
    targetTypes.json 2022-07-01(e6d71c4) 2021-09-15(main)
    targets.json 2022-07-01(e6d71c4) 2021-09-15(main)

    The following breaking changes are detected by comparison with the latest preview version:

    Rule Message
    ⚠️ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.Chaos/preview/2022-07-01-preview/experiments.json#L211:7
    Old: Microsoft.Chaos/preview/2021-09-15-preview/experiments.json#L211:7
    ⚠️ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
    New: Microsoft.Chaos/preview/2022-07-01-preview/experiments.json#L262:7
    Old: Microsoft.Chaos/preview/2021-09-15-preview/experiments.json#L266:7
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-07-01-preview package-2022-07-01-preview(e6d71c4) default(main)

    The following errors/warnings are introduced by current PR:

    Rule Message
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Experiments_Cancel' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.Chaos/preview/2022-07-01-preview/experiments.json#L262


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Experiments_Start' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.Chaos/preview/2022-07-01-preview/experiments.json#L304
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'capabilities' with immediate parent 'target', must have a list by immediate parent operation.
    Location: preview/2022-07-01-preview/types/capabilities.json#L9
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'statuses' with immediate parent 'experiment', must have a list by immediate parent operation.
    Location: preview/2022-07-01-preview/types/experiments.json#L415
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'executionDetails' with immediate parent 'experiment', must have a list by immediate parent operation.
    Location: preview/2022-07-01-preview/types/experiments.json#L559
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: startOnCreation
    Location: preview/2022-07-01-preview/types/experiments.json#L98
    ⚠️ R3027 - TrackedResourceListByResourceGroup The tracked resource, 'experiment', must have a list by resource group operation.(This rule does not apply for tenant level resources.)
    Location: preview/2022-07-01-preview/types/experiments.json#L47
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck 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.
    ️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/e6d71c439f398686ff9902e9d89d5333cdf21aa9/specification/chaos/resource-manager/readme.md#tag-package-2022-07-01-preview">chaos/resource-manager/readme.md#package-2022-07-01-preview
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"chaos/resource-manager/readme.md",
    "tag":"package-2022-07-01-preview",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 16, 2022

    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-go - armchaos - 0.6.0
    +	Function `*ExperimentsClient.BeginCancel` has been removed
    +	Function `*ExperimentsClient.BeginCreateOrUpdate` has been removed
    +	Struct `ExperimentsClientBeginCancelOptions` has been removed
    +	Struct `ExperimentsClientBeginCreateOrUpdateOptions` has been removed
    azure-sdk-for-python-track2 - track2_azure-mgmt-chaos - Approved - 1.0.0b4
    +	Removed operation ExperimentsOperations.begin_cancel
    +	Removed operation ExperimentsOperations.begin_create_or_update
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9918d83. 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] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-chaos [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation ExperimentsOperations.cancel
      info	[Changelog]   - Added operation ExperimentsOperations.create_or_update
      info	[Changelog]   - Model CapabilityType has a new parameter kind
      info	[Changelog]   - Model CapabilityType has a new parameter runtime_properties
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Removed operation ExperimentsOperations.begin_cancel
      info	[Changelog]   - Removed operation ExperimentsOperations.begin_create_or_update
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9918d83. 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
    • ️✔️armchaos [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `*ExperimentsClient.BeginCreateOrUpdate` has been removed
      info	[Changelog] - Function `*ExperimentsClient.BeginCancel` has been removed
      info	[Changelog] - Struct `ExperimentsClientBeginCancelOptions` has been removed
      info	[Changelog] - Struct `ExperimentsClientBeginCreateOrUpdateOptions` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `*ExperimentsClient.Cancel(context.Context, string, string, *ExperimentsClientCancelOptions) (ExperimentsClientCancelResponse, error)`
      info	[Changelog] - New function `*ExperimentsClient.CreateOrUpdate(context.Context, string, string, Experiment, *ExperimentsClientCreateOrUpdateOptions) (ExperimentsClientCreateOrUpdateResponse, error)`
      info	[Changelog] - New struct `CapabilityTypePropertiesRuntimeProperties`
      info	[Changelog] - New struct `ExperimentsClientCancelOptions`
      info	[Changelog] - New struct `ExperimentsClientCreateOrUpdateOptions`
      info	[Changelog] - New field `RuntimeProperties` in struct `CapabilityTypeProperties`
      info	[Changelog] - New field `Kind` in struct `CapabilityTypeProperties`
      info	[Changelog]
      info	[Changelog] Total 6 breaking change(s), 9 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9918d83. 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
      cmderr	[automation_init.sh]  deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh]  deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9918d83. 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]  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
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9918d83. 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
    • ️✔️Az.Chaos [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 16, 2022
    @openapi-workflow-bot
    Copy link

    Hi, @victoriachenm your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-workflow-bot
    Copy link

    Hi @victoriachenm, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @zizw123
    Copy link

    zizw123 commented Jun 17, 2022

    Is every file in this PR new changes? If any of them are from previous API version, please follow this: The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" tag once you have fixed this issue.

    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 17, 2022
    This reverts commit 5095ea2.
    
    Reverting because first commit needs to be the previous API version
    @victoriachenm
    Copy link
    Contributor Author

    Hi @msyyc @BigCat20196, can you take a look at and help approve the changes? The only failing check is for SDK breaking changes, for which I will generate a new version of the SDK following the merging of these changes. Thanks!

    @msyyc
    Copy link
    Member

    msyyc commented Jun 29, 2022

    Approved for python breaking change

    @victoriachenm
    Copy link
    Contributor Author

    Approved for python breaking change

    Thanks @msyyc ! Can you help with merging the change? It looks like I am not authorized to do the merge.

    @msyyc
    Copy link
    Member

    msyyc commented Jun 30, 2022

    Approved for python breaking change

    Thanks @msyyc ! Can you help with merging the change? It looks like I am not authorized to do the merge.

    assignee is responsible to merge the pr when it is ready

    @victoriachenm
    Copy link
    Contributor Author

    @jianyexi Can you help review and merge the change?

    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Chaos/experiments/{experimentName}/cancel": {
    "post": {
    "description": "Cancel a running Experiment resource.",
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    this operatino used to have 'x-ms-longrunning-operation': true, why remove it ?

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    @jianyexi, on the server side, we don't implement this operation as a LRO, and are removing the header so that the Swagger aligns with the implementation. This was a suggestion made to us by @raych1 in a thread offline.

    @jianyexi
    Copy link
    Contributor

    jianyexi commented Jul 6, 2022

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @jianyexi
    Copy link
    Contributor

    @victoriachenm could you fix the model validation error ?

    @victoriachenm
    Copy link
    Contributor Author

    @BigCat20196 @msyyc can you help approve and merge this PR?

    @msyyc
    Copy link
    Member

    msyyc commented Jul 14, 2022

    Approved for python breaking change and please contact assignee @jianyexi to merge the PR

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-FixRequiredOnFailure

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    7 participants

    Comments