S360 Item - Missing Get SubscriptionOperations for 2021-10-01 version.#24395
S360 Item - Missing Get SubscriptionOperations for 2021-10-01 version.#24395rkmanda merged 10 commits intoAzure:mainfrom
Conversation
|
Hi, @abhaygill338 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 |
|---|---|---|
| subscriptions.json | 2021-10-01(41f8f34) | 2021-10-01(main) |
| Rule | Message |
|---|---|
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L121:5 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 3 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2021-10 | package-2021-10(41f8f34) | package-2021-10(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Not using the common-types defined parameter 'operationId'. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L158 |
||
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L158 |
||
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L158 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L190 |
PathForPutOperation |
The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L205 |
ResourceNameRestriction |
The resource name parameter 'aliasName' should be defined with a 'pattern' restriction. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L205 |
PutRequestResponseSchemeArm |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Alias_Create' Request Model: 'parameters[1].schema' Response Model: 'responses[200].schema' Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L206 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L215 |
PutResponseSchemaDescription |
Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L215 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L231 |
LroPostReturn |
A LRO POST operation must have both 200 & 202 return codes. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L346 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L346 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L373 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L407 |
PathForPutOperation |
The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L428 |
PutRequestResponseSchemeArm |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'SubscriptionPolicy_AddUpdatePolicyForTenant' Request Model: 'parameters[0].schema' Response Model: 'responses[200].schema' Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L429 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L437 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L476 |
GetCollectionResponseSchema |
The response in the GET collection operation 'SubscriptionPolicy_ListPolicyForTenant' does not match the response definition in the individual GET operation 'BillingAccount_GetPolicy' . Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L494 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L539 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L651 |
TopLevelResourcesListBySubscription |
The top-level resource 'SubscriptionAliasResponse' does not have list by subscription operation, please add it. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L763 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L806 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L964 |
TopLevelResourcesListBySubscription |
The top-level resource 'GetTenantPolicyResponse' does not have list by subscription operation, please add it. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L971 |
TopLevelResourcesListBySubscription |
The top-level resource 'BillingAccountPoliciesResponse' does not have list by subscription operation, please add it. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1020 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1054 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1090 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1127 |
XmsParameterLocation |
The parameter 'apiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L1157 |
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L28 |
|
| Not using the common-types defined parameter 'subscriptionId'. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L28 |
|
| Not using the common-types defined parameter 'api-version'. Location: Microsoft.Subscription/stable/2021-10-01/subscriptions.json#L61 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/subscription/resource-manager/readme.md tag: specification/subscription/resource-manager/readme.md#tag-package-2021-10 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
|
Hi @abhaygill338, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
The automation detected this Pull Request introduces breaking changes to an existing API version and hence it added the |
|
Reviewed suppression. |
Resolving S360 Item of Missing Get Subscription Operations for 2021-10-01 version in the swagger. https://portal.azure-devex-tools.com/amekpis/completeness/detail?errorId=623EE52B-F0B6-4F60-B73E-CCE24ADABAD6