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

Add diagnostic routes to Container App Jobs #26227

Merged
merged 8 commits into from
Oct 24, 2023

Update operationIds

33e9942
Select commit
Loading
Failed to load commit list.
Merged

Add diagnostic routes to Container App Jobs #26227

Update operationIds
33e9942
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Oct 23, 2023 in 3m 26s

Swagger LintDiff succeeded

LintDiff
View more details.

Details

compared tags (via openapi-validator v2.1.6) new version base version
package-preview-2023-08 package-preview-2023-08(33e9942) package-preview-2023-08(release-app-Microsoft.App-2023-08-01-preview)

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

Rule Message Related RPC [For API reviewers]
⚠️ PageableOperation Based on the response model schema, operation 'Jobs_ListDetectors' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L437
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L447
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L450
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L456
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L491
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L494
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L508
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L533
⚠️ GetInOperationName 'GET' operation 'Jobs_ProxyGet' should use method name 'Get' or Method name start with 'List'. 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/2023-08-01-preview/Diagnostics.json#L540
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L543
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L546
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L560


The following errors/warnings exist before current PR submission:

Rule Message
❌ ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L18
❌ ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L68
❌ ResourceNameRestriction The resource name parameter 'detectorName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L68
❌ ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L122
❌ ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L180
❌ ResourceNameRestriction The resource name parameter 'revisionName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L180
❌ ResourceNameRestriction The resource name parameter 'containerAppName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L234
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L263
❌ NoErrorCodeResponses Invalid status code specified. Please refer to the documentation for the allowed set.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L267
❌ ResourceNameRestriction The resource name parameter 'environmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L285
❌ ResourceNameRestriction The resource name parameter 'environmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L333
❌ ResourceNameRestriction The resource name parameter 'detectorName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L333
❌ ResourceNameRestriction The resource name parameter 'environmentName' should be defined with a 'pattern' restriction.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L388
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L418
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L28
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L31
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L41
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L78
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L81
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L98
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L132
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L135
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L145
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L190
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L193
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L210
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L244
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L247
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L257
⚠️ PageableOperation Based on the response model schema, operation 'ManagedEnvironmentDiagnostics_ListDetectors' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L286
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L296
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L299
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L309
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L344
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L347
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L364
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L399
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L402
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L412
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L612
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.App/preview/2023-08-01-preview/Diagnostics.json#L616
⚠️ 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/2023-08-01-preview/Diagnostics.json#L792
View more details on openapi-pipeline-app