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

Cherry latest stable branch change to preview API version #27063

Merged
merged 9 commits into from
Dec 13, 2023

fix lint

fa83697
Select commit
Loading
Failed to load commit list.
Merged

Cherry latest stable branch change to preview API version #27063

fix lint
fa83697
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Dec 13, 2023 in 11m 58s

Swagger LintDiff succeeded

LintDiff
View build log for more details.

Details

compared tags (via openapi-validator v2.1.6) new version base version
package-preview-2024-01 package-preview-2024-01(fa83697) package-preview-2024-01(dev-appplatform-Microsoft.AppPlatform-2024-01-01-preview)

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

Rule Message Related RPC [For API reviewers]
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L2160
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L2160
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L2160
⚠️ LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L8486		 RPC-Async-V1-05


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

Rule Message
❌ 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.AppPlatform/preview/2024-01-01-preview/appplatform.json#L63
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L69
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L105
❌ 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.AppPlatform/preview/2024-01-01-preview/appplatform.json#L134
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L158
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L184
❌ UnSupportedPatchProperties Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. These properties are not patchable.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L197
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L214
❌ PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L410
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L431
❌ NoErrorCodeResponses Invalid status code specified. Please refer to the documentation for the allowed set.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L434
❌ NoErrorCodeResponses Invalid status code specified. Please refer to the documentation for the allowed set.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L438
❌ PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L458
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L479
❌ NoErrorCodeResponses Invalid status code specified. Please refer to the documentation for the allowed set.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L482
❌ NoErrorCodeResponses Invalid status code specified. Please refer to the documentation for the allowed set.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L486
❌ PostResponseCodes 200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L641
❌ PostResponseCodes 200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L701
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L855
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1007
❌ EvenSegmentedPathForPutOperation API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments).
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1048
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1049
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1095
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1159
❌ EvenSegmentedPathForPutOperation API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments).
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1218
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1219
❌ ProvisioningStateSpecifiedForLROPut 201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1262
❌ 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.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1262
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1268
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1298
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1327
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1357
❌ PathForResourceAction Path for 'post' method on a resource type MUST follow valid resource naming.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1381
❌ PostResponseCodes 202 response for a LRO POST operation must not have a response schema specified.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1382
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1418
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1492
❌ 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.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1545
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1572
❌ PostResponseCodes 202 response for a LRO POST operation must not have a response schema specified.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1639
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1678
❌ ResourceNameRestriction The resource name parameter 'serviceRegistryName' should be defined with a 'pattern' restriction.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1768
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1818
❌ 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.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1862
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L1889
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L2050
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L2248
❌ RequestBodyMustExistForPutPatch The put or patch operation does not have a request body defined. This is not allowed. Please specify a request body for this operation.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L2446
❌ OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'BuildService' 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.AppPlatform/preview/2024-01-01-preview/appplatform.json#L2627
❌ ResourceNameRestriction The resource name parameter 'buildServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.AppPlatform/preview/2024-01-01-preview/appplatform.json#L2666
❌ OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'BuildService' 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.AppPlatform/preview/2024-01-01-preview/appplatform.json#L2672
View more details on openapi-pipeline-app