Skip to content

fix keyvault enum #23368

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
Closed
msyyc wants to merge 2 commits into from
Closed

fix keyvault enum #23368

msyyc wants to merge 2 commits into from

Conversation

@msyyc
Copy link
Member

@msyyc msyyc commented Mar 30, 2023 •
edited by openapi-workflow-bot bot
Loading

ARM API Information (Control Plane)

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

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
      -[ ] 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.

@msyyc msyyc requested a review from heaths as a code owner March 30, 2023 01:59
@msyyc msyyc self-assigned this Mar 30, 2023
@msyyc msyyc requested a review from jlichwa as a code owner March 30, 2023 01:59
@openapi-workflow-bot
Copy link

openapi-workflow-bot bot commented Mar 30, 2023

Hi, @msyyc 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 Mar 30, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    keyvault.json 2016-10-01(7052888) 2016-10-01(main)
    Rule Message
    ❌ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L568:11
    Old: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L568:11
    ❌ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L596:11
    Old: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L585:11
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️⌛CredScan pending [Detail]
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2016-10 package-2016-10(7052888) package-2016-10(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L52
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L116
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L170
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L218
    ❌ AllResourcesMustHaveDelete The resource VaultAccessPolicyParameters does not have a corresponding delete operation.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L239
    ❌ TrackedResourcePatchOperation Tracked resource 'VaultAccessPolicyParameters' must have patch operation that at least supports the update of tags.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L239
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L294
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L350
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L396
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L435
    ❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L459
    ❌ ParametersOrder The parameters:vaultName,location should be kept in the same order as they present in the path.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L460
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L488
    ❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L509
    ❌ ParametersOrder The parameters:vaultName,location should be kept in the same order as they present in the path.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L510
    ❌ PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L510
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L539
    ❌ LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L543
    ❌ PathContainsResourceType The path for the CURD methods do not contain a resource type.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L560
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L622
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L670
    ❌ MissingTypeObject The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L693
    ❌ MissingTypeObject The schema 'AccessPolicyEntry' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L726
    ❌ GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L730
    ❌ GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L739
    ❌ MissingTypeObject The schema 'Permissions' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L754
    ❌ MissingTypeObject The schema 'VaultProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L863
    ❌ GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L867
    ❌ XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L874
    ❌ MissingTypeObject The schema 'VaultPatchProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L924
    ️️✔️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.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L539:22
    ExampleUrl: stable/2016-10-01/examples/purgeDeletedVault.json
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️⌛PoliCheck pending [Detail]
    ️️✔️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.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand] 
    Validation passes for TypeSpec Validation.
    ️⌛PR Summary pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the KeyVault label Mar 30, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 30, 2023 •
    edited
    Loading

    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 - sdk/resourcemanager/keyvault/armkeyvault - Approved - 2.0.0
    +	Struct `CloudErrorBody` has been removed
+	Struct `CloudError` has been removed
    ❌azure-sdk-for-js - @azure/arm-keyvault - 3.0.0
    +	Interface ManagedHsmsListByResourceGroupNextOptionalParams no longer has parameter top
+	Interface ManagedHsmsListBySubscriptionNextOptionalParams no longer has parameter top
+	Interface MhsmPrivateEndpointConnectionsDeleteHeaders no longer has parameter retryAfter
+	Interface SecretsListNextOptionalParams no longer has parameter top
+	Interface VaultsListByResourceGroupNextOptionalParams no longer has parameter top
+	Interface VaultsListBySubscriptionNextOptionalParams no longer has parameter top
+	Interface VaultsListNextOptionalParams no longer has parameter top

    ️⚠️ azure-sdk-for-net-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 4e89d83612a1b3402f27f048f432ae3055b49db2. 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] Generate from 4e89d83612a1b3402f27f048f432ae3055b49db2. 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] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.3
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.3>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.3` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-keyvault [View full logs]  [Preview SDK Changes] 
      info	[Changelog]
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 4e89d83612a1b3402f27f048f432ae3055b49db2. 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]  [Preview 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 enum type `JSONWebKeyOperation`
info	[Changelog] - New value `KeyPermissionsGetrotationpolicy`, `KeyPermissionsRelease`, `KeyPermissionsRotate`, `KeyPermissionsSetrotationpolicy` added to enum type `KeyPermissions`
info	[Changelog] - New enum type `ActivationStatus` with values `ActivationStatusActive`, `ActivationStatusFailed`, `ActivationStatusNotActivated`, `ActivationStatusUnknown`
info	[Changelog] - New enum type `GeoReplicationRegionProvisioningState` with values `GeoReplicationRegionProvisioningStateCleanup`, `GeoReplicationRegionProvisioningStateDeleting`, `GeoReplicationRegionProvisioningStateFailed`, `GeoReplicationRegionProvisioningStatePreprovisioning`, `GeoReplicationRegionProvisioningStateProvisioning`, `GeoReplicationRegionProvisioningStateSucceeded`
info	[Changelog] - New enum type `KeyRotationPolicyActionType` with values `KeyRotationPolicyActionTypeNotify`, `KeyRotationPolicyActionTypeRotate`
info	[Changelog] - New function `NewClientFactory(string, azcore.TokenCredential, *arm.ClientOptions) (*ClientFactory, error)`
info	[Changelog] - New function `*ClientFactory.NewKeysClient() *KeysClient`
info	[Changelog] - New function `*ClientFactory.NewMHSMPrivateEndpointConnectionsClient() *MHSMPrivateEndpointConnectionsClient`
info	[Changelog] - New function `*ClientFactory.NewMHSMPrivateLinkResourcesClient() *MHSMPrivateLinkResourcesClient`
info	[Changelog] - New function `*ClientFactory.NewMHSMRegionsClient() *MHSMRegionsClient`
info	[Changelog] - New function `*ClientFactory.NewManagedHsmKeysClient() *ManagedHsmKeysClient`
info	[Changelog] - New function `*ClientFactory.NewManagedHsmsClient() *ManagedHsmsClient`
info	[Changelog] - New function `*ClientFactory.NewOperationsClient() *OperationsClient`
info	[Changelog] - New function `*ClientFactory.NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient`
info	[Changelog] - New function `*ClientFactory.NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient`
info	[Changelog] - New function `*ClientFactory.NewSecretsClient() *SecretsClient`
info	[Changelog] - New function `*ClientFactory.NewVaultsClient() *VaultsClient`
info	[Changelog] - New function `NewMHSMRegionsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*MHSMRegionsClient, error)`
info	[Changelog] - New function `*MHSMRegionsClient.NewListByResourcePager(string, string, *MHSMRegionsClientListByResourceOptions) *runtime.Pager[MHSMRegionsClientListByResourceResponse]`
info	[Changelog] - New function `NewManagedHsmKeysClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ManagedHsmKeysClient, error)`
info	[Changelog] - New function `*ManagedHsmKeysClient.CreateIfNotExist(context.Context, string, string, string, ManagedHsmKeyCreateParameters, *ManagedHsmKeysClientCreateIfNotExistOptions) (ManagedHsmKeysClientCreateIfNotExistResponse, error)`
info	[Changelog] - New function `*ManagedHsmKeysClient.Get(context.Context, string, string, string, *ManagedHsmKeysClientGetOptions) (ManagedHsmKeysClientGetResponse, error)`
info	[Changelog] - New function `*ManagedHsmKeysClient.GetVersion(context.Context, string, string, string, string, *ManagedHsmKeysClientGetVersionOptions) (ManagedHsmKeysClientGetVersionResponse, error)`
info	[Changelog] - New function `*ManagedHsmKeysClient.NewListPager(string, string, *ManagedHsmKeysClientListOptions) *runtime.Pager[ManagedHsmKeysClientListResponse]`
info	[Changelog] - New function `*ManagedHsmKeysClient.NewListVersionsPager(string, string, string, *ManagedHsmKeysClientListVersionsOptions) *runtime.Pager[ManagedHsmKeysClientListVersionsResponse]`
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 `ClientFactory`
info	[Changelog] - New struct `KeyReleasePolicy`
info	[Changelog] - New struct `KeyRotationPolicyAttributes`
info	[Changelog] - New struct `LifetimeAction`
info	[Changelog] - New struct `MHSMGeoReplicatedRegion`
info	[Changelog] - New struct `MHSMRegionsListResult`
info	[Changelog] - New struct `ManagedHSMSecurityDomainProperties`
info	[Changelog] - New struct `ManagedHsmAction`
info	[Changelog] - New struct `ManagedHsmKey`
info	[Changelog] - New struct `ManagedHsmKeyAttributes`
info	[Changelog] - New struct `ManagedHsmKeyCreateParameters`
info	[Changelog] - New struct `ManagedHsmKeyListResult`
info	[Changelog] - New struct `ManagedHsmKeyProperties`
info	[Changelog] - New struct `ManagedHsmKeyReleasePolicy`
info	[Changelog] - New struct `ManagedHsmKeyRotationPolicyAttributes`
info	[Changelog] - New struct `ManagedHsmLifetimeAction`
info	[Changelog] - New struct `ManagedHsmRotationPolicy`
info	[Changelog] - New struct `ManagedHsmTrigger`
info	[Changelog] - New struct `ProxyResourceWithoutSystemData`
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 `Regions` in struct `ManagedHsmProperties`
info	[Changelog] - New field `SecurityDomainProperties` in struct `ManagedHsmProperties`
info	[Changelog]
info	[Changelog] Total 4 breaking change(s), 92 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 4e89d83612a1b3402f27f048f432ae3055b49db2. 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
    • ️✔️@azure/arm-keyvault [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group ManagedHsmKeys
info	[Changelog]   - Added operation group MhsmRegions
info	[Changelog]   - Added operation ManagedHsms.checkMhsmNameAvailability
info	[Changelog]   - Added Interface Action
info	[Changelog]   - Added Interface CheckMhsmNameAvailabilityParameters
info	[Changelog]   - Added Interface CheckMhsmNameAvailabilityResult
info	[Changelog]   - Added Interface Key
info	[Changelog]   - Added Interface KeyReleasePolicy
info	[Changelog]   - Added Interface KeyRotationPolicyAttributes
info	[Changelog]   - Added Interface LifetimeAction
info	[Changelog]   - Added Interface ManagedHsm
info	[Changelog]   - Added Interface ManagedHsmAction
info	[Changelog]   - Added Interface ManagedHsmKey
info	[Changelog]   - Added Interface ManagedHsmKeyAttributes
info	[Changelog]   - Added Interface ManagedHsmKeyCreateParameters
info	[Changelog]   - Added Interface ManagedHsmKeyListResult
info	[Changelog]   - Added Interface ManagedHsmKeyProperties
info	[Changelog]   - Added Interface ManagedHsmKeyReleasePolicy
info	[Changelog]   - Added Interface ManagedHsmKeyRotationPolicyAttributes
info	[Changelog]   - Added Interface ManagedHsmKeysCreateIfNotExistOptionalParams
info	[Changelog]   - Added Interface ManagedHsmKeysGetOptionalParams
info	[Changelog]   - Added Interface ManagedHsmKeysGetVersionOptionalParams
info	[Changelog]   - Added Interface ManagedHsmKeysListNextOptionalParams
info	[Changelog]   - Added Interface ManagedHsmKeysListOptionalParams
info	[Changelog]   - Added Interface ManagedHsmKeysListVersionsNextOptionalParams
info	[Changelog]   - Added Interface ManagedHsmKeysListVersionsOptionalParams
info	[Changelog]   - Added Interface ManagedHsmLifetimeAction
info	[Changelog]   - Added Interface ManagedHsmRotationPolicy
info	[Changelog]   - Added Interface ManagedHsmsCheckMhsmNameAvailabilityOptionalParams
info	[Changelog]   - Added Interface ManagedHsmsCreateOrUpdateHeaders
info	[Changelog]   - Added Interface ManagedHsmsDeleteHeaders
info	[Changelog]   - Added Interface ManagedHSMSecurityDomainProperties
info	[Changelog]   - Added Interface ManagedHsmsPurgeDeletedHeaders
info	[Changelog]   - Added Interface ManagedHsmsUpdateHeaders
info	[Changelog]   - Added Interface ManagedHsmTrigger
info	[Changelog]   - Added Interface MhsmGeoReplicatedRegion
info	[Changelog]   - Added Interface MhsmPrivateEndpointConnection
info	[Changelog]   - Added Interface MhsmPrivateLinkResource
info	[Changelog]   - Added Interface MhsmRegionsListByResourceNextOptionalParams
info	[Changelog]   - Added Interface MhsmRegionsListByResourceOptionalParams
info	[Changelog]   - Added Interface MhsmRegionsListResult
info	[Changelog]   - Added Interface PrivateEndpointConnection
info	[Changelog]   - Added Interface PrivateLinkResource
info	[Changelog]   - Added Interface ProxyResourceWithoutSystemData
info	[Changelog]   - Added Interface RotationPolicy
info	[Changelog]   - Added Interface Secret
info	[Changelog]   - Added Interface SecretAttributes
info	[Changelog]   - Added Interface Trigger
info	[Changelog]   - Added Type Alias ActivationStatus
info	[Changelog]   - Added Type Alias GeoReplicationRegionProvisioningState
info	[Changelog]   - Added Type Alias KeyRotationPolicyActionType
info	[Changelog]   - Added Type Alias ManagedHsmKeysCreateIfNotExistResponse
info	[Changelog]   - Added Type Alias ManagedHsmKeysGetResponse
info	[Changelog]   - Added Type Alias ManagedHsmKeysGetVersionResponse
info	[Changelog]   - Added Type Alias ManagedHsmKeysListNextResponse
info	[Changelog]   - Added Type Alias ManagedHsmKeysListResponse
info	[Changelog]   - Added Type Alias ManagedHsmKeysListVersionsNextResponse
info	[Changelog]   - Added Type Alias ManagedHsmKeysListVersionsResponse
info	[Changelog]   - Added Type Alias ManagedHsmsCheckMhsmNameAvailabilityResponse
info	[Changelog]   - Added Type Alias ManagedHsmsPurgeDeletedResponse
info	[Changelog]   - Added Type Alias MhsmRegionsListByResourceNextResponse
info	[Changelog]   - Added Type Alias MhsmRegionsListByResourceResponse
info	[Changelog]   - Interface KeyProperties has a new optional parameter releasePolicy
info	[Changelog]   - Interface KeyProperties has a new optional parameter rotationPolicy
info	[Changelog]   - Interface ManagedHsmProperties has a new optional parameter regions
info	[Changelog]   - Interface ManagedHsmProperties has a new optional parameter securityDomainProperties
info	[Changelog]   - Interface MhsmPrivateEndpointConnectionItem has a new optional parameter etag
info	[Changelog]   - Interface MhsmPrivateEndpointConnectionItem has a new optional parameter id
info	[Changelog]   - Added Enum KnownActivationStatus
info	[Changelog]   - Added Enum KnownGeoReplicationRegionProvisioningState
info	[Changelog]   - Enum KnownJsonWebKeyOperation has a new value Release
info	[Changelog]   - Enum KnownKeyPermissions has a new value Getrotationpolicy
info	[Changelog]   - Enum KnownKeyPermissions has a new value Release
info	[Changelog]   - Enum KnownKeyPermissions has a new value Rotate
info	[Changelog]   - Enum KnownKeyPermissions has a new value Setrotationpolicy
info	[Changelog]   - Added function getContinuationToken
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Interface ManagedHsmsListByResourceGroupNextOptionalParams no longer has parameter top
info	[Changelog]   - Interface ManagedHsmsListBySubscriptionNextOptionalParams no longer has parameter top
info	[Changelog]   - Interface MhsmPrivateEndpointConnectionsDeleteHeaders no longer has parameter retryAfter
info	[Changelog]   - Interface SecretsListNextOptionalParams no longer has parameter top
info	[Changelog]   - Interface VaultsListByResourceGroupNextOptionalParams no longer has parameter top
info	[Changelog]   - Interface VaultsListBySubscriptionNextOptionalParams no longer has parameter top
info	[Changelog]   - Interface VaultsListNextOptionalParams no longer has parameter top
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 4e89d83612a1b3402f27f048f432ae3055b49db2. 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
warn	No file changes detected after generation
    • ️✔️keyvault [View full logs] 
    ️❌ azure-powershell failed [Detail]
    • ❌Failed [Logs] Generate from 4e89d83612a1b3402f27f048f432ae3055b49db2. 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.DefaultTag [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 30, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.KeyVault Create ApiView failed. Please ask PR assignee for help
    Go sdk/resourcemanager/keyvault/armkeyvault https://apiview.dev/Assemblies/Review/9cca2adc89ed491e94ec933bf9d427cd
    .Net Azure.ResourceManager.KeyVault There is no API change compared with the previous version
    Java azure-resourcemanager-keyvault-generated https://apiview.dev/Assemblies/Review/7bfe557333774cdb9ee1dd67276c5531
    JavaScript @azure/arm-keyvault https://apiview.dev/Assemblies/Review/58541ea4070f4965b76a5a2a1f9bada2

    @azure-sdk azure-sdk mentioned this pull request Mar 30, 2023
    Closed
    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-FixRequiredOnFailure resource-manager labels Mar 30, 2023
    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Mar 30, 2023

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

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Mar 30, 2023

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

    This was referenced Mar 30, 2023
    Closed
    Closed
    This was referenced Mar 30, 2023
    Closed
    Closed
    @tadelesh tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Mar 30, 2023
    @msyyc
    Copy link
    Member Author

    msyyc commented Mar 30, 2023

    Hi @JeffreyRichter. Please help review the swagger breaking. Actually the change shall not influence REST API users. But it is better to fix it to keep same with latest swagger definition. Thanks!

    @msyyc
    Copy link
    Member Author

    msyyc commented Mar 30, 2023

    https://github.com/Azure/sdk-release-request/issues/4003

    heaths
    heaths requested changes Mar 30, 2023
    View reviewed changes
    specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/keyvault.json
    "x-ms-enum": {
    "name": "VaultListFilterTypes",
    "modelAsString": false
    },
    Copy link
    Member

    @heaths heaths Mar 30, 2023

    Choose a reason for hiding this comment

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

    You should also use the "values" property to give this a better friendly name for code generation. Same as the ResourceManagerApiVersions enum below. For date-based versions we prefer "V2025_11_01". For this expression...I'm not sure. Feel free to come up with something.

    Copy link
    Member Author

    @msyyc msyyc Mar 31, 2023

    Choose a reason for hiding this comment

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

    updated

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 31, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    keyvault.json 2016-10-01(7052888) 2016-10-01(main)
    Rule Message
    ❌ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L568:11
    Old: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L568:11
    ❌ 1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
    New: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L596:11
    Old: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L585:11
    ️️✔️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-2016-10 package-2016-10(7052888) package-2016-10(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L52
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L116
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L170
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L218
    ❌ AllResourcesMustHaveDelete The resource VaultAccessPolicyParameters does not have a corresponding delete operation.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L239
    ❌ TrackedResourcePatchOperation Tracked resource 'VaultAccessPolicyParameters' must have patch operation that at least supports the update of tags.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L239
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L294
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L350
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L396
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L435
    ❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L459
    ❌ ParametersOrder The parameters:vaultName,location should be kept in the same order as they present in the path.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L460
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L488
    ❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L509
    ❌ ParametersOrder The parameters:vaultName,location should be kept in the same order as they present in the path.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L510
    ❌ PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L510
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L539
    ❌ LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L543
    ❌ PathContainsResourceType The path for the CURD methods do not contain a resource type.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L560
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L622
    ❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L670
    ❌ MissingTypeObject The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L693
    ❌ MissingTypeObject The schema 'AccessPolicyEntry' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L726
    ❌ GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L730
    ❌ GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L739
    ❌ MissingTypeObject The schema 'Permissions' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L754
    ❌ MissingTypeObject The schema 'VaultProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L863
    ❌ GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L867
    ❌ XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L874
    ❌ MissingTypeObject The schema 'VaultPatchProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L924
    ️️✔️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.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
    Url: Microsoft.KeyVault/stable/2016-10-01/keyvault.json#L539:22
    ExampleUrl: stable/2016-10-01/examples/purgeDeletedVault.json
    ️️✔️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.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand] 
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand] 
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @heaths
    Copy link
    Member

    heaths commented Mar 31, 2023

    To confirm since there was no description of the PR, this is to correct the swagger to match the service, right? Otherwise, I can't simply approve the breaking change to an existing version and you'd either need to do this in a new api-version, or go through the breaking changes approval board. See https://aka.ms/AzBreakingChangesPolicy for more info.

    @msyyc
    Copy link
    Member Author

    msyyc commented Apr 3, 2023

    move to #23393

    @msyyc msyyc closed this Apr 3, 2023
    @msyyc msyyc deleted the fix-keyvault branch April 3, 2023 02:38
    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

    @jlichwa jlichwa Awaiting requested review from jlichwa

    Assignees

    @msyyc msyyc

    Labels

    Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-FixRequiredOnFailure KeyVault resource-manager

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    5 participants

    @msyyc @heaths @tadelesh @AzureRestAPISpecReview