-
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
Update description of alerts.json #22841
Conversation
Hi, @msyyc Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
alerts.json | 2022-01-01(5b052e6) | 2022-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 tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-composite-v3 | package-composite-v3(5b052e6) | package-composite-v3(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ParametersOrder |
The parameters:ascLocation,resourceGroupName should be kept in the same order as they present in the path. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L161 |
ResourceNameRestriction |
The resource name parameter 'alertName' should be defined with a 'pattern' restriction. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L205 |
ResourceNameRestriction |
The resource name parameter 'alertName' should be defined with a 'pattern' restriction. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L247 |
ResourceNameRestriction |
The resource name parameter 'alertName' should be defined with a 'pattern' restriction. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L292 |
ResourceNameRestriction |
The resource name parameter 'alertName' should be defined with a 'pattern' restriction. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L331 |
ResourceNameRestriction |
The resource name parameter 'alertName' should be defined with a 'pattern' restriction. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L370 |
ResourceNameRestriction |
The resource name parameter 'alertName' should be defined with a 'pattern' restriction. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L409 |
ResourceNameRestriction |
The resource name parameter 'alertName' should be defined with a 'pattern' restriction. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L448 |
ResourceNameRestriction |
The resource name parameter 'alertName' should be defined with a 'pattern' restriction. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L490 |
ResourceNameRestriction |
The resource name parameter 'alertName' should be defined with a 'pattern' restriction. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L532 |
ResourceNameRestriction |
The resource name parameter 'alertName' should be defined with a 'pattern' restriction. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L574 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Security/stable/2022-01-01/alerts.json#L617 |
LroPostMustNotUseOriginalUriAsFinalState |
The long running post operation must not use final-stat-via:original-uri. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L643 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L647 |
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L49 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L88 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L130 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L172 |
|
The response of operation:'Alerts_GetSubscriptionLevel' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L206 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L217 |
|
The response of operation:'Alerts_GetResourceGroupLevel' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Security/stable/2022-01-01/alerts.json#L248 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L259 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L304 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update security alert state on a subscription from a security data location Location: Microsoft.Security/stable/2022-01-01/alerts.json#L333 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L343 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update security alert state on a subscription from a security data location Location: Microsoft.Security/stable/2022-01-01/alerts.json#L372 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L382 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update security alert state on a subscription from a security data location Location: Microsoft.Security/stable/2022-01-01/alerts.json#L411 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L421 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/stable/2022-01-01/alerts.json#L460 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/security/resource-manager/readme.md tag: specification/security/resource-manager/readme.md#tag-package-composite-v3 |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 59 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️️✔️
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).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @msyyc, Your PR has some issues. Please fix the CI sequentially by following the order of
|
* Update alerts.json * Update alerts.json
Fix doc description: Azure/azure-sdk-for-python#29022