Skip to content

Additional 7.3-preview parameter name clean up #13913

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
Merged
heaths merged 1 commit into from
Apr 16, 2021
Merged

Additional 7.3-preview parameter name clean up #13913

heaths merged 1 commit into from
Apr 16, 2021

Conversation

@herveyw-msft
Copy link
Contributor

@herveyw-msft herveyw-msft commented Apr 13, 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
    • 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-workflow-bot
Copy link

openapi-workflow-bot bot commented Apr 13, 2021

Hi, @herveyw-msft 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-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Apr 13, 2021

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

    openapi-pipeline-app bot commented Apr 13, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 8 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1165:9
    Old: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1165:9
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'kek' renamed or removed?
    New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1678:7
    Old: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1678:7
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'env' renamed or removed?
    New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1705:7
    Old: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1704:7
    ❌ 1034 - AddedRequiredProperty The new version has new required property 'target' that was not found in the old version.
    New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1705:7
    Old: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1704:7
    ❌ 1034 - AddedRequiredProperty The new version has new required property 'target' that was not found in the old version.
    New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L897:13
    Old: Microsoft.KeyVault/preview/7.3-preview/keys.json#L897:13
    ❌ 1034 - AddedRequiredProperty The new version has new required property 'target' that was not found in the old version.
    New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1704:5
    Old: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1703:5
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'wrappingKey' that was not found in the old version.
    New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1678:7
    Old: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1678:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'wrappingKid' that was not found in the old version.
    New: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1678:7
    Old: Microsoft.KeyVault/preview/7.3-preview/keys.json#L1678:7
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ❌ R2005 - LongRunningResponseStatusCode A 'PUT' operation 'FullRestoreOperation' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Microsoft.KeyVault/preview/7.3-preview/backuprestore.json#L131
    ❌ R2005 - LongRunningResponseStatusCode A 'PUT' operation 'SelectiveKeyRestoreOperation' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201.
    Location: Microsoft.KeyVault/preview/7.3-preview/backuprestore.json#L226
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KeyVault/preview/7.3-preview/rbac.json#L477
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KeyVault/preview/7.3-preview/rbac.json#L519
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KeyVault/preview/7.3-preview/rbac.json#L531
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'CreateCertificate' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.KeyVault/preview/7.3-preview/certificates.json#L458
    ️️✔️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 BreakingChange (Base on preview version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️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 succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"keyvault/data-plane/readme.md",
    "tag":"package-preview-7.3-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"keyvault/data-plane/readme.md",
    "tag":"package-preview-7.3-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"keyvault/data-plane/readme.md",
    "tag":"package-preview-7.3-preview",
    "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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 13, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 57a86eb. 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
    • ️✔️keyvault/v7.1/keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️keyvault/v7.0/keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️keyvault/2016-10-01/keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️keyvault/2015-06-01/keyvault [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️preview/keyvault/v7.2-preview/keyvault [View full logs]  [Release SDK Changes] Breaking Change Detected
      Only show 24 items here, please refer to log for details.
      info	[Changelog] - New function `RoleDefinitionsClient.CreateOrUpdate(context.Context, string, string, string, RoleDefinitionCreateParameters) (RoleDefinition, error)`
info	[Changelog] - New function `HSMSecurityDomainClient.DownloadPendingResponder(*http.Response) (SecurityDomainOperationStatus, error)`
info	[Changelog] - New function `RoleDefinitionsClient.CreateOrUpdateSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `HSMSecurityDomainClient.DownloadPendingPreparer(context.Context, string) (*http.Request, error)`
info	[Changelog] - New function `RoleDefinitionsClient.CreateOrUpdateResponder(*http.Response) (RoleDefinition, error)`
info	[Changelog] - New function `RoleDefinitionsClient.DeleteSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `HSMSecurityDomainClient.DownloadPendingSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `PossibleDataActionValues() []DataAction`
info	[Changelog] - New function `PossibleRoleDefinitionTypeValues() []RoleDefinitionType`
info	[Changelog] - New function `RoleDefinitionsClient.GetResponder(*http.Response) (RoleDefinition, error)`
info	[Changelog] - New function `RoleDefinitionsClient.Delete(context.Context, string, string, string) (RoleDefinition, error)`
info	[Changelog] - New function `RoleDefinitionsClient.GetPreparer(context.Context, string, string, string) (*http.Request, error)`
info	[Changelog] - New function `RoleDefinitionsClient.DeletePreparer(context.Context, string, string, string) (*http.Request, error)`
info	[Changelog] - New function `PossibleRoleScopeValues() []RoleScope`
info	[Changelog] - New struct `HSMSecurityDomainDownloadFuture`
info	[Changelog] - New struct `RoleDefinitionCreateParameters`
info	[Changelog] - New field `Value` in struct `SecurityDomainObject`
info	[Changelog] - New anonymous field `autorest.Response` in struct `RoleDefinition`
info	[Changelog] - New field `Iv` in struct `KeyOperationResult`
info	[Changelog] - New field `AuthenticationTag` in struct `KeyOperationResult`
info	[Changelog] - New field `AdditionalAuthenticatedData` in struct `KeyOperationResult`
info	[Changelog]
info	[Changelog] Total 41 breaking change(s), 62 additive change(s).
info	[Changelog]
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Apr 13, 2021

    Hi @herveyw-msft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
     If you need further help, please feedback via swagger feedback."

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Apr 13, 2021

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

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Apr 13, 2021

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    heaths
    heaths approved these changes Apr 13, 2021
    View reviewed changes
    specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json Outdated
    Copy link
    Member

    @heaths heaths Apr 13, 2021

    Choose a reason for hiding this comment

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

    Weren't you getting rid of this anyway?

    @heaths
    Copy link
    Member

    heaths commented Apr 15, 2021

    @JeffreyRichter given this is currently status quo for Key Vault to update previews in-place (we're discussing alternative processes post-7.3), can you approve this breaking change? We need to get this in ASAP.

    Or, @lmazuel are you able to override as in the past for Key Vault?

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Apr 15, 2021
    @JeffreyRichter
    Copy link
    Member

    JeffreyRichter commented Apr 15, 2021 via email

    @heaths
    Copy link
    Member

    heaths commented Apr 15, 2021

    @lmazuel the azure-sdk-for-go error seems unrelated. Can this be merged regardless?

    11:22:33.633 cmderr 	[main.go] Summarying all the generation metadata in '/home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/services'...
11:22:34.852 cmderr 	[main.go] Error: cannot open file /home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/services/classic/management/affinitygroup/CHANGELOG.md: open /home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/services/classic/management/affinitygroup/CHANGELOG.md: no such file or directory
11:22:34.853 cmderr E 	[main.go] [ERROR] cannot open file /home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/services/classic/management/affinitygroup/CHANGELOG.md: open /home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/services/classic/management/affinitygroup/CHANGELOG.md: no such file or directory

    @heaths heaths mentioned this pull request Apr 15, 2021
    Closed
    @mccoyp mccoyp mentioned this pull request Apr 15, 2021
    Merged
    @ArcturusZhang
    Copy link
    Member

    ArcturusZhang commented Apr 16, 2021

    /azp run

    @azure-pipelines
    Copy link

    azure-pipelines bot commented Apr 16, 2021

    Azure Pipelines successfully started running 2 pipeline(s).

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

    Reviewers

    @heaths heaths heaths approved these changes

    @JeffreyRichter JeffreyRichter JeffreyRichter approved these changes

    @jlichwa jlichwa Awaiting requested review from jlichwa

    @RandalliLama RandalliLama Awaiting requested review from RandalliLama

    Assignees

    @tjprescott tjprescott

    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.

    5 participants

    @herveyw-msft @heaths @JeffreyRichter @ArcturusZhang @tjprescott