Microsoft.ApiManagement : Release api-version 2021-04-01-preview

[solankisamir]

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 langauge 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:

• 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

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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

  • 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.

• 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.

[chunyu3]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[openapi-workflow-bot]

Hi @solankisamir, 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.

[solankisamir]

@VitaliyKurokhtin we would need signoff from Breaking change reviewers for deprecating the samples property from RepresentationContract, which got removed as part of PR - #14836

See run https://github.com/Azure/azure-rest-api-specs/pull/15832/checks?check_run_id=3594297851

According to @chunyu3 that is blocking merging this PR

[solankisamir]

@chunyu3 we already got the exception as part of the PR - #15377

Do we need to request a new one?

[VitaliyKurokhtin]

Same question to @JeffreyRichter. We've already been through breaking change of replacing "sample" property with examples here #15377. This is the next version of our API should we got through breaking change process again?

[JeffreyRichter]

When I look here: https://github.com/Azure/azure-rest-api-specs/pull/15832/checks?check_run_id=3594297851
I see lots of breaking changes. What is the justification for these breaks?

[solankisamir]

@JeffreyRichter I can only see 1 breaking change

[JeffreyRichter]

Technically, the type changes are also breaking but we tend to allow changes from nothing to object.

But removing a property is breaking.

[VitaliyKurokhtin]

Here is timeline:

• In 2020-12-01 we have property "sample".
• in 2021-01-01-preview it was removed by Spec fixed to reflect new examples property #15377 (breaking change)
• In this 2021-04-01-preview automation compares it to previous stable (2020-12-01) and sees same breaking change from second point.

How should we handle multiple consecutive -preview versions where each has same breaking change?

[JeffreyRichter]

OK, I approved the PR. I dont' think there is a way to stop getting flagged with breaking changes until this comes out of preview.

[chunyu3]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[chunyu3]

Contact with @zhenglaizhang , we can ignore 'swagger ApiDocPreview' failure since apimanagement can re configure operation group in their prod rest doc generation.