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] Publish private branch 'feature/CloudHsm_updates' #24115

Conversation

emmeliaAra
Copy link
Member

@emmeliaAra emmeliaAra commented May 23, 2023

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

ARM API Information (Control Plane)

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 -- adding new resourceType in the existing namespace
  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. -- new resource is already in Private Preview, Public Preview date 31st July
  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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
  • 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.

@emmeliaAra
Copy link
Member Author

@raych1 please help review azure-sdk-for-go error

@emmeliaAra , there're duplicated schema causing the error.

[generator automation-v2] error   | PreCheck/DuplicateSchema | Duplicate Schema named 'Resource' (10 differences):
03:22:06.128 cmderr 	[generator automation-v2]   - properties.id.description: "The Azure Resource Manager resource ID for the dedicated HSM." => "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\""
03:22:06.128 cmderr 	[generator automation-v2]   - properties.name.description: "The name of the dedicated HSM." => "The name of the resource"
03:22:06.128 cmderr 	[generator automation-v2]   - properties.type.description: "The resource type of the dedicated HSM." => "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\""
03:22:06.128 cmderr 	[generator automation-v2]   - properties.location: {"x-ms-mutability":["create","read"],"$ref":"#/components/schemas/schemas:86","description":"The supported Azure location where the dedicated HSM should be created."} => <none>
03:22:06.128 cmderr 	[generator automation-v2]   - properties.sku: {"$ref":"#/components/schemas/schemas:62","description":"SKU details"} => <none>
03:22:06.128 cmderr 	[generator automation-v2]   - properties.zones: {"$ref":"#/components/schemas/schemas:87","description":"The Dedicated Hsm zones."} => <none>
03:22:06.129 cmderr 	[generator automation-v2]   - properties.tags: {"$ref":"#/components/schemas/schemas:89","description":"Resource tags"} => <none>
03:22:06.129 cmderr 	[generator automation-v2]   - properties.systemData: <none> => {"readOnly":true,"type":"object","description":"Azure Resource Manager metadata containing createdBy and modifiedBy information.","$ref":"#/components/schemas/schemas:286"}
03:22:06.129 cmderr 	[generator automation-v2]   - required: ["location"] => <none>

Hello @raych1 - Thank you for indicating the issue.
The error seems to appear for DedicatedHsm specification, which is not the one updated in this PR.
However, the duplicated schema "Resource" defined in dedicatedhsm.json differs from any of "Resource" schemas in the common-types. Our "Resource" schema includes the "sku", "zones", "location" properties.

…e azure-sdk-for-go error caused by duplicate schema. "CloudHsmClusterResource" indirectly references the common-type"Resource" and this conflicts with "Resource" definition in dedicatedhsm swagger.
@emmeliaAra
Copy link
Member Author

@keryul -I opened a separate PR to track the breaking change in dedicatedhsm.json and it is already approved.
Please see the PR here: #24425

@emmeliaAra
Copy link
Member Author

@keryul - breaking change in this PR is already accepted and merged in this PR #24425.
Also ~[Staging] Service API Readiness Test is failing, could you help with this please ?

@ankhyk
Copy link
Contributor

ankhyk commented Jun 20, 2023

@keryul - breaking change in this PR is already accepted and merged in this PR #24425. Also ~[Staging] Service API Readiness Test is failing, could you help with this please ?

Skipped with ARMSignedOff label added

@ankhyk
Copy link
Contributor

ankhyk commented Jun 20, 2023

@raych1 please review the latest GO breaking change

@raych1 raych1 added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Jun 20, 2023
@emmeliaAra
Copy link
Member Author

@keryul - SDK Breaking change is approved. Can we merge this PR now ?

@ankhyk ankhyk added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Jun 21, 2023
@raych1 raych1 merged commit 237753f into main Jun 21, 2023
@raych1 raych1 deleted the published/GoradeAarti/azure-rest-api-specs-pr/feature/CloudHsm_updates branch June 21, 2023 06:42
harryli0108 pushed a commit to harryli0108/azure-rest-api-specs that referenced this pull request Jul 28, 2023
…ure#24115)

* adding new resource type 'CloudHsm' with new API version

* added systemData in responses and fixed few warnings

* renamings

* added stateMessage

* removed PrivateEndpointConnectionProxy APIs and examples

* API version folder renamed

* updated ReadMe.md

* renamings, fixing validation errors

* fixed avocado errors

* fixed prettier errors

* fixed prettier errors

* fixed validation errors

* fixed prettier errors

* fixed prettier errors

* fixed linfdiff errors

* fixed LintDiff errors

* fixed linfdiff errors

* fixed staging LintDiff errors

* fixed LintDiff errors

* fixed lintdiff errors

* removed pageable extention from CloudHsmPrivateLinkResource_ListByCloudHsm

* renamings

* used referecing for private endpoint connection and private link resource under common types

* fixed review comments

* fixed resourceType in exmaple

* renamed CloudHsm to CloudHsmCluster

* renamed hsmId to fqdn

* fixed description

* modified default tag in Readme.md

* changed tag value to package-2022-08-preview

* Update specification/hardwaresecuritymodules/resource-manager/readme.md

Co-authored-by: Chenjie Shi <[email protected]>

* Update readme.md

* Update readme.md

* fixing lintdiff errors, also fixing old DHSM errors

* fixing syntax errors

* removed operations examples from cloudhsm

* added ResourceNameRestriction for peConnectionName

* added ResourceNameRestriction for peConnectionName

* added pattern for peConnectionName

* fixing prettier check

* Using Common-types definitions for TrackedResource

* created separate folders for different sub services

* reverting to common folder structure

* To resolve duplicate definition errors

* fixing Swagger Staging lintDiff error

* Update Cloud Hsm swagger specifications

* update api-versions to resolve Model Validation issues

* update api version in example file

* added chsmOperation to custom-words.txt

* Removed chsmOperation, replaced CHsmTrackedResource with TrackedResource and AzureResource with ProxyResource. Removed unused definitions/

* Set final-state-via to CreateOperationAsyncResponseValidation and added x-ms-pageable to resolve LintDiff validation issue

* fix lintdiff issue

* update final-state-via for put operation to Original-Uri

* Replaced ProxyResource with TrackedResource in PrivateEndPointConnection because location and tags are also needed.

* Reverted previouse commit to resolve LintDiff issue and included location and etags to PrivateEndpointConnetion.

* removed white space to resolve Prettier check issue

* updated etag description

* Updated skiptoken type from integer to string based on code update.

* Fix required value for skiptoken

* make update for LintDiff issue - PutResponseSchemaDescription

* make update for LintDiff issue - PutResponseSchemaDescription

* Removed location and added groupIds from PrivateEndpointConnection definition in line with NRP Documentation

* update swagger to reflect ARM feedback

* Added Canceled state to PrivateEndpointConnectionProvisioningState enum as per ARM review request

* Renamed "Resource" Definition in Dedicated hsm swagger file to resolve azure-sdk-for-go error caused by duplicate schema. "CloudHsmClusterResource" indirectly references the common-type"Resource" and this conflicts with "Resource" definition in dedicatedhsm swagger.

* Remove duplicate type tag from DedicatedHsmResource

* updated readme file to fix ~[Staging] Service API Readiness Test failed error

* updated readme file to fix ~[Staging] Service API Readiness Test fail

* update readme file to resolve ~[Staging] Service API Readiness Test failure

---------

Co-authored-by: GoradeAarti <[email protected]>
Co-authored-by: GoradeAarti <[email protected]>
Co-authored-by: Chenjie Shi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-LintDiff Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-FixRequiredOnFailure new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants