-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Improved LRO for ManagedClusters_CreateOrUpdate #20808
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
base: main
Are you sure you want to change the base?
Conversation
Hi, @m-nash 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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.7)] | new version | base version |
---|---|---|
managedClusters.json | 2017-08-31(58172de) | 2017-08-31(main) |
Rule | Message |
---|---|
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L71:5 |
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/58172de0154b09a035e33505406bae0e2df663a9/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-07-01/managedClusters.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-07-01/managedClusters.json", "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.40/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js --v2 --input-file=specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-07-01/managedClusters.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Missing required property: final-state-via\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-07-01/managedClusters.json:538:8 ($.paths["/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ContainerService/managedClusters/resourceName"].put["x-ms-long-running-operation-options"])\nFATAL: swagger-document/individual/schema-validator - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancelled due to e" |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 3 Errors, 1 Warnings failed [Detail]
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L104 |
|
AutoRest exception |
"location":"specification/containerservice/resource-manager/readme.md", "tag":"package-2022-07", "details":"swagger-document/individual/schema-validator - FAILED" |
|
AutoRest exception |
"location":"specification/containerservice/resource-manager/readme.md", "tag":"package-2022-07", "details":"Error: [OperationAbortedException] Error occurred. Exiting." |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Managed Cluster Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L250 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L975 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L1080 |
R3015 - EnumMustHaveType |
Enum must define its type and 'object' type is not allowed due to Autorest refuse to parse it. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L1113 |
R3026 - TrackedResourcePatchOperation |
Tracked resource 'ManagedCluster' must have patch operation that at least supports the update of tags. It's strongly recommended that the PATCH operation supports update of all mutable properties as well. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L970 |
R3026 - TrackedResourcePatchOperation |
Tracked resource 'ManagedClusterAccessProfile' must have patch operation that at least supports the update of tags. It's strongly recommended that the PATCH operation supports update of all mutable properties as well. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L1075 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L53 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L142 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L190 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L242 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L295 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L340 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L392 |
R4010 - RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L442 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L834 |
R4015 - NestedResourcesMustHaveListOperation |
The nested resource 'ManagedClusterAccessProfile' does not have list operation, please add it. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L1075 |
R4037 - MissingTypeObject |
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L460 |
R4037 - MissingTypeObject |
The schema 'KeyVaultSecretRef' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L706 |
R4037 - MissingTypeObject |
The schema 'ContainerServiceServicePrincipalProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L727 |
R4037 - MissingTypeObject |
The schema 'ContainerServiceMasterProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L747 |
R4037 - MissingTypeObject |
The schema 'ContainerServiceAgentPoolProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L801 |
R4037 - MissingTypeObject |
The schema 'ContainerServiceWindowsProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L860 |
R4037 - MissingTypeObject |
The schema 'ContainerServiceLinuxProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L879 |
R4037 - MissingTypeObject |
The schema 'ContainerServiceSshConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L897 |
R4037 - MissingTypeObject |
The schema 'ContainerServiceSshPublicKey' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L912 |
R4037 - MissingTypeObject |
The schema 'ContainerServiceDiagnosticsProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L924 |
R4037 - MissingTypeObject |
The schema 'ContainerServiceVMDiagnostics' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L936 |
R4037 - MissingTypeObject |
The schema 'ManagedClusterListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L953 |
R4037 - MissingTypeObject |
The schema '1' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L975 |
R4037 - MissingTypeObject |
The schema 'ManagedClusterProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L987 |
R4037 - MissingTypeObject |
The schema 'OrchestratorProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L1058 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/containerservice/resource-manager/readme.md tag: specification/containerservice/resource-manager/readme.md#tag-package-preview-2022-08 |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️
~[Staging] TrafficValidation succeeded [Detail] [Expand]
️❌
ModelValidation: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
RESPONSE_BODY_NOT_IN_EXAMPLE |
Response statusCode 200 for operation ManagedClusters_GetOperationStatus has no response body provided in the example, however the response does have a "schema" defined in the swagger spec. Url: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L104:22 ExampleUrl: stable/2017-08-31/examples/ManagedClustersGetOperationStatus.json#L8:16 |
RESPONSE_BODY_NOT_IN_EXAMPLE |
Response statusCode 200 for operation ManagedClusters_GetOperationStatus has no response body provided in the example, however the response does have a "schema" defined in the swagger spec. Url: Microsoft.ContainerService/stable/2017-08-31/managedClusters.json#L104:22 ExampleUrl: stable/2017-08-31/examples/ManagedClustersGetOperationStatus.json#L8:16 |
️❌
SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
OBJECT_MISSING_REQUIRED_PROPERTY |
Missing required property: final-state-via JsonUrl: Microsoft.ContainerService/stable/2022-07-01/managedClusters.json#L538:48 |
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/58172de0154b09a035e33505406bae0e2df663a9/specification/containerservice/resource-manager/readme.md#tag-package-2022-07">containerservice/resource-manager/readme.md#package-2022-07
- "https://github.com/Azure/azure-rest-api-specs/blob/58172de0154b09a035e33505406bae0e2df663a9/specification/containerservice/resource-manager/readme.md#tag-package-2017-09">containerservice/resource-manager/readme.md#package-2017-09
- "https://github.com/Azure/azure-rest-api-specs/blob/58172de0154b09a035e33505406bae0e2df663a9/specification/containerservice/resource-manager/readme.md#tag-package-2017-08">containerservice/resource-manager/readme.md#package-2017-08
- "https://github.com/Azure/azure-rest-api-specs/blob/58172de0154b09a035e33505406bae0e2df663a9/specification/containerservice/resource-manager/readme.md#tag-package-2017-08-only">containerservice/resource-manager/readme.md#package-2017-08-only
Rule | Message |
---|---|
"readme":"containerservice/resource-manager/readme.md", "tag":"package-2017-09", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
"readme":"containerservice/resource-manager/readme.md", "tag":"package-2017-08", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
"readme":"containerservice/resource-manager/readme.md", "tag":"package-2017-08-only", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️❌
PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
HowToFix |
Code style issues found path: stable/2017-08-31/examples/ManagedClustersGetOperationStatus.json |
️️✔️
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 @m-nash, Your PR has some issues. Please fix the CI sequentially by following the order of
|
NewApiVersionRequired reason: |
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.