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

Review request for Microsoft.HybridCompute to add version preview/2024-05-01-preview #28923

Conversation

zhejiao
Copy link
Contributor

@zhejiao zhejiao commented Apr 30, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app bot commented Apr 30, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR is not ready for ARM review (label: NotReadyForARMReview). This PR will not be reviewed by ARM until relevant problems are fixed. Consult the rest of this Next Steps to Merge comment for details.
    Once the blocking problems are addressed, add to the PR a comment with contents /azp run. Automation will re-evaluate this PR and if everything looks good, it will add WaitForARMFeedback label which will put this PR on the ARM review queue.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review.
  • ❌ This PR is NotReadyForARMReview because it has the BreakingChangeReviewRequired label.
  • ❌ This PR has at least one breaking change (label: BreakingChangeReviewRequired).
    To unblock this PR, follow the process at aka.ms/brch.
  • ❌ The required check named Breaking Change(Cross-Version) has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it. In addition, refer to step 1 in the PR workflow diagram (even if your PR is for data plane, not ARM).

Copy link

openapi-pipeline-app bot commented Apr 30, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 11 Errors, 0 Warnings failed [Detail]
Compared specs (v0.10.8) new version base version
HybridCompute.json 2024-05-01-preview(14b54e1) 2022-12-27(main)
HybridCompute.json 2024-05-01-preview(14b54e1) 2023-10-03-preview(main)
privateLinkScopes.json 2024-05-01-preview(14b54e1) 2022-12-27(main)
privateLinkScopes.json 2024-05-01-preview(14b54e1) 2023-10-03-preview(main)

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

Rule Message
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L119:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L119:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L175:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L175:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L212:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L212:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L267:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L267:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L321:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L321:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L363:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L363:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L408:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L408:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L455:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L455:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L514:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L514:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L582:9
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L582:9
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.HybridCompute/preview/2024-05-01-preview/privateLinkScopes.json#L1820:5
Old: Microsoft.HybridCompute/stable/2022-12-27/privateLinkScopes.json#L1087:5
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 5 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-preview-2024-05 package-preview-2024-05(14b54e1) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ 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.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2383
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2387
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2396
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L3531
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L3574


The following errors/warnings exist before current PR submission:

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

Rule Message
PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L38
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Licenses' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L42
ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L84
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L84
PatchResponseCodes Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L134
LroPatch202 The async patch operation should return 202.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L163
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L224
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L348
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L441
ParametersInPointGet Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L520
ResourceNameRestriction The resource name parameter 'extensionName' should be defined with a 'pattern' restriction.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1103
ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1104
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1104
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1154
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1253
PostResponseCodes 200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1441
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1617
OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1654
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1675
GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1705
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L1841
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2607
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2770
BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'Machine' has extra properties ['resources'].
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2809
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2812
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2820
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2820
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2883
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2883
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-01-preview/HybridCompute.json#L2883
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Apr 30, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from ec3a700c04c91830243ef1591f19b0fb5e281e98. 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
  • ️✔️Azure.ResourceManager.HybridCompute [Preview SDK Changes]
    • Azure.ResourceManager.HybridCompute.1.0.0-alpha.20240502.1.nupkg
    info	[Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from ec3a700c04c91830243ef1591f19b0fb5e281e98. 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.
    cmderr	[automation_init.sh]  notice
    cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
    cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
    cmderr	[automation_init.sh] npm notice Run `npm install -g npm@10.7.0` to update!
    cmderr	[automation_init.sh] npm notice
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️azure-mgmt-hybridcompute [Preview SDK Changes]
    • azure_mgmt_hybridcompute-1.0.0b1-py3-none-any.whl
    • azure-mgmt-hybridcompute-1.0.0b1.zip
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from ec3a700c04c91830243ef1591f19b0fb5e281e98. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-hybridcompute [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-hybridcompute-1.0.0-beta.5-sources.jar
    • azure-resourcemanager-hybridcompute-1.0.0-beta.5.jar
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from ec3a700c04c91830243ef1591f19b0fb5e281e98. 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/hybridcompute/armhybridcompute [Preview SDK Changes]
️🔄 azure-sdk-for-js inProgress [Detail]
️❌ azure-resource-manager-schemas failed [Detail]
  • Failed in generating from ec3a700c04c91830243ef1591f19b0fb5e281e98. 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]  notice
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.5.0 -> 10.7.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.7.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.7.0` to update!
    cmderr	[initScript.sh] npm notice
    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
  • hybridcompute/resource-manager
️⚠️ azure-powershell warning [Detail]
  • ⚠️Warning in generating from ec3a700c04c91830243ef1591f19b0fb5e281e98. 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.hybridcompute.DefaultTag [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

…into zhejiao-hybridcompute-Microsoft.HybridCompute-2024-05-01-preview
@zhejiao
Copy link
Contributor Author

zhejiao commented May 10, 2024

Going to close this PR since I've created a new one based on the 2024-03-31-preview version. Please see it here

@zhejiao zhejiao closed this May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version NotReadyForARMReview 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.

2 participants