Ariflakhani/add plan is system extension property #21188
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @Arif-lakhani 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.1)] | new version | base version |
|---|---|---|
| extensions.json | 2022-11-01(2debfda) | 2022-07-01(main) |
| extensions.json | 2022-11-01(2debfda) | 2022-04-02-preview(main) |
| fluxconfiguration.json | 2022-11-01(2debfda) | 2022-07-01(main) |
| fluxconfiguration.json | 2022-11-01(2debfda) | 2022-01-01-preview(main) |
| kubernetesconfiguration.json | 2022-11-01(2debfda) | 2022-07-01(main) |
| kubernetesconfiguration.json | 2022-11-01(2debfda) | 2022-01-01-preview(main) |
| operations.json | 2022-11-01(2debfda) | 2022-07-01(main) |
| operations.json | 2022-11-01(2debfda) | 2022-01-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version is missing a property found in the old version. Was 'installedVersion' renamed or removed? New: Microsoft.KubernetesConfiguration/stable/2022-11-01/extensions.json#L491:11 Old: Microsoft.KubernetesConfiguration/stable/2022-07-01/extensions.json#L485:11 |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-11 | package-2022-11(2debfda) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| 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/stable/2022-11-01/extensions.json#L198 |
|
| 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/stable/2022-11-01/fluxconfiguration.json#L264 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: insecure Location: Microsoft.KubernetesConfiguration/stable/2022-11-01/fluxconfiguration.json#L569 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: insecure Location: Microsoft.KubernetesConfiguration/stable/2022-11-01/fluxconfiguration.json#L615 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: clientCertificateSendChain Location: Microsoft.KubernetesConfiguration/stable/2022-11-01/fluxconfiguration.json#L791 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: clientCertificateSendChain Location: Microsoft.KubernetesConfiguration/stable/2022-11-01/fluxconfiguration.json#L831 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: prune Location: Microsoft.KubernetesConfiguration/stable/2022-11-01/fluxconfiguration.json#L905 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: force Location: Microsoft.KubernetesConfiguration/stable/2022-11-01/fluxconfiguration.json#L910 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: prune Location: Microsoft.KubernetesConfiguration/stable/2022-11-01/fluxconfiguration.json#L954 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: force Location: Microsoft.KubernetesConfiguration/stable/2022-11-01/fluxconfiguration.json#L959 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.KubernetesConfiguration' for api version '2022-11-01'. The supported api-versions are '2019-11-01-preview, 2020-07-01-preview, 2020-10-01-preview, 2021-03-01, 2021-05-01-preview, 2021-06-01-preview, 2021-09-01, 2021-11-01-preview, 2021-12-01-preview, 2022-01-01-preview, 2022-03-01'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi, @Arif-lakhani your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
Hi @Arif-lakhani, 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. |
This was referenced Oct 19, 2022
7e55287 to
227b247
Compare
556f1bd to
4d0790e
Compare
…ps://github.com/Arif-lakhani/azure-rest-api-specs into ariflakhani/add-plan-isSystemExtension-property
899433a to
46cb7e2
Compare
46cb7e2 to
a516063
Compare
| "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../common/2022-03-01/parameters.json#/parameters/ClusterRpParameter" |
zizw123
reviewed
Oct 26, 2022
| "description": "Flag to note if this extension is a system extension", | ||
| "type": "boolean", | ||
| "default": false | ||
| } |
There was a problem hiding this comment.
Consider if you can use enum over boolean #Resolved
There was a problem hiding this comment.
The property is a read-only property and we do not foresee new values.
zizw123
reviewed
Oct 26, 2022
| }, | ||
| "plan": { | ||
| "description": "The plan information.", | ||
| "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Plan" |
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
|
Hi, @Arif-lakhani, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
This was referenced Nov 12, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Nov 12, 2022
…tension property (#2659) Create to sync Azure/azure-rest-api-specs#21188 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/kubernetesconfiguration?expand=1)
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
* Copied API version 2022-07-01 to 2022-11-01 * updating the API version to 2022-11-01 * udpated plan info and isSystemExtension property * Add tags for packages * Add currentVersion, deprecate installedVersion * Remove deprecated from installed version * Build error fixes * Seperate Get extension with plan and add current version property to examples * Remove Installed Version Co-authored-by: Arif Lakhani <ariflakhani@microsoft.com> Co-authored-by: Nikko Miu <nikkomiu@microsoft.com>
kayousef-zz
pushed a commit
to kayousef-zz/azure-rest-api-specs
that referenced
this pull request
Dec 21, 2022
* Copied API version 2022-07-01 to 2022-11-01 * updating the API version to 2022-11-01 * udpated plan info and isSystemExtension property * Add tags for packages * Add currentVersion, deprecate installedVersion * Remove deprecated from installed version * Build error fixes * Seperate Get extension with plan and add current version property to examples * Remove Installed Version Co-authored-by: Arif Lakhani <ariflakhani@microsoft.com> Co-authored-by: Nikko Miu <nikkomiu@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.