Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Enable Async Operation for ConnectedEnvironment SubResources #30782

Merged
merged 6 commits into from
Oct 11, 2024

Fixes for comments

986837b
Select commit
Loading
Failed to load commit list.
Merged

Enable Async Operation for ConnectedEnvironment SubResources #30782

Fixes for comments
986837b
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Oct 11, 2024 in 4m 37s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.3) new version base version
package-preview-2024-10 package-preview-2024-10(986837b) package-preview-2024-10(release-app-Microsoft.App-2024-10-02-preview)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ EnumInsteadOfBoolean 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.App/preview/2024-10-02-preview/CommonDefinitions.json#L849
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsDaprComponents.json#L337


The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.

Rule Message
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json#L310
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json#L473
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json#L522
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json#L1207
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json#L1696
❌ ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L100
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L198
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L208
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L255
❌ ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L311
❌ ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsCertificates.json#L18
❌ ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsCertificates.json#L68
❌ ResourceNameRestriction The resource name parameter 'certificateName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsCertificates.json#L68
❌ ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsDaprComponents.json#L18
❌ ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsDaprComponents.json#L67
❌ ResourceNameRestriction The resource name parameter 'componentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsDaprComponents.json#L67
❌ ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsDaprComponents.json#L252
❌ ResourceNameRestriction The resource name parameter 'componentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsDaprComponents.json#L252
❌ ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsStorages.json#L18
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsStorages.json#L19
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsStorages.json#L47
❌ ResourceNameRestriction The resource name parameter 'connectedEnvironmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsStorages.json#L65
❌ ResourceNameRestriction The resource name parameter 'storageName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironmentsStorages.json#L65
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json#L168
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json#L242
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json#L387
⚠️ EnumInsteadOfBoolean 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.App/preview/2024-10-02-preview/CommonDefinitions.json#L1227
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json#L1407
⚠️ EnumInsteadOfBoolean 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.App/preview/2024-10-02-preview/CommonDefinitions.json#L1488
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-10-02-preview/CommonDefinitions.json#L1558
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L19
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L28
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L31
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L67
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L70
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L73
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L109
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L112
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L122
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L157
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L160
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L179
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L208
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L221
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L224
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L234
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L274
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L277
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L287
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ConnectedEnvironments.json#L321
View more details on openapi-pipeline-app