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

[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2022-07-01 #22212

Merged
merged 2 commits into from
Jan 23, 2023

Conversation

rahulalapati43
Copy link
Contributor

@rahulalapati43 rahulalapati43 commented Jan 17, 2023

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

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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
      -[x] 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.
  • 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, @rahulalapati43 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 Jan 17, 2023

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    keys.json 2022-07-01(b395f46) 2022-07-01(main)
    Rule Message
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.KeyVault/stable/2022-07-01/keys.json#L482:9
    Old: Microsoft.KeyVault/stable/2022-07-01/keys.json#L482:9
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2022-07 package-2022-07(b395f46) package-2022-07(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    AllResourcesMustHaveDelete The resource Key does not have a corresponding delete operation.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L13
    TrackedResourcePatchOperation Tracked resource 'Key' must have patch operation that at least supports the update of tags.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L13
    DefinitionsPropertiesNamesCamelCase Property name should be camel case.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L428
    XmsParameterLocation The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L646
    XmsParameterLocation The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L653
    ⚠️ PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Keys_CreateIfNotExist' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema'
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L14
    ⚠️ RequiredReadOnlySystemData The response of operation:'Keys_CreateIfNotExist' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L14
    ⚠️ RequiredReadOnlySystemData The response of operation:'Keys_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L86
    ⚠️ RequiredReadOnlySystemData The response of operation:'Keys_GetVersion' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L211
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L438
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L482
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L500
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L548
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L565
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L586
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L599
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L612
    ⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L629
    ️️✔️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.

    ️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️~[Staging] CadlAPIView 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.
    ️️✔️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 Jan 17, 2023

    Swagger Generation Artifacts

    ️🔄ApiDocPreview inProgress [Detail]
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking


    ️⚠️ azure-sdk-for-net-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4d5da4e. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
      warn	No file changes detected after generation
    • ️✔️Azure.ResourceManager.KeyVault [View full logs
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4d5da4e. 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 major version of npm available! 8.19.3 -> 9.3.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.3.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.3.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-keyvault [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model ManagedHsmProperties has a new parameter security_domain_properties
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4d5da4e. 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/keyvault/armkeyvault [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Struct `CloudError` has been removed
      info	[Changelog] - Struct `CloudErrorBody` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `JSONWebKeyOperationRelease` added to type alias `JSONWebKeyOperation`
      info	[Changelog] - New value `KeyPermissionsGetrotationpolicy`, `KeyPermissionsRelease`, `KeyPermissionsRotate`, `KeyPermissionsSetrotationpolicy` added to type alias `KeyPermissions`
      info	[Changelog] - New type alias `ActivationStatus` with values `ActivationStatusActive`, `ActivationStatusFailed`, `ActivationStatusNotActivated`, `ActivationStatusUnknown`
      info	[Changelog] - New type alias `KeyRotationPolicyActionType` with values `KeyRotationPolicyActionTypeNotify`, `KeyRotationPolicyActionTypeRotate`
      info	[Changelog] - New function `*ManagedHsmsClient.CheckMhsmNameAvailability(context.Context, CheckMhsmNameAvailabilityParameters, *ManagedHsmsClientCheckMhsmNameAvailabilityOptions) (ManagedHsmsClientCheckMhsmNameAvailabilityResponse, error)`
      info	[Changelog] - New struct `Action`
      info	[Changelog] - New struct `CheckMhsmNameAvailabilityParameters`
      info	[Changelog] - New struct `CheckMhsmNameAvailabilityResult`
      info	[Changelog] - New struct `KeyReleasePolicy`
      info	[Changelog] - New struct `KeyRotationPolicyAttributes`
      info	[Changelog] - New struct `LifetimeAction`
      info	[Changelog] - New struct `ManagedHSMSecurityDomainProperties`
      info	[Changelog] - New struct `RotationPolicy`
      info	[Changelog] - New struct `Trigger`
      info	[Changelog] - New field `ReleasePolicy` in struct `KeyProperties`
      info	[Changelog] - New field `RotationPolicy` in struct `KeyProperties`
      info	[Changelog] - New field `Etag` in struct `MHSMPrivateEndpointConnectionItem`
      info	[Changelog] - New field `ID` in struct `MHSMPrivateEndpointConnectionItem`
      info	[Changelog] - New field `SecurityDomainProperties` in struct `ManagedHsmProperties`
      info	[Changelog]
      info	[Changelog] Total 4 breaking change(s), 35 additive change(s).
    ️❌ azure-sdk-for-js failed [Detail]
    • Code Generator Failed [Logs]Release - Generate from 4d5da4e. 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
      cmderr	[automation_generate.sh] [ERROR] An error occurred while generating codes for readme file: "specification/keyvault/resource-manager/readme.md":
      cmderr	[automation_generate.sh] [ERROR] Err: Error: Command failed: autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/keyvault/resource-manager/readme.md --use=@autorest/typescript@6.0.0-rc.5
      cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
      cmderr	[automation_generate.sh] [ERROR] Stdout: "null"
      cmderr	[automation_generate.sh] [ERROR] ErrorStack: "Error: Command failed: autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/keyvault/resource-manager/readme.md --use=@autorest/typescript@6.0.0-rc.5
      cmderr	[automation_generate.sh] [ERROR]     at checkExecSyncError (node:child_process:861:11)
      cmderr	[automation_generate.sh] [ERROR]     at Object.execSync (node:child_process:932:15)
      cmderr	[automation_generate.sh] [ERROR]     at Object.<anonymous> (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:39:33)
      cmderr	[automation_generate.sh] [ERROR]     at Generator.next (<anonymous>)
      cmderr	[automation_generate.sh] [ERROR]     at /opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:115:75
      cmderr	[automation_generate.sh] [ERROR]     at new Promise (<anonymous>)
      cmderr	[automation_generate.sh] [ERROR]     at Object.__awaiter (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:111:16)
      cmderr	[automation_generate.sh] [ERROR]     at Object.generateMgmt (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:20:20)
      cmderr	[automation_generate.sh] [ERROR]     at /opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/autoGenerateInPipeline.js:43:34"
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js]: sh .scripts/automation_generate.sh
      warn	Skip package processing as generation is failed
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4d5da4e. 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
    • ️✔️keyvault [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from 4d5da4e. 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.keyvault [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 17, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/keyvault/armkeyvault https://apiview.dev/Assemblies/Review/9acb771e8f8d41a1b0dba8b4e9735baa
    Java azure-resourcemanager-keyvault-generated https://apiview.dev/Assemblies/Review/2264457e859244d48acd4fb79f2a2dd7
    .Net Azure.ResourceManager.KeyVault There is no API change compared with the previous version

    @openapi-workflow-bot
    Copy link

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

    @mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 17, 2023
    @rahulalapati43 rahulalapati43 marked this pull request as ready for review January 20, 2023 04:25
    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 BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go FixS360 KeyVault resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants