-
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
New GA version changes - 2021-10-01 #15956
Conversation
Hi, @sirireddy12 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 |
[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 Validation Report
|
Rule | Message |
---|---|
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/stable/2021-10-01/connectedClusters.json#L241 |
|
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/stable/2021-10-01/connectedClusters.json#L746 |
|
The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Microsoft.Kubernetes/stable/2021-10-01/connectedClusters.json#L751 |
|
'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/stable/2021-10-01/connectedClusters.json#L727 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Kubernetes/stable/2021-10-01/connectedClusters.json#L563 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L576 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Kubernetes/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Kubernetes/stable/2021-10-01/connectedClusters.json#L382 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Kubernetes/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L395 |
R4037 - MissingTypeObject |
The schema 'OperationList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/stable/2021-10-01/connectedClusters.json#L420 |
R4037 - MissingTypeObject |
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/stable/2021-10-01/connectedClusters.json#L446 |
R4037 - MissingTypeObject |
The schema 'CredentialResults' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/stable/2021-10-01/connectedClusters.json#L626 |
R4037 - MissingTypeObject |
The schema 'HybridConnectionConfig' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/stable/2021-10-01/connectedClusters.json#L701 |
R4037 - MissingTypeObject |
The schema 'OperationList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L433 |
R4037 - MissingTypeObject |
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L459 |
R4037 - MissingTypeObject |
The schema 'CredentialResults' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L656 |
R4037 - MissingTypeObject |
The schema 'HybridConnectionConfig' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L748 |
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/stable/2021-10-01/connectedClusters.json#L385 |
|
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/2021-04-01-preview/connectedClusters.json#L398 |
|
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/stable/2021-10-01/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/stable/2021-10-01/connectedClusters.json#L97 |
|
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/stable/2021-10-01/connectedClusters.json#L150 |
|
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/stable/2021-10-01/connectedClusters.json#L191 |
|
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/stable/2021-10-01/connectedClusters.json#L302 |
|
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/stable/2021-10-01/connectedClusters.json#L345 |
|
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/2021-04-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/2021-04-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/2021-04-01-preview/connectedClusters.json#L163 |
|
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/2021-04-01-preview/connectedClusters.json#L204 |
|
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/2021-04-01-preview/connectedClusters.json#L254 |
|
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/2021-04-01-preview/connectedClusters.json#L315 |
|
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/2021-04-01-preview/connectedClusters.json#L358 |
|
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/2021-04-01-preview/connectedClusters.json#L846 |
|
The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L851 |
|
'ListClusterUserCredentialsProperties' 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/2021-04-01-preview/connectedClusters.json#L827 |
️️✔️
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: 7 Warnings warning [Detail]
- Compared Swaggers (Based on Oad v0.9.0)
- current:stable/2021-10-01/connectedClusters.json compared with base:stable/2021-03-01/connectedClusters.json
- current:stable/2021-10-01/connectedClusters.json compared with base:preview/2021-04-01-preview/connectedClusters.json
️️✔️
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
️️✔️
[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).
Swagger Generation Artifacts
|
Hi @sirireddy12, Your PR has some issues. Please fix the CI sequentially by following the order of
|
...soft.Kubernetes/stable/2021-10-01/examples/ConnectedClustersListClusterCredentialResult.json
Outdated
Show resolved
Hide resolved
...ubernetes/stable/2021-10-01/examples/ConnectedClustersListClusterCredentialResultNonAad.json
Outdated
Show resolved
Hide resolved
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 file names are little confusing.
Refers to: specification/hybridkubernetes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/examples/ConnectedClustersListClusterCredentialsResult.json:1 in 3c5ef91. [](commit_id = 3c5ef91, deletion_comment = True) |
...soft.Kubernetes/stable/2021-10-01/examples/ConnectedClustersListClusterCredentialResult.json
Outdated
Show resolved
Hide resolved
Hi, @sirireddy12 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
We have taken the current GA api-version as base with no change from here. Hope this helps. |
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.
Signed off from ARM side.
Yes, it does. Thanks! |
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 apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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.