Swagger Correctness missing Cache property#26701
Conversation
Missing Cache property
Missing cache property stable version
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 |
|---|---|---|
| bigDataPool.json | 2021-06-01-preview(2d1eb92) | 2021-06-01-preview(main) |
| bigDataPool.json | 2021-06-01(2d1eb92) | 2021-06-01(main) |
| Rule | Message |
|---|---|
1029 - ReadonlyPropertyChanged |
The read only property has changed from 'true' to 'false'. New: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L433:9 Old: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L433:9 |
1029 - ReadonlyPropertyChanged |
The read only property has changed from 'true' to 'false'. New: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L433:9 Old: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L433:9 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 6 Errors, 0 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2021-06 | package-2021-06(2d1eb92) | package-2021-06(main) |
| package-preview-2021-06 | package-preview-2021-06(2d1eb92) | package-preview-2021-06(main) |
| package-composite-v2 | package-composite-v2(2d1eb92) | package-composite-v2(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/privateEndpointConnections.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/2d1eb92191feacee63079842982e3dfb3231f57a/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/privatelinkhub.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/2d1eb92191feacee63079842982e3dfb3231f57a/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/privateEndpointConnections.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/2d1eb92191feacee63079842982e3dfb3231f57a/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/privatelinkhub.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/2d1eb92191feacee63079842982e3dfb3231f57a/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/privateEndpointConnections.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/2d1eb92191feacee63079842982e3dfb3231f57a/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/privatelinkhub.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/2d1eb92191feacee63079842982e3dfb3231f57a/#L1 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L24 |
ResourceNameRestriction |
The resource name parameter 'bigDataPoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L24 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L24 |
ResourceNameRestriction |
The resource name parameter 'bigDataPoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L24 |
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.Synapse/preview/2021-06-01-preview/bigDataPool.json#L142 |
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.Synapse/preview/2021-06-01-preview/bigDataPool.json#L142 |
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.Synapse/preview/2021-06-01-preview/bigDataPool.json#L142 |
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.Synapse/preview/2021-06-01-preview/bigDataPool.json#L142 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L195 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L195 |
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.Synapse/preview/2021-06-01-preview/bigDataPool.json#L224 |
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.Synapse/preview/2021-06-01-preview/bigDataPool.json#L224 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L255 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L255 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L260 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L260 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L291 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L291 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L24 |
ResourceNameRestriction |
The resource name parameter 'bigDataPoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L24 |
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.Synapse/stable/2021-06-01/bigDataPool.json#L142 |
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.Synapse/stable/2021-06-01/bigDataPool.json#L142 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L195 |
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.Synapse/stable/2021-06-01/bigDataPool.json#L224 |
DeleteResponseBodyEmpty |
The delete response body must be empty. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L255 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L260 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/stable/2021-06-01/bigDataPool.json#L291 |
| The API version:2021-06-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L4 |
|
| The API version:2021-06-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L4 |
|
| The response of operation:'BigDataPools_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Synapse/preview/2021-06-01-preview/bigDataPool.json#L25 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/synapse/resource-manager/readme.md tag: specification/synapse/resource-manager/readme.md#tag-package-composite-v2 |
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️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 pending [Detail]
Swagger Generation Artifacts
|
Generated ApiView
|
|
Please address or respond to feedback from the ARM API reviewer. |
@rkmanda, the model validation failures are not caused by my changes. Those changes are coming from main. Could you pls take this forward. |
|
Model validation failures will be fixed with the next PR |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
@rkmanda can you pls merge this PR. All the required checks are done from my side. Customer is waiting for this fix. |
|
/pr RequestMerge |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
@rkmanda, Can you please merge this ASAP. |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
|
This PR checks are stuck because I am going to follow guidance linked from the check that says: And post: Note I also found general |
|
@microsoft-github-policy-service rerun |
|
@microsoft-github-policy-service agree |
|
@sampathvasalav to unblock this PR, can you reply with a comment like this one? For context, please see: |
|
Please move the PR for merging once handled the licensing. |
|
@microsoft-github-policy-service agree |
|
@microsoft-github-policy-service rerun |
|
/pr RequestMerge |
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.