-
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
Add Get, List Extension Types #13562
Add Get, List Extension Types #13562
Conversation
Hi, @carlocardella 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. vsswagger@microsoft.com |
Swagger Validation Report
|
Rule | Message |
---|---|
The child tracked resource, 'operations' with immediate parent 'Extension', must have a list by immediate parent operation. Location: Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/kubernetesconfiguration.json#L290 |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
R4017 - TopLevelResourcesListBySubscription |
The top-level resource 'SourceControlConfiguration' does not have list by subscription operation, please add it. Location: Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/kubernetesconfiguration.json#L388 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/extensions.json#L613 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: forceDelete Location: Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/extensions.json#L192 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/kubernetesconfiguration.json#L530 |
|
'identity' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: common-types/resource-management/v2/types.json#L158 |
|
'sku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: common-types/resource-management/v2/types.json#L165 |
|
'plan' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: common-types/resource-management/v2/types.json#L172 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"kubernetesconfiguration/resource-manager/readme.md",
"tag":"package-preview-2021-05",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"kubernetesconfiguration/resource-manager/readme.md",
"tag":"package-preview-2021-05",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"kubernetesconfiguration/resource-manager/readme.md",
"tag":"package-preview-2021-05",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
...rce-manager/Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/extensionTypes.json
Outdated
Show resolved
Hide resolved
...Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/examples/GetExtensionTypes.json
Outdated
Show resolved
Hide resolved
Hi @carlocardella, Your PR has some issues. Please fix the CI sequentially by following the order of
|
- rename and update example files - fix validation errors
- generate example files with oav - try to fix some new validation errors
@@ -1,724 +0,0 @@ | |||
{ | |||
"swagger": "2.0", | |||
"info": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why remove this file ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do not want to expose these for this API version, should I include it anyway?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we know why we have this in first place as this is new API version and folder?
In reply to: 603394448 [](ancestors = 603394448)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the branch for this API version was created based on an older version, therefore those files were present in this branch as well
…ration-2021-05-01-preview' of https://github.com/Azure/azure-rest-api-specs into dev-kubernetesconfiguration-Microsoft.KubernetesConfiguration-2021-05-01-preview
Hi @carlocardella, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
- revert changes to types.json
@ArcturusZhang could you please help me resolve the errors for the Powershell and Python SDKs? The error is not clear to me, I've been trying to find a good reference in the docs without luck |
Unfortunately python pipeline failure is a known issue and fixing in progress. @dolauli could you help on the powershell failure here? |
@ArcturusZhang, @dolauli, if you guys do not have other comments about the PR content, would it be possible to skip those failing tests since it's a known pipeline issue not depending on my changes? |
...rce-manager/Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/extensionTypes.json
Show resolved
Hide resolved
Please go through the contribution checklist for ARM API Review added as part of the review and mark them completed. It will help you fix most of the issues and improve the quality of swagger and help close the PR faster. This is a requirement before review can be continued. |
Hi, @carlocardella your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @jianyexi |
Thanks, updated |
....KubernetesConfiguration/preview/2021-05-01-preview/examples/ClusterExtensionTypes_List.json
Show resolved
Hide resolved
....KubernetesConfiguration/preview/2021-05-01-preview/examples/ClusterExtensionTypes_List.json
Show resolved
Hide resolved
...KubernetesConfiguration/preview/2021-05-01-preview/examples/LocationExtensionTypes_List.json
Show resolved
Hide resolved
I see @varun has already reviewed the PR extensively. 😊 I’ve some non blocking questions which I’ve put on the PR, approving the PR from ARM side please follow the process given @ https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/212/Swagger-PR-Review to complete and get the PR merged. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
5e308b0
into
Azure:dev-kubernetesconfiguration-Microsoft.KubernetesConfiguration-2021-05-01-preview
…5 01 preview (#14302) * Adds base for updating Microsoft.KubernetesConfiguration from version preview/2020-07-01-preview to version 2021-05-01-preview * Updates readme * Updates API version in new specs and examples * Add Extensions Async API and other fixes (#13709) * Add Extensions Async API and other fixes * Re-add missed out changes * Fix validation errors, remove UpdateExtension.json * Update Readme.md * Add back files removed accidentally * Revert accidental changes & fix readme.md * Remove SourceControlConfig from this api version * Fix Readme.md error for go package * Fix Go readme issues * Fix Go readme issues - revert accidental change * Fix Go readme issues * Add kubernetesconfiguration GA version to this version Tag for SDK * Fix Operations api descriptions * Fix spelling mistakes * Update ApiVersionParameter reference in kubernetesconfiguration * Fix review suggestions * Add SourceControlConfiguration resourceType to this api-version * Updated readme files for the added SourceControlConfiguration resource type * Fix readme files to revert to previous + additions for new api-version * Consolidated common definitions to avoid duplication errors * Rename definitions folder - fix Avocado error * Consolidated common definitions reference * Fix definitions.json * Fix go readme * Revert "Add Extensions Async API and other fixes (#13709)" (#13972) This reverts commit b78af6e. * Dev kubernetesconfiguration microsoft.kubernetes configuration 2021 05 01 preview (#13992) * Add Extensions Async API and other fixes * Re-add missed out changes * Fix validation errors, remove UpdateExtension.json * Update Readme.md * Add back files removed accidentally * Revert accidental changes & fix readme.md * Remove SourceControlConfig from this api version * Fix Readme.md error for go package * Fix Go readme issues * Fix Go readme issues - revert accidental change * Fix Go readme issues * Add kubernetesconfiguration GA version to this version Tag for SDK * Fix Operations api descriptions * Fix spelling mistakes * Update ApiVersionParameter reference in kubernetesconfiguration * Fix review suggestions * Add SourceControlConfiguration resourceType to this api-version * Updated readme files for the added SourceControlConfiguration resource type * Fix readme files to revert to previous + additions for new api-version * Consolidated common definitions to avoid duplication errors * Rename definitions folder - fix Avocado error * Consolidated common definitions reference * Fix definitions.json * Fix go readme * Remove extensions resource in the route of ListAsyncOperations at Cluster scope * Remove extension parameter in the spec * Remove extension parameter from route of ListAsycOperations * Add Origin property to Available Operations response body * Make Identity property nullable * Add Get, List Extension Types (#13562) * Add Get, List Extension Types * style check fixes * - update spec - rename and update example files - fix validation errors * fix examples * - update readme.md - generate example files with oav - try to fix some new validation errors * more validation fixes * add ExtensionTypeVersion_List * - update readme for SDKs - update examples * fix typo and linting * rename ExtensionTypeVersions_List * - address comments - update list extension versions based on location * fix list versions route * fix tag and unused parameters in spec file * fix autorest validatoin errors * udpate readme * update readme * try to fix sdk validation warnings * - prettier fix - revert changes to types.json * fix pageable missing itemName Co-authored-by: Carlo Cardella <carloc@microsoft.com> Co-authored-by: chunyu3 <chunyu@microsoft.com>
…5 01 preview (Azure#14302) * Adds base for updating Microsoft.KubernetesConfiguration from version preview/2020-07-01-preview to version 2021-05-01-preview * Updates readme * Updates API version in new specs and examples * Add Extensions Async API and other fixes (Azure#13709) * Add Extensions Async API and other fixes * Re-add missed out changes * Fix validation errors, remove UpdateExtension.json * Update Readme.md * Add back files removed accidentally * Revert accidental changes & fix readme.md * Remove SourceControlConfig from this api version * Fix Readme.md error for go package * Fix Go readme issues * Fix Go readme issues - revert accidental change * Fix Go readme issues * Add kubernetesconfiguration GA version to this version Tag for SDK * Fix Operations api descriptions * Fix spelling mistakes * Update ApiVersionParameter reference in kubernetesconfiguration * Fix review suggestions * Add SourceControlConfiguration resourceType to this api-version * Updated readme files for the added SourceControlConfiguration resource type * Fix readme files to revert to previous + additions for new api-version * Consolidated common definitions to avoid duplication errors * Rename definitions folder - fix Avocado error * Consolidated common definitions reference * Fix definitions.json * Fix go readme * Revert "Add Extensions Async API and other fixes (Azure#13709)" (Azure#13972) This reverts commit b78af6e. * Dev kubernetesconfiguration microsoft.kubernetes configuration 2021 05 01 preview (Azure#13992) * Add Extensions Async API and other fixes * Re-add missed out changes * Fix validation errors, remove UpdateExtension.json * Update Readme.md * Add back files removed accidentally * Revert accidental changes & fix readme.md * Remove SourceControlConfig from this api version * Fix Readme.md error for go package * Fix Go readme issues * Fix Go readme issues - revert accidental change * Fix Go readme issues * Add kubernetesconfiguration GA version to this version Tag for SDK * Fix Operations api descriptions * Fix spelling mistakes * Update ApiVersionParameter reference in kubernetesconfiguration * Fix review suggestions * Add SourceControlConfiguration resourceType to this api-version * Updated readme files for the added SourceControlConfiguration resource type * Fix readme files to revert to previous + additions for new api-version * Consolidated common definitions to avoid duplication errors * Rename definitions folder - fix Avocado error * Consolidated common definitions reference * Fix definitions.json * Fix go readme * Remove extensions resource in the route of ListAsyncOperations at Cluster scope * Remove extension parameter in the spec * Remove extension parameter from route of ListAsycOperations * Add Origin property to Available Operations response body * Make Identity property nullable * Add Get, List Extension Types (Azure#13562) * Add Get, List Extension Types * style check fixes * - update spec - rename and update example files - fix validation errors * fix examples * - update readme.md - generate example files with oav - try to fix some new validation errors * more validation fixes * add ExtensionTypeVersion_List * - update readme for SDKs - update examples * fix typo and linting * rename ExtensionTypeVersions_List * - address comments - update list extension versions based on location * fix list versions route * fix tag and unused parameters in spec file * fix autorest validatoin errors * udpate readme * update readme * try to fix sdk validation warnings * - prettier fix - revert changes to types.json * fix pageable missing itemName Co-authored-by: Carlo Cardella <carloc@microsoft.com> Co-authored-by: chunyu3 <chunyu@microsoft.com>
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.