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.

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

Fix merge error #28423

Conversation

curiekim0
Copy link
Contributor

@curiekim0 curiekim0 commented Mar 24, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app bot commented Mar 24, 2024

PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

Copy link

openapi-pipeline-app bot commented Mar 24, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 2 Errors, 5 Warnings failed [Detail]
Compared specs (v0.10.7) new version base version
databricks.json 2024-05-01(3378765) 2023-02-01(main)
databricks.json 2024-05-01(3378765) 2023-09-15-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule Message
1026 - TypeChanged The new version has a different type 'boolean' than the previous one ''.
New: Microsoft.Databricks/stable/2024-05-01/databricks.json#L1261:9
Old: Microsoft.Databricks/stable/2023-02-01/databricks.json#L1063:9
1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.Databricks/stable/2024-05-01/databricks.json#L1183:9
Old: Microsoft.Databricks/stable/2023-02-01/databricks.json#L1003:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Databricks/stable/2024-05-01/databricks.json#L1261:9
Old: Microsoft.Databricks/stable/2023-02-01/databricks.json#L1063:9


The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Databricks/stable/2024-05-01/databricks.json#L1261:9
Old: Microsoft.Databricks/preview/2023-09-15-preview/databricks.json#L1184:9
⚠️ 1026 - TypeChanged The new version has a different type 'boolean' than the previous one ''.
New: Microsoft.Databricks/stable/2024-05-01/databricks.json#L1261:9
Old: Microsoft.Databricks/preview/2023-09-15-preview/databricks.json#L1184:9
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.Databricks/stable/2024-05-01/databricks.json#L1183:9
Old: Microsoft.Databricks/preview/2023-09-15-preview/databricks.json#L1124:9
⚠️ 1046 - RemovedOptionalParameter The optional parameter 'retainUcData' was removed in the new version.
Old: Microsoft.Databricks/preview/2023-09-15-preview/databricks.json#L114:11
️⚠️LintDiff: 2 Warnings warning [Detail]
Compared specs (v2.2.0) new version base version
package-2024-05-01 package-2024-05-01(3378765) package-2024-05-01(curiekim0-databricks-Microsoft.Databricks-2024-05-01)

[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.Databricks/stable/2024-05-01/databricks.json#L1177
⚠️ 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.Databricks/stable/2024-05-01/databricks.json#L1183


The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L37
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.Databricks/stable/2024-05-01/databricks.json#L87
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L127
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L136
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L213
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L258
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L261
OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Databricks/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L374
OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L375
ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L390
ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L436
ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L482
ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L528
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.Databricks/stable/2024-05-01/databricks.json#L573
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.Databricks/stable/2024-05-01/databricks.json#L573
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L620
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L629
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.Databricks/stable/2024-05-01/databricks.json#L634
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L666
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L678
ResourceNameRestriction The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L684
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L685
MissingTypeObject The schema 'Workspace' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L729
MissingTypeObject The schema 'WorkspaceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L757
MissingTypeObject The schema 'TrackedResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L942
MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L975
MissingTypeObject The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L996
MissingTypeObject The schema 'ManagedIdentityConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Databricks/stable/2024-05-01/databricks.json#L1049
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.Databricks/stable/2024-05-01/databricks.json#L1054
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.Databricks/stable/2024-05-01/databricks.json#L1060
️⚠️Avocado: 1 Warnings warning [Detail]
Rule Message
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/databricks/resource-manager/readme.md
tag: specification/databricks/resource-manager/readme.md#tag-package-2024-05-01
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️⌛PR Summary pending [Detail]
️⌛Automated merging requirements met pending [Detail]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Mar 24, 2024

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
Rule Message
RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=420269&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
"detail":"Run.ps1 failed with exit code 128 "
️🔄 azure-sdk-for-python inProgress [Detail]
️🔄 azure-sdk-for-js inProgress [Detail]
️🔄 azure-resource-manager-schemas inProgress [Detail]
️🔄 azure-powershell inProgress [Detail]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Mar 24, 2024

Generated ApiView

Language Package Name ApiView Link
Swagger Microsoft.Databricks https://apiview.dev/Assemblies/Review/f9d12b39de0149c788c5f4055531110f?revisionId=a9037d05fff041f5a9433d6ec6340e68

@curiekim0 curiekim0 changed the base branch from main to curiekim0-databricks-Microsoft.Databricks-2024-05-01 March 24, 2024 17:30
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager labels Mar 24, 2024
Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@curiekim0 curiekim0 merged commit 53063cc into Azure:curiekim0-databricks-Microsoft.Databricks-2024-05-01 Mar 24, 2024
16 of 29 checks passed
madhura-np pushed a commit that referenced this pull request May 7, 2024
* Adds base for updating Microsoft.Databricks from version preview/2023-09-15-preview to version 2024-05-01

* Updates readme

* Updates API version in new specs and examples

* Add swagger spec for default storage firewall (#28152)

* Add custom npip boolean parameter (#28286)

* Add custom npip boolean parameter

* modify npip paramter name

* Force deletion change (#28414)

* modify retainUCData parameter name

* ucdata to forcedeletion

* add default value for Force Deletion (#28418)

* fix merge errors (#28423)

* add access connector (#28445)

* add access connector to the 20240501 version and add referedBy property

* Create sdk-suppressions.yaml

* fix WorkspaceNoPublicIPBooleanParameter type (#28582)

* Update sdk-suppressions.yaml

* Address Comments - use plain English and fix Capitalization (#28917)

* capitalize Azure Databricks Access Connector

* modify to Access Connector

* undo breaking of SystemAssigned and UserAssigned (#28918)

* modify type to commontype (#28939)

* modify subscriptionId format in examples (#28951)

* modify commontype reference to be direct (#28954)

* remove required parameter in workspacenNoPublicIpBooleanpParameter (#28967)

* add back the required parameter and remove default (#28968)

---------

Co-authored-by: kazrael2119 <[email protected]>
Francisco-Gamino pushed a commit to Francisco-Gamino/azure-rest-api-specs that referenced this pull request Jun 5, 2024
* Adds base for updating Microsoft.Databricks from version preview/2023-09-15-preview to version 2024-05-01

* Updates readme

* Updates API version in new specs and examples

* Add swagger spec for default storage firewall (Azure#28152)

* Add custom npip boolean parameter (Azure#28286)

* Add custom npip boolean parameter

* modify npip paramter name

* Force deletion change (Azure#28414)

* modify retainUCData parameter name

* ucdata to forcedeletion

* add default value for Force Deletion (Azure#28418)

* fix merge errors (Azure#28423)

* add access connector (Azure#28445)

* add access connector to the 20240501 version and add referedBy property

* Create sdk-suppressions.yaml

* fix WorkspaceNoPublicIPBooleanParameter type (Azure#28582)

* Update sdk-suppressions.yaml

* Address Comments - use plain English and fix Capitalization (Azure#28917)

* capitalize Azure Databricks Access Connector

* modify to Access Connector

* undo breaking of SystemAssigned and UserAssigned (Azure#28918)

* modify type to commontype (Azure#28939)

* modify subscriptionId format in examples (Azure#28951)

* modify commontype reference to be direct (Azure#28954)

* remove required parameter in workspacenNoPublicIpBooleanpParameter (Azure#28967)

* add back the required parameter and remove default (Azure#28968)

---------

Co-authored-by: kazrael2119 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChange-JavaScript-Sdk BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants