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

[Microsoft.app] Release app microsoft.app 2024 10 02 preview #31066

Open
wants to merge 46 commits into
base: main
Choose a base branch
from
+35,294 −2

Add jijohn14 as owner (#31183)

d18821b
Select commit
Loading
Failed to load commit list.
Open

[Microsoft.app] Release app microsoft.app 2024 10 02 preview #31066

Add jijohn14 as owner (#31183)
d18821b
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Oct 25, 2024 in 6m 14s

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(d18821b) default(main)

[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#L884
⚠️ 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
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerAppsLabelHistory.json#L18		 RPC-Get-V1-11
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerAppsLabelHistory.json#L27
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerAppsLabelHistory.json#L30
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerAppsLabelHistory.json#L36
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerAppsLabelHistory.json#L80
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerAppsLabelHistory.json#L83
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerAppsLabelHistory.json#L97
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-10-02-preview/ContainerAppsLabelHistory.json#L132
⚠️ XmsIdentifierValidation Missing identifier label in array item property
Location: Microsoft.App/preview/2024-10-02-preview/ContainerAppsLabelHistory.json#L136
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HttpRouteConfigModel'. Consider using the plural form of 'HttpRouteConfig' 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.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L24
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L27
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L30
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L39
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HttpRouteConfigModel'. Consider using the plural form of 'HttpRouteConfig' 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.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L67
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L70
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L73
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L90
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HttpRouteConfigModel'. Consider using the plural form of 'HttpRouteConfig' 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.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L132
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L135
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L138
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L164
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HttpRouteConfigModel'. Consider using the plural form of 'HttpRouteConfig' 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.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L192
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L195
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L198
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L207
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L231		 RPC-Get-V1-11
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'HttpRouteConfigModel'. Consider using the plural form of 'HttpRouteConfig' 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.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L237
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L240
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L243
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L249
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L287
⚠️ XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L295
⚠️ XmsIdentifierValidation Missing identifier name in array item property
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L318
⚠️ 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/ManagedEnvironmentsHttpRouteConfig.json#L394
⚠️ XmsIdentifierValidation Missing identifier name in array item property
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L428
⚠️ XmsIdentifierValidation Missing identifier name in array item property
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsHttpRouteConfig.json#L438
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.App/preview/2024-10-02-preview/ManagedEnvironmentsMaintenanceConfigurations.json#L18		 RPC-Get-V1-11


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

Rule Message
❌ ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/AuthConfigs.json#L18
❌ ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/AuthConfigs.json#L67
❌ ResourceNameRestriction The resource name parameter 'authConfigName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/AuthConfigs.json#L67
❌ PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.App/preview/2024-10-02-preview/AuthConfigs.json#L119
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.App/preview/2024-10-02-preview/AuthConfigs.json#L570
❌ DefinitionsPropertiesNamesCamelCase Property name should be camel case.
Location: Microsoft.App/preview/2024-10-02-preview/AuthConfigs.json#L616
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.App/preview/2024-10-02-preview/BillingMeters.json#L16
❌ 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/BillingMeters.json#L37
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.App/preview/2024-10-02-preview/Builders.json#L246
❌ 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#L315
❌ 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#L508
❌ 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#L557
❌ 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#L1242
❌ 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#L1731
❌ 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
❌ ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L99
❌ GetResponseCodes GET operation must have response codes 200 and default. In addition, can have 202 if the GET represents the location header polling url.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L100
❌ NoErrorCodeResponses Invalid status code specified. Please refer to the documentation for the allowed set.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L131
❌ 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/ContainerApps.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/ContainerApps.json#L227
❌ 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/ContainerApps.json#L270
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L310
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:activeRevisionsMode.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L310
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:transport.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L310
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:allowedOrigins.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L310
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:appProtocol.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L310
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L310
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:maxReplicas.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L310
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:location.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L310
❌ 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/ContainerApps.json#L336
❌ ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L348
❌ ParametersInPost customHostname is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L355
❌ ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2024-10-02-preview/ContainerApps.json#L400
View more details on openapi-pipeline-app