Conversation
|
The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/15285 |
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| testbase.json | 2023-11-01-preview(b86edec) | 2022-04-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 28 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-11-01-preview | package-2023-11-01-preview(b86edec) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ActionRequestsModel'. Consider using the plural form of 'ActionRequests' 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.TestBase/preview/2023-11-01-preview/actionrequest.json#L42 |
||
| Parameter should have a description. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L57 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ActionRequestsModel'. Consider using the plural form of 'ActionRequests' 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.TestBase/preview/2023-11-01-preview/actionrequest.json#L85 |
||
| 'PUT' operation 'ActionRequests_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L85 |
||
| Parameter should have a description. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L97 |
||
| Parameter should have a description. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L103 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ActionRequestsModel'. Consider using the plural form of 'ActionRequests' 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.TestBase/preview/2023-11-01-preview/actionrequest.json#L141 |
||
| Parameter should have a description. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L153 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ActionRequestsModel'. Consider using the plural form of 'ActionRequests' 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.TestBase/preview/2023-11-01-preview/actionrequest.json#L186 |
||
| Parameter should have a description. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L201 |
||
| Schema should have a description or title. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L234 |
||
| Schema should have a description or title. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L250 |
||
| Schema should have a description or title. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L265 |
||
| Schema should have a description or title. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L301 |
||
| Schema should have a description or title. Location: Microsoft.TestBase/preview/2023-11-01-preview/actionrequest.json#L311 |
||
| 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.TestBase/preview/2023-11-01-preview/draftpackage.json#L593 |
||
| 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.TestBase/preview/2023-11-01-preview/draftpackage.json#L618 |
||
| 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.TestBase/preview/2023-11-01-preview/draftpackage.json#L627 |
||
| 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.TestBase/preview/2023-11-01-preview/draftpackage.json#L741 |
||
| 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.TestBase/preview/2023-11-01-preview/draftpackage.json#L770 |
||
| 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.TestBase/preview/2023-11-01-preview/draftpackage.json#L973 |
||
| 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.TestBase/preview/2023-11-01-preview/draftpackage.json#L1095 |
||
| 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.TestBase/preview/2023-11-01-preview/draftpackage.json#L1133 |
||
| 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.TestBase/preview/2023-11-01-preview/testbase.json#L3814 |
||
| 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.TestBase/preview/2023-11-01-preview/testbase.json#L4479 |
||
| 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.TestBase/preview/2023-11-01-preview/testbase.json#L4483 |
||
| 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.TestBase/preview/2023-11-01-preview/testbase.json#L4487 |
||
| 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.TestBase/preview/2023-11-01-preview/testbase.json#L4491 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
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.TestBase/preview/2023-11-01-preview/testbase.json#L330 |
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.TestBase/preview/2023-11-01-preview/testbase.json#L409 |
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.TestBase/preview/2023-11-01-preview/testbase.json#L508 |
ResourceNameRestriction |
The resource name parameter 'availableOSResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L712 |
ResourceNameRestriction |
The resource name parameter 'flightingRingResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L852 |
ResourceNameRestriction |
The resource name parameter 'testTypeResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1273 |
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.TestBase/preview/2023-11-01-preview/testbase.json#L1488 |
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.TestBase/preview/2023-11-01-preview/testbase.json#L1570 |
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.TestBase/preview/2023-11-01-preview/testbase.json#L1675 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1782 |
PostResponseCodes |
An async POST operation must set ''x-ms-long-running-operation' : true'. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1782 |
XMSLongRunningOperationProperty |
If an operation's (PUT/POST/PATCH/DELETE) responses have Location or Azure-AsyncOperation headers then it MUST have the property x-ms-long-running-operation set to trueLocation: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1820 |
ResourceNameRestriction |
The resource name parameter 'testSummaryName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1892 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L1996 |
ResourceNameRestriction |
The resource name parameter 'osUpdateResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2095 |
ResourceNameRestriction |
The resource name parameter 'favoriteProcessResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2196 |
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.TestBase/preview/2023-11-01-preview/testbase.json#L2197 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2345 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2411 |
ResourceNameRestriction |
The resource name parameter 'analysisResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2411 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2474 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2522 |
ResourceNameRestriction |
The resource name parameter 'testResultName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2570 |
ResourceNameRestriction |
The resource name parameter 'emailEventResourceName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2672 |
ResourceNameRestriction |
The resource name parameter 'customerEventName' should be defined with a 'pattern' restriction. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2767 |
ProvisioningStateSpecifiedForLROPut |
200 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.TestBase/preview/2023-11-01-preview/testbase.json#L2768 |
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.TestBase/preview/2023-11-01-preview/testbase.json#L2768 |
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.TestBase/preview/2023-11-01-preview/testbase.json#L2836 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L3320 |
| Operation should have a summary or description. Location: Microsoft.TestBase/preview/2023-11-01-preview/testbase.json#L2977 |
️️✔️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
|
|
This PR is migrated from azure-rest-api-specs-pr. To keep the consistency could we ask for suppression for the checks i.e. Swagger LintDiff. |
Its the perfect time for you to achieve consistency with the RPC guidelines. Please fix the errors. |
|
Please address or respond to feedback from the ARM API reviewer. |
2e58e05 to
5e1f745
Compare
|
@TimLovellSmith @rkmanda Could you please help with the suppression approval? There's no suppression on the new api version any longer. |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
Removing the suppression tag and using a new azp run to verify as the validation is stuck. |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
/pr RequestMerge |
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. 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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.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 ApiViewcomment 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
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.