-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
{AzureResources} fixing the <br> in the swagger specs #25413
Conversation
Next Steps to Merge |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
resources.json | 2020-10-01(57e35c3) | 2020-10-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 tags (via openapi-validator v2.1.4) | new version | base version |
---|---|---|
package-resources-2020-10 | package-resources-2020-10(57e35c3) | package-resources-2020-10(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Resources/stable/2020-10-01/resources.json#L4390 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L4831 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L4914 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L4921 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L4940 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L4946 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L4990 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L5316 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L6006 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L6082 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L6153 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Resources/stable/2020-10-01/resources.json#L6165 |
The response of operation:'Deployments_CreateOrUpdateAtScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L135 |
|
The response of operation:'Deployments_GetAtScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L189 |
|
The response of operation:'Deployments_CreateOrUpdateAtTenantScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L452 |
|
The response of operation:'Deployments_GetAtTenantScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L503 |
|
The response of operation:'Deployments_CreateOrUpdateAtManagementGroupScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L819 |
|
The response of operation:'Deployments_GetAtManagementGroupScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L873 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Predict template changes at management group scope Location: Microsoft.Resources/stable/2020-10-01/resources.json#L1045 |
|
The response of operation:'Deployments_CreateOrUpdateAtSubscriptionScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L1207 |
|
The response of operation:'Deployments_GetAtSubscriptionScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L1261 |
|
The response of operation:'Deployments_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L1613 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create a deployment that will deploy a templateSpec with the given resourceId Location: Microsoft.Resources/stable/2020-10-01/resources.json#L1669 |
|
The response of operation:'Deployments_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L1685 |
|
Based on the response model schema, operation 'ProviderResourceTypes_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L2268 |
|
The response of operation:'Tags_CreateOrUpdateAtScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L4255 |
|
The response of operation:'Tags_UpdateAtScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L4301 |
|
The response of operation:'Tags_GetAtScope' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L4339 |
|
The resource 'TagValue' does not have get operation, please add it. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L5654 |
|
The resource 'TagDetails' does not have get operation, please add it. Location: Microsoft.Resources/stable/2020-10-01/resources.json#L5673 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 4 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MISSING_RESOURCE_ID |
id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.Resources/stable/2020-10-01/resources.json#L6241:21 ExampleUrl: stable/2020-10-01/examples/PutTagsResource.json#L16:15 |
MISSING_RESOURCE_ID |
id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.Resources/stable/2020-10-01/resources.json#L6241:21 ExampleUrl: stable/2020-10-01/examples/PutTagsSubscription.json#L16:15 |
MISSING_RESOURCE_ID |
id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.Resources/stable/2020-10-01/resources.json#L6241:21 ExampleUrl: stable/2020-10-01/examples/GetTagsResource.json#L8:15 |
MISSING_RESOURCE_ID |
id is required to return in response of GET/PUT resource calls but not being provided Url: Microsoft.Resources/stable/2020-10-01/resources.json#L6241:21 ExampleUrl: stable/2020-10-01/examples/GetTagsSubscription.json#L8:15 |
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
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
|
Azure Pipelines successfully started running 2 pipeline(s). |
@Xynoclafe Could you please review this PR once you get a chance ? Please Note: The CI test errors and validation failures are unrelated to the changes done in this PR. |
|
This PR only updated doc and CI failure is not caused by this PR. |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
Reference article here shows in a way not expected like:
And it's possibly caused by the characters included in the swagger.
This PR is fixing this issue.
fixes #25309
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
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to 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 help
section 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)
ARMReview
label.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
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.