Introduce new preview api-version 2022-05-01-preview for Microsoft.Kubernetes #19184
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
added 2 commits
May 23, 2022 19:24
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The integer type does not have a format, please add it. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L566 |
|
The response schema of operations API '/providers/Microsoft.Kubernetes/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L385 |
|
The schema 'OperationList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L423 |
|
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L449 |
|
The schema 'CredentialResults' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L646 |
|
The schema 'HybridConnectionConfig' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L721 |
|
Missing identifier id in array item property Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L426 |
|
Missing identifier id in array item property Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L653 |
| Since operation 'Operations_Get' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L388 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L34 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L100 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L153 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L194 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L244 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L305 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L348 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: clientProxy Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L819 |
|
| The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L824 |
|
| 'ListClusterUserCredentialProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L800 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetClustersExample Location: Microsoft.Kubernetes/preview/2022-05-01-preview/connectedClusters.json#L353 |
️️✔️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.Kubernetes' for api version '2022-05-01-preview'. The supported api-versions are '2019-09-01-privatepreview, 2019-11-01-preview, 2020-01-01-preview, 2021-03-01, 2021-04-01-preview, 2021-10-01'." |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 5 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.5)
- current:preview/2022-05-01-preview/connectedClusters.json compared with base:stable/2021-10-01/connectedClusters.json
- current:preview/2022-05-01-preview/connectedClusters.json compared with base:preview/2021-04-01-preview/connectedClusters.json
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
This was referenced May 23, 2022
|
@akashkeshari , one minor comment: Instead of updating api version in each example, should we have two diff files for Get (with GA api version & preview api version). As rest of functionality is not impacted with this swagger, should we refer GA api version for other operations rather than preview? |
jorgecotillo
added
the
ARMSignedOff
All example files for a given api version are present under their respective api-version folder itself. So, there are already example files for both GA & preview api-version (under their respective directories) |
ArcturusZhang
added
the
Approved-OkToMerge
ruowan
approved these changes
May 24, 2022
|
RPaaS RP APIReadinessCheck can be ignored. |
This was referenced May 24, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
May 24, 2022
…5-01-preview for Microsoft.Kubernetes (#2383) Create to sync Azure/azure-rest-api-specs#19184 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/hybridkubernetes?expand=1)
gargankit-microsoft
pushed a commit
that referenced
this pull request
May 26, 2022
…bernetes (#19184) * copied the base api-version(2021-10-01) to the new api-version(2022-05-01-preview) folder * made changes for the new api-version (2022-05-01-preview) * updated clusterName field in an example file Co-authored-by: Akash Keshari <[email protected]>
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for 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
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the 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.