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

Release purview microsoft.purview preview/2024 04 01 preview #28792

Merged
merged 3 commits into from
Jun 12, 2024

PR Feedback

ecf736f
Select commit
Loading
Failed to load commit list.
Merged

Release purview microsoft.purview preview/2024 04 01 preview #28792

PR Feedback
ecf736f
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded May 3, 2024 in 4m 22s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.2) new version base version
package-2024-04-01-preview package-2024-04-01-preview(ecf736f) 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.Purview/preview/2024-04-01-preview/purview.json#L1657


The following errors/warnings exist before current PR submission:

Rule Message
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L211
❌ 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.Purview/preview/2024-04-01-preview/purview.json#L222
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L250
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L259
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:managedEventHubState.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L301
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:managedResourcesPublicNetworkAccess.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L301
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:publicNetworkAccess.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L301
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L313
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L322
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L436
❌ GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L453
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L483
❌ PostResponseCodes Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L502
❌ ParametersInPost scopeTenantId is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L512
❌ ParametersInPost scopeType is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L512
❌ ParametersInPost scope is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L512
❌ GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L519
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L1097
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L1283
❌ 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.Purview/preview/2024-04-01-preview/purview.json#L1294
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L1329
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L1338
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L1505
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L1950
❌ XmsParameterLocation The parameter 'subscriptionId' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L3008
❌ XmsParameterLocation The parameter 'api-version' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L3015
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'scope'.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L472
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L502
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'removedefaultaccount' in:'DefaultAccounts_Remove'. Consider updating the operationId
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L508
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'scope'.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L538
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L568
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'setdefaultaccount' in:'DefaultAccounts_Set'. Consider updating the operationId
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L574
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listfeatures' in:'Features_SubscriptionGet'. Consider updating the operationId
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L623
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listfeatures' in:'Features_AccountGet'. Consider updating the operationId
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L682
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'ingestionprivateendpointconnectionstatus' in:'IngestionPrivateEndpointConnections_UpdateStatus'. Consider updating the operationId
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L789
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L1505
⚠️ PageableOperation Based on the response model schema, operation 'Usages_Get' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L1505
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L1521
⚠️ 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.Purview/preview/2024-04-01-preview/purview.json#L1953
⚠️ 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.Purview/preview/2024-04-01-preview/purview.json#L1982
⚠️ 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.Purview/preview/2024-04-01-preview/purview.json#L2161
⚠️ 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.Purview/preview/2024-04-01-preview/purview.json#L2408
⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L2902
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L3010
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L3017
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Purview/preview/2024-04-01-preview/purview.json#L3035
View more details on openapi-pipeline-app