-
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
tsp, avs, rename List API response schema back to ##List #29408
tsp, avs, rename List API response schema back to ##List #29408
Conversation
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.9) | new version | base version |
---|---|---|
vmware.json | 2023-09-01(eb8c29a) | 2023-09-01(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
LintDiff succeeded [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-2023-09-01 | package-2023-09-01(eb8c29a) | package-2023-09-01(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
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.AVS/stable/2023-09-01/vmware.json#L519 |
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.AVS/stable/2023-09-01/vmware.json#L785 |
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.AVS/stable/2023-09-01/vmware.json#L1041 |
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.AVS/stable/2023-09-01/vmware.json#L1297 |
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.AVS/stable/2023-09-01/vmware.json#L1636 |
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.AVS/stable/2023-09-01/vmware.json#L1916 |
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.AVS/stable/2023-09-01/vmware.json#L2353 |
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.AVS/stable/2023-09-01/vmware.json#L2819 |
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.AVS/stable/2023-09-01/vmware.json#L3285 |
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.AVS/stable/2023-09-01/vmware.json#L3704 |
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.AVS/stable/2023-09-01/vmware.json#L4409 |
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.AVS/stable/2023-09-01/vmware.json#L4731 |
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.AVS/stable/2023-09-01/vmware.json#L5043 |
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.AVS/stable/2023-09-01/vmware.json#L5460 |
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.AVS/stable/2023-09-01/vmware.json#L5694 |
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.AVS/stable/2023-09-01/vmware.json#L6018 |
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.AVS/stable/2023-09-01/vmware.json#L6448 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.AVS/stable/2023-09-01/vmware.json#L9034 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.AVS/stable/2023-09-01/vmware.json#L9337 |
️️✔️
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
|
edc139a
to
aa9e187
Compare
aa9e187
to
c1416ca
Compare
list is ArmResourceListByParent<WorkloadNetworkDnsZone>; | ||
list is ArmResourceListByParent< | ||
WorkloadNetworkDnsZone, | ||
Response = ArmResponse<ResourceList<WorkloadNetworkDnsZone, "{name}sList">> |
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.
maybe a minor concern, is this the right way to get plural if the name is policy?
@@ -38,9 +38,15 @@ interface Locations { | |||
interface PrivateClouds { | |||
#suppress "@azure-tools/typespec-azure-core/no-operation-id" "Can not change existing operationId." | |||
@operationId("PrivateClouds_List") | |||
list is ArmResourceListByParent<PrivateCloud>; | |||
list is ArmResourceListByParent< |
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.
will the naming fix be covered in 0.57.0? if yes, we will need to regen after typespec is released for this right?
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.
For this release, we likely would generate from Swagger. And operationId in Swagger is specified on above @operationId("PrivateClouds_List")
line.
We are renaming these List in another PR (in client.tsp) #29308
But as we know, the problem is how to rename resource group...
PlacementPolicy, | ||
Response = ArmResponse<ResourceList< | ||
PlacementPolicy, | ||
"PlacementPoliciesList" |
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.
oh I see we can specify the full name here.
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.
Thanks @weidongxu-microsoft.
No REST API change.
This would only affect SDK (maybe REST API doc).
Rename these model back to what's in prior stable api-versions, e.g.
azure-rest-api-specs/specification/vmware/resource-manager/Microsoft.AVS/stable/2023-03-01/vmware.json
Line 425 in c1416ca
I did not modify
OperationListResult
, as it is via interface template. Seems better to keep it.azure-rest-api-specs/specification/vmware/Microsoft.AVS/routes.tsp
Line 15 in c1416ca
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.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
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
.write access
per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext 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.