-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Closed
zhejiao
wants to merge
8
commits into
main
from
zhejiao-hybridcompute-Microsoft.HybridCompute-2024-05-01-preview
Closed
Review request for Microsoft.HybridCompute to add version preview/2024-05-01-preview #28923
zhejiao
wants to merge
8
commits into
main
from
zhejiao-hybridcompute-Microsoft.HybridCompute-2024-05-01-preview
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…023-10-03-preview to version 2024-05-01-preview
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
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:
️️✔️
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:
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]
Swagger Generation Artifacts
|
Generated ApiView
|
…into zhejiao-hybridcompute-Microsoft.HybridCompute-2024-05-01-preview
AzureRestAPISpecReview
added
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
labels
Apr 30, 2024
This was referenced Apr 30, 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 |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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!
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:
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
Purpose of this PR
andDue diligence checklist
.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.and https://aka.ms/ci-fix.
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.