-
Notifications
You must be signed in to change notification settings - Fork 5.4k
[Microsoft.StorageActions][StorageTasks] Address SDK team feedback #28718
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
[Microsoft.StorageActions][StorageTasks] Address SDK team feedback #28718
Conversation
Update to reflect service behavior Description/sample updates
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
Compared specs (v0.10.8) | new version | base version |
---|---|---|
storageactions.json | 2023-01-01(c4d2940) | 2023-01-01(main) |
️️✔️
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 specs (v2.2.2) | new version | base version |
---|---|---|
package-2023-01-01 | package-2023-01-01(c4d2940) | package-2023-01-01(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
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.StorageActions/stable/2023-01-01/storageactions.json#L56 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:enabled. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:description. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:action. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:if. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:condition. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:operations. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L524 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L524 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L555 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L555 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L582 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L582 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L621 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L625 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L644 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L662 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L694 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L735 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L735 |
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'StorageTaskAssignmentModel'. Consider using the plural form of 'StorageTaskAssignment' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L360 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ListStorageTasksByResourceGroup Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L413 |
|
Not using the common-types defined parameter 'location'. Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L483 |
|
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.StorageActions/stable/2023-01-01/storageactions.json#L574 |
|
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.StorageActions/stable/2023-01-01/storageactions.json#L981 |
️️✔️
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
|
...orageactions/resource-manager/Microsoft.StorageActions/stable/2023-01-01/storageactions.json
Outdated
Show resolved
Hide resolved
Please address or respond to feedback from the ARM API reviewer. |
...orageactions/resource-manager/Microsoft.StorageActions/stable/2023-01-01/storageactions.json
Outdated
Show resolved
Hide resolved
Another description you can reword: [same feedback about try to avoid referring to ARM - its just an implementation detail from the point of view of anyone reading Azure API docs. ] Could reword to: "The Azure Storage Task resource ID" Refers to: specification/storageactions/resource-manager/Microsoft.StorageActions/stable/2023-01-01/storageactions.json:908 in 43a9ee3. [](commit_id = 43a9ee3, deletion_comment = False) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Signing off with minor comments you can address before merging
…zure#28718) * Address SDK team feedback: Update to reflect service behavior Description/sample updates * Fix required level * Address model validation errors * Prettier * Also fix properties to required to match service behavior * Reword descriptions
Fix spec to reflect actual service behavior (identity and properties are required). We are in Public Preview and this is the behavior customers have been experiencing, but the SDK team noticed we missed marking the property required in the swagger. Fixing the discrepancy - there is no new breaking change for customers using the service.
Description/sample updates
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.