Review request for Microsoft.ContainerService/aks to add version preview/2024-04-02-preview #29061
+27,374
−3
openapi-pipeline-app / Swagger LintDiff
succeeded
May 31, 2024 in 4m 4s
Swagger LintDiff succeeded
Details
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-preview-2024-04 | package-preview-2024-04(3d8dc2c) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Schema should have a description or title. Location: aks/preview/2024-04-02-preview/managedClusters.json#L10063 |
||
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: aks/preview/2024-04-02-preview/managedClusters.json#L10074 |
||
Missing identifier id in array item property Location: aks/preview/2024-04-02-preview/managedClusters.json#L10087 |
The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.
Rule | Message |
---|---|
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.ContainerService/operations' does not match the ARM specification. Please standardize the schema. Location: aks/preview/2024-04-02-preview/managedClusters.json#L52 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: aks/preview/2024-04-02-preview/managedClusters.json#L53 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L74 |
ParametersInPointGet |
Query parameter resource-type should be removed. Point Get's MUST not have query parameters other than api version. Location: aks/preview/2024-04-02-preview/managedClusters.json#L80 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L116 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2024-04-02-preview/managedClusters.json#L137 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L237 |
ResourceNameRestriction |
The resource name parameter 'roleName' should be defined with a 'pattern' restriction. Location: aks/preview/2024-04-02-preview/managedClusters.json#L278 |
ParametersInPost |
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-04-02-preview/managedClusters.json#L336 |
ParametersInPost |
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-04-02-preview/managedClusters.json#L381 |
ParametersInPost |
format is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-04-02-preview/managedClusters.json#L381 |
ParametersInPost |
server-fqdn is a query parameter. Post operation must not contain any query parameter other than api-version. Location: aks/preview/2024-04-02-preview/managedClusters.json#L429 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L569 |
PatchResponseCodes |
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: aks/preview/2024-04-02-preview/managedClusters.json#L676 |
PatchIdentityProperty |
The patch operation body parameter schema should contain property 'identity'. Location: aks/preview/2024-04-02-preview/managedClusters.json#L695 |
LroPatch202 |
The async patch operation should return 202. Location: aks/preview/2024-04-02-preview/managedClusters.json#L713 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L723 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L781 |
ResourceNameRestriction |
The resource name parameter 'configName' should be defined with a 'pattern' restriction. Location: aks/preview/2024-04-02-preview/managedClusters.json#L841 |
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: aks/preview/2024-04-02-preview/managedClusters.json#L1011 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1055 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1223 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1350 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L1366 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L1565 |
OperationIdNounVerb |
Per the Noun_Verb convention for Operation Ids, the noun 'AgentPools' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1569 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2024-04-02-preview/managedClusters.json#L1589 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must 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. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1608 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1654 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must 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. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1670 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1717 |
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: aks/preview/2024-04-02-preview/managedClusters.json#L1733 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1774 |
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: aks/preview/2024-04-02-preview/managedClusters.json#L1790 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1827 |
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: aks/preview/2024-04-02-preview/managedClusters.json#L1843 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1879 |
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: aks/preview/2024-04-02-preview/managedClusters.json#L1895 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1932 |
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: aks/preview/2024-04-02-preview/managedClusters.json#L1948 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L1985 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L2001 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: aks/preview/2024-04-02-preview/managedClusters.json#L2025 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: aks/preview/2024-04-02-preview/managedClusters.json#L2154 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L2191 |
PostResponseCodes |
202 response for a LRO POST operation must not have a response schema specified. Location: aks/preview/2024-04-02-preview/managedClusters.json#L2204 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must 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. Location: aks/preview/2024-04-02-preview/managedClusters.json#L2204 |
LroLocationHeader |
A 202 response should include an Location response header. Location: aks/preview/2024-04-02-preview/managedClusters.json#L2234 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: aks/preview/2024-04-02-preview/managedClusters.json#L2247 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: aks/preview/2024-04-02-preview/managedClusters.json#L2263 |
Loading