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

Merge release api management 2023 09 01 preview - Active #29184

Merged
merged 42 commits into from
Jun 5, 2024

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview

4d3ff9e
Select commit
Loading
Failed to load commit list.
Merged

Merge release api management 2023 09 01 preview - Active #29184

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview
4d3ff9e
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Jun 5, 2024 in 6m 46s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.2) new version base version
package-preview-2023-09 package-preview-2023-09(4d3ff9e) default(main)

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

Rule Message Related RPC [For API reviewers]
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json#L37		 RPC-Get-V1-11
⚠️ RequiredReadOnlySystemData The response of operation:'ApiGatewayConfigConnection_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json#L83
⚠️ RequiredReadOnlySystemData The response of operation:'ApiGatewayConfigConnection_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json#L126
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json#L244
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json#L307
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacebackends.json#L37		 RPC-Get-V1-11
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacecertificates.json#L37		 RPC-Get-V1-11
⚠️ 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.ApiManagement/preview/2023-09-01-preview/apimworkspacecertificates.json#L72
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacediagnostics.json#L37		 RPC-Get-V1-11
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacediagnostics.json#L391		 RPC-Get-V1-11
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspacelinks.json#L37		 RPC-Get-V1-11
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimworkspaceloggers.json#L37		 RPC-Get-V1-11
⚠️ 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.ApiManagement/preview/2023-09-01-preview/definitions.json#L2353
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/definitions.json#L2963
⚠️ 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.ApiManagement/preview/2023-09-01-preview/definitions.json#L3004
⚠️ 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.ApiManagement/preview/2023-09-01-preview/definitions.json#L3084
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/definitions.json#L7989
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/definitions.json#L8013
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/definitions.json#L8056


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

Rule Message
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L96
❌ PutRequestResponseSchemeArm A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Api_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema'
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L215
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L533
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L595
❌ RepeatedPathInfo The 'apiId' already appears in the path, please don't repeat it in the request body.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L732
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L1269
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L1303
❌ ParametersInPointGet Query parameter format should be removed. Point Get's MUST not have query parameters other than api version.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L1380
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L1607
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L1882
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L2226
❌ ParametersInPointGet Query parameter format should be removed. Point Get's MUST not have query parameters other than api version.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L2306
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L2530
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L2548
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L2579
❌ ParametersInPointGet Query parameter format should be removed. Point Get's MUST not have query parameters other than api version.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L2658
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L2876
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L3192
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:loggerId.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L3415
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L3553
❌ ParametersInPointGet Query parameter expandCommentsAttachments should be removed. Point Get's MUST not have query parameters other than api version.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L3631
❌ RepeatedPathInfo The 'apiId' already appears in the path, please don't repeat it in the request body.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L3697
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L3917
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L4222
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L4524
❌ PutRequestResponseSchemeArm A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'ApiTagDescription_CreateOrUpdate' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema'
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L4643
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L4814
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L5096
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapis.json#L5455
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapisByTags.json#L86
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimapiversionsets.json#L79
❌ OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Authorization' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationproviders.json#L280
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationproviders.json#L323
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationproviders.json#L693
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimauthorizationservers.json#L79
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json#L79
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:managementEndpoints.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json#L293
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:scheme.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json#L293
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:parameter.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json#L293
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:url.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json#L293
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:validateCertificateChain.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json#L293
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:validateCertificateName.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json#L293
❌ LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be defined
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json#L377
❌ PostResponseCodes An async POST operation must set ''x-ms-long-running-operation' : true'.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json#L377
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimbackends.json#L415
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimcaches.json#L72
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimcertificates.json#L86
❌ PutRequestResponseSchemeArm A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Certificate_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema'
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimcertificates.json#L202
❌ PathForTrackedResourceTypes The path must be under a subscription and resource group for tracked resource types.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeletedservices.json#L76
❌ ParametersOrder The parameters:serviceName,location should be kept in the same order as they present in the path.
Location: Microsoft.ApiManagement/preview/2023-09-01-preview/apimdeletedservices.json#L77
View more details on openapi-pipeline-app