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

add AVS 2021-06-01 API #14215

Merged
merged 4 commits into from
May 18, 2021
Merged

add AVS 2021-06-01 API #14215

merged 4 commits into from
May 18, 2021

Conversation

ctaggart
Copy link
Contributor

@ctaggart ctaggart commented May 3, 2021

This is a new Microsoft.AVS API version. It is a copy of what was last internally reviewed here.

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

openapi-pipeline-app bot commented May 3, 2021

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.

️️✔️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: 22 Errors, 8 Warnings failed [Detail]
The following breaking changes are detected by comparison with the latest stable version:
Rule Message
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5133:9
Old: Microsoft.AVS/stable/2020-03-20/vmware.json#L1721:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5133:9
Old: Microsoft.AVS/stable/2020-03-20/vmware.json#L1721:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5262:9
Old: Microsoft.AVS/stable/2020-03-20/vmware.json#L1843:9
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5333:5
Old: Microsoft.AVS/stable/2020-03-20/vmware.json#L1870:5
⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5344:5
Old: Microsoft.AVS/stable/2020-03-20/vmware.json#L1901:5


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

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

Rule Message
1008 - ModifiedOperationId The operation id has been changed from 'Datastores_Create' to 'Datastores_CreateOrUpdate'. This will impact generated code.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L1113:7
Old: Microsoft.AVS/preview/2021-01-01-preview/vmware.json#L1042:7
1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5397:9
Old: Microsoft.AVS/preview/2021-01-01-preview/vmware.json#L4472:9
1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5404:5
Old: Microsoft.AVS/preview/2021-01-01-preview/vmware.json#L4499:5
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'nfsProviderIp' renamed or removed?
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5582:7
Old: Microsoft.AVS/preview/2021-01-01-preview/vmware.json#L4629:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'nfsFilePath' renamed or removed?
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5582:7
Old: Microsoft.AVS/preview/2021-01-01-preview/vmware.json#L4629:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'endpoints' renamed or removed?
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5594:7
Old: Microsoft.AVS/preview/2021-01-01-preview/vmware.json#L4642:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'licenseKey' renamed or removed?
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5407:7
Old: Microsoft.AVS/preview/2021-01-01-preview/vmware.json#L4506:7
1034 - AddedRequiredProperty The new version has new required property 'id' that was not found in the old version.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5582:7
Old: Microsoft.AVS/preview/2021-01-01-preview/vmware.json#L4629:7
1034 - AddedRequiredProperty The new version has new required property 'id' that was not found in the old version.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5570:9
Old: Microsoft.AVS/preview/2021-01-01-preview/vmware.json#L4617:9
1034 - AddedRequiredProperty The new version has new required property 'targetId' that was not found in the old version.
New: Microsoft.AVS/stable/2021-06-01/vmware.json#L5594:7
Old: Microsoft.AVS/preview/2021-01-01-preview/vmware.json#L4642:7
️️✔️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":"vmware/resource-manager/readme.md",
"tag":"package-2021-06-01",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"vmware/resource-manager/readme.md",
"tag":"package-2021-06-01",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"vmware/resource-manager/readme.md",
"tag":"package-2021-06-01",
"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-workflow-bot
Copy link

Hi, @ctaggart 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 3, 2021

    Swagger pipeline restarted successfully, please wait for status update in this comment.

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

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

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

    ctaggart commented May 5, 2021

    I'm moving this to draft for a few days until we have complete test coverage of the API spec through the Azure SDK for .NET at Azure/azure-sdk-for-net#20836.

    @ctaggart ctaggart marked this pull request as draft May 5, 2021 23:57
    @ArcturusZhang
    Copy link
    Member

    @ctaggart please let me know when this is ready to review, thank you!

    @ctaggart ctaggart marked this pull request as ready for review May 13, 2021 17:58
    @ctaggart
    Copy link
    Contributor Author

    Hey @ArcturusZhang, this is ready for review. We've completed our test coverage.

    @ArcturusZhang ArcturusZhang added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 18, 2021
    @ArcturusZhang
    Copy link
    Member

    We have gotten the ARM's sign off in https://github.com/Azure/azure-rest-api-specs-pr/pull/3018

    @ArcturusZhang ArcturusZhang merged commit 1d53085 into master May 18, 2021
    @ctaggart ctaggart deleted the AVS/2021-06 branch May 18, 2021 13:56
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * add AVS 2021-06-01 API
    
    * add cmdlets custom word
    
    * rename ScriptCmdlet cmdletDescription to description (Azure#14218)
    
    * Adding optional to the script parameter (Azure#14437)
    
    Co-authored-by: David Becher <[email protected]>
    
    Co-authored-by: david becher <[email protected]>
    Co-authored-by: David Becher <[email protected]>
    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 CI-BreakingChange-Python
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants