-
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
Microsoft.Kubernetes to add preview version 2024-07-01-preview #29487
Conversation
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
Compared specs (v0.10.12) | new version | base version |
---|---|---|
connectedClusters.json | 2024-07-01-preview(d367735) | 2024-01-01(main) |
connectedClusters.json | 2024-07-01-preview(d367735) | 2024-06-01-preview(main) |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 2 Errors, 9 Warnings failed [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-2024-07-01-preview | package-2024-07-01-preview(d367735) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L932 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L940 |
RPC-Policy-V1-05, RPC-Put-V1-23 |
Missing identifier id in array item property Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L708 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L881 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L885 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L897 |
||
Schema should have a description or title. Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L912 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L915 |
||
Schema should have a description or title. Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L925 |
||
Missing identifier id in array item property Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L972 |
||
Missing identifier id in array item property Location: Microsoft.Kubernetes/preview/2024-07-01-preview/connectedClusters.json#L979 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️❌
Avocado: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/Microsoft.Kubernetes/connectedClusters/{}/listClusterUserCredentials is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/hybridkubernetes/resource-manager/readme.md json: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json |
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
"type": "object", | ||
"description": "The configuration settings for the feature that do not contain any sensitive or secret information.", | ||
"x-nullable": true, | ||
"additionalProperties": { |
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.
This is an ARM anti-pattern and not generally allowed. Please schematize this object (preferred), or use an array of key value pairs if the properties aren't known ahead of time. If your RP doesn't use or validate these properties at all (i.e. they are just passed through to another API), this pattern is allowed.
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 have separated the values that we are using in our RP by introducing gateway parameter, making it a first class property. The other values that will be sent in 'arcAgentryConfigurations'(additional property) param will just be forwarded to another service as pass through.
"description": "The configuration settings for the feature that contain any sensitive or secret information.", | ||
"x-nullable": true, | ||
"x-ms-secret": true, | ||
"additionalProperties": { |
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.
Same issue here.
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.
replied above.
@bavneetsingh16 - Please add the correct template to your PR: #29487 (comment) and fill out the intake form. |
The template generation does not seem to be working for this pr. |
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.
Approving to merge
Choose a PR Template
Switch to "Preview" on this description then select one of the choices below.
Click here to open a PR for a Data Plane API.
Click here to open a PR for a Control Plane (ARM) API.