-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Dev kubernetesconfiguration microsoft.kubernetes configuration 2021 05 01 preview #14302
Dev kubernetesconfiguration microsoft.kubernetes configuration 2021 05 01 preview #14302
Conversation
… preview/2020-07-01-preview to version 2021-05-01-preview
* 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
…5 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 * 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
…rnetesConfiguration-2021-05-01-preview
Hi, @NarayanThiru 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 |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/extensions.json#L613 |
|
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 |
|
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 |
|
'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 |
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 |
R4017 - TopLevelResourcesListBySubscription |
The top-level resource 'SourceControlConfiguration' does not have list by subscription operation, please add it. Location: Microsoft.KubernetesConfiguration/stable/2021-03-01/kubernetesconfiguration.json#L426 |
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 |
|
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/stable/2021-03-01/kubernetesconfiguration.json#L564 |
️️✔️
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 Breaking Changes: 77 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- current:preview/2021-05-01-preview/extensions.json compared with base:preview/2020-07-01-preview/extensions.json
- current:preview/2021-05-01-preview/kubernetesconfiguration.json compared with base:preview/2020-10-01-preview/kubernetesconfiguration.json
- current:preview/2021-05-01-preview/kubernetesconfiguration.json compared with base:stable/2021-03-01/kubernetesconfiguration.json
The following breaking changes are detected by comparison with latest preview version:
Only 10 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
[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-2021-03",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"kubernetesconfiguration/resource-manager/readme.md",
"tag":"package-2021-03",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"kubernetesconfiguration/resource-manager/readme.md",
"tag":"package-preview-2021-05",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|: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)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"kubernetesconfiguration/resource-manager/readme.md",
"tag":"package-2021-03",
"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.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Generation Artifacts
|
@NarayanThiru Actually the cross version breaking change detector reported a Line 167 in e16440e
This change is considering a breaking change |
@jianyexi , In previous version I had defined these common types in my branch; and now I updated these to reference the definitions in Common Types. Can you please suggest how to mitigate this? |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
...er/Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/kubernetesconfiguration.json
Show resolved
Hide resolved
...esource-manager/Microsoft.KubernetesConfiguration/preview/2021-05-01-preview/extensions.json
Show resolved
Hide resolved
…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.