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

Review request for Microsoft.HybridCompute to add version preview/2024-05-20-preview #29070

Merged
merged 6 commits into from
May 31, 2024

Merge branch 'main' into zhejiao-hybridcompute-Microsoft.HybridComput…

efcfad8
Select commit
Loading
Failed to load commit list.
Merged

Review request for Microsoft.HybridCompute to add version preview/2024-05-20-preview #29070

Merge branch 'main' into zhejiao-hybridcompute-Microsoft.HybridComput…
efcfad8
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded May 29, 2024 in 8m 49s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.2) new version base version
package-preview-2024-05 package-preview-2024-05(efcfad8) 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L2866
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L2870
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L2879
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4044
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4087


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

Rule Message
❌ 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L38
❌ OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Licenses' 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L42
❌ 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L84
❌ 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L84
❌ PatchResponseCodes Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L134
❌ LroPatch202 The async patch operation should return 202.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L163
❌ 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L224
❌ 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L348
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L441
❌ ParametersInPointGet Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L520
❌ ResourceNameRestriction The resource name parameter 'extensionName' should be defined with a 'pattern' restriction.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1103
❌ 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1104
❌ 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1104
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1154
❌ 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1253
❌ 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.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1441
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1617
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1654
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1675
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1705
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L1841
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3090
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3253
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'Machine' has extra properties ['resources'].
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3292
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3295
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3303
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3303
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3366
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3366
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3366
❌ AllTrackedResourcesMustHaveDelete The resource License does not have a corresponding delete operation.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3400
❌ TrackedResourcePatchOperation Tracked resource 'License' must have patch operation that at least supports the update of tags.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L3400
❌ ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'MachineExtension'. Properties [properties.type] conflict with ARM top level properties. Please rename these.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4130
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4133
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4133
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4148
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4148
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4188
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4193
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4237
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4242
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4309
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4309
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4336
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/HybridCompute.json#L4347
❌ 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.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L116
❌ ResourceNameRestriction The resource name parameter 'groupName' should be defined with a 'pattern' restriction.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L356
❌ 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.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L449
❌ 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.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L449
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.HybridCompute/preview/2024-05-20-preview/privateLinkScopes.json#L491
View more details on openapi-pipeline-app