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

hdinsight: documenting the cluster kind #26838

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tombuildsstuff
Copy link
Contributor

ARM (Control Plane) API Specification Update Pull Request

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 (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:

  • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
  • You believe there is no need for you to request breaking change approval, for any reason.
    Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.
Click here to see the diagram footnotes

Diagram footnotes

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (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 swagger quality issues in S360.
  • Other, please clarify:
    • There's a fixed list of possible values for this field - making this an enum - as such this should be documented as an Enum. From the portal these are:

Screenshot 2023-11-24 at 11 23 14

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
Swagger-Suppression-Process
to get approval.

Getting help

  • For general PR approval workflow, see the diagram at the top of this comment.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • 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 Nov 24, 2023

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes (label: BreakingChangeReviewRequired). See the PR description for help.
  • ❌ The required check named Swagger SpellCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

Copy link

openapi-pipeline-app bot commented Nov 24, 2023

Swagger Validation Report

️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
cluster.json 2023-04-15-preview(2005e96) 2023-04-15-preview(main)
cluster.json 2023-08-15-preview(2005e96) 2023-08-15-preview(main)
cluster.json 2018-06-01-preview(2005e96) 2018-06-01-preview(main)
cluster.json 2021-06-01(2005e96) 2021-06-01(main)
Rule Message
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:9
Old: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:9
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.HDInsight/preview/2023-08-15-preview/cluster.json#L754:9
Old: Microsoft.HDInsight/preview/2023-08-15-preview/cluster.json#L754:9
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json#L750:9
Old: Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json#L750:9
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.HDInsight/stable/2021-06-01/cluster.json#L754:9
Old: Microsoft.HDInsight/stable/2021-06-01/cluster.json#L754:9
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-2018-06-preview package-2018-06-preview(2005e96) package-2018-06-preview(main)
package-2023-08-preview package-2023-08-preview(2005e96) package-2023-08-preview(main)
package-2023-04-preview package-2023-04-preview(2005e96) package-2023-04-preview(main)
package-2021-06 package-2021-06(2005e96) package-2021-06(main)

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 'clusterName' should be defined with a 'pattern' restriction.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L37
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.HDInsight/preview/2023-04-15-preview/cluster.json#L38
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: 'Clusters_Create' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema'
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L38
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.HDInsight/preview/2023-04-15-preview/cluster.json#L38
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L109
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L112
PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L151
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L162
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.HDInsight/preview/2023-04-15-preview/cluster.json#L176
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L202
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L205
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L208
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L252
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L291
ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L309
ResourceNameRestriction The resource name parameter 'roleName' should be defined with a 'pattern' restriction.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L309
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.HDInsight/preview/2023-04-15-preview/cluster.json#L310
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L359
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L362
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L368
ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L378
ResourceNameRestriction The resource name parameter 'roleName' should be defined with a 'pattern' restriction.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L378
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.HDInsight/preview/2023-04-15-preview/cluster.json#L379
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L434
LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L437
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L443
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L474
ResourceNameRestriction The resource name parameter 'clusterName' should be defined with a 'pattern' restriction.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L492
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.HDInsight/preview/2023-04-15-preview/cluster.json#L493
DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
Location: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L528
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 105 Errors, 0 Warnings failed [Detail]

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

Rule Message
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateLinuxHadoopSshPassword.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateLinuxHadoopSshPublicKey.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Spark
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateLinuxSparkSshPassword.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateLinuxHadoopSecureHadoop.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateLinuxHadoopAdlsGen2.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAutoscaleConfig.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: kafka
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateKafkaClusterWithKafkaRestProxy.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithTLS12.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithTLS12.json#L97:21
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json#L99:21
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionAtHost.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionAtHost.json#L99:21
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithCustomNetworkProperties.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithCustomNetworkProperties.json#L109:21
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithComputeIsolationProperties.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithComputeIsolationProperties.json#L101:21
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAvailabilityZones.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAvailabilityZones.json#L146:21
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/PatchLinuxHadoopCluster.json#L31:21
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/GetLinuxHadoopCluster.json#L24:21
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json#L25:25
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json#L104:25
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/GetLinuxHadoopAllClusters.json#L24:25
ENUM_CASE_MISMATCH Enum does not match case for: hadoop
Url: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-04-15-preview/examples/GetLinuxHadoopAllClusters.json#L103:25
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-08-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-08-15-preview/examples/CreateLinuxHadoopSshPassword.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-08-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-08-15-preview/examples/CreateLinuxHadoopSshPublicKey.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Spark
Url: Microsoft.HDInsight/preview/2023-08-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-08-15-preview/examples/CreateLinuxSparkSshPassword.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-08-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-08-15-preview/examples/CreateLinuxHadoopSecureHadoop.json#L7:19
ENUM_CASE_MISMATCH Enum does not match case for: Hadoop
Url: Microsoft.HDInsight/preview/2023-08-15-preview/cluster.json#L754:17
ExampleUrl: preview/2023-08-15-preview/examples/CreateLinuxHadoopAdlsGen2.json#L7:19
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌SpellCheck: 4 Errors, 0 Warnings failed [Detail]
Rule Message
HowToFix Unknown word (INTERACTIVEHIVE), please fix the error or add words to ./custom-words.txt
path: Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json#L761:14
HowToFix Unknown word (INTERACTIVEHIVE), please fix the error or add words to ./custom-words.txt
path: Microsoft.HDInsight/preview/2023-08-15-preview/cluster.json#L761:14
HowToFix Unknown word (INTERACTIVEHIVE), please fix the error or add words to ./custom-words.txt
path: Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json#L757:14
HowToFix Unknown word (INTERACTIVEHIVE), please fix the error or add words to ./custom-words.txt
path: Microsoft.HDInsight/stable/2021-06-01/cluster.json#L761:14
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Nov 24, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

azure-sdk-for-go - sdk/resourcemanager/hdinsight/armhdinsight - 1.2.0-beta.2
+	Type of `ClusterDefinition.Kind` has been changed from `*string` to `*ClusterKind`

azure-sdk-for-js - @azure/arm-hdinsight - 2.0.0-beta.1
+	Type of parameter kind of interface ClusterDefinition is changed from string to ClusterKind
️❌ azure-sdk-for-net-track2 failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from 20425c42c014920cd25672bbd1d3c5190ef106fc. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-Content: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:388
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 388 | �[0m       (�[36;1mGet-Content $file�[0m) -replace $rquirefileRex, "$requirefile" | S …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m        ~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/hdinsight/Azure.ResourceManager.HDInsight Azure.ResourceManager.HDInsight.Containers/src/autorest.md' because it does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mResolve-Path: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:392
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 392 | �[0m     $relativeFolderPath = �[36;1mResolve-Path $projectFolder -Relative�[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m                           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/hdinsight/Azure.ResourceManager.HDInsight Azure.ResourceManager.HDInsight.Containers' because it does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 714 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 807 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 714 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    warn	No file changes detected after generation
    the given reference name 'refs/heads/sdkAuto/26838/Azure.ResourceManager.HDInsight Azure.ResourceManager.HDInsight.Containers' is not valid
    Error: the given reference name 'refs/heads/sdkAuto/26838/Azure.ResourceManager.HDInsight Azure.ResourceManager.HDInsight.Containers' is not valid
  • Azure.ResourceManager.HDInsight Azure.ResourceManager.HDInsight.Containers [View full logs
    error	Fatal error: the given reference name 'refs/heads/sdkAuto/26838/Azure.ResourceManager.HDInsight Azure.ResourceManager.HDInsight.Containers' is not valid
    error	The following packages are still pending:
    error		Azure.ResourceManager.HDInsight Azure.ResourceManager.HDInsight.Containers
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 20425c42c014920cd25672bbd1d3c5190ef106fc. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/hdinsight/armhdinsight [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Type of `ClusterDefinition.Kind` has been changed from `*string` to `*ClusterKind`
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New enum type `ClusterKind` with values `ClusterKindHADOOP`, `ClusterKindHBASE`, `ClusterKindINTERACTIVEHIVE`, `ClusterKindKAFKA`, `ClusterKindSPARK`
    info	[Changelog] - New enum type `OutboundDependenciesManagedType` with values `OutboundDependenciesManagedTypeExternal`, `OutboundDependenciesManagedTypeManaged`
    info	[Changelog] - New field `OutboundDependenciesManagedType` in struct `NetworkProperties`
    info	[Changelog]
    info	[Changelog] Total 1 breaking change(s), 10 additive change(s).
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from 20425c42c014920cd25672bbd1d3c5190ef106fc. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-hdinsight [View full logs]  [Preview SDK Changes]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from 20425c42c014920cd25672bbd1d3c5190ef106fc. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh] npm notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.4
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.4` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-hdinsight [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Model NetworkProperties has a new parameter outbound_dependencies_managed_type
    info	[Changelog]   - Model StorageAccount has a new parameter enable_secure_channel
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 20425c42c014920cd25672bbd1d3c5190ef106fc. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-hdinsight [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added Type Alias ClusterKind
    info	[Changelog]   - Added Type Alias OutboundDependenciesManagedType
    info	[Changelog]   - Interface NetworkProperties has a new optional parameter outboundDependenciesManagedType
    info	[Changelog]   - Interface StorageAccount has a new optional parameter enableSecureChannel
    info	[Changelog]   - Added Enum KnownClusterKind
    info	[Changelog]   - Added Enum KnownOutboundDependenciesManagedType
    info	[Changelog]
    info	[Changelog] **Breaking Changes**
    info	[Changelog]
    info	[Changelog]   - Type of parameter kind of interface ClusterDefinition is changed from string to ClusterKind
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from 20425c42c014920cd25672bbd1d3c5190ef106fc. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] npm notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.4
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.2.4` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
  • ️✔️hdinsight [View full logs]  [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from 20425c42c014920cd25672bbd1d3c5190ef106fc. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ️✔️Az.hdinsight.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.hdinsight.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Nov 24, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/hdinsight/armhdinsight Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Java azure-resourcemanager-hdinsight Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
JavaScript @azure/arm-hdinsight Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Swagger Microsoft.HDInsight Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

@microsoft-github-policy-service microsoft-github-policy-service bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Nov 24, 2023
Copy link
Contributor

Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon.

There's a fixed list of possible values for this - making this an enum - as such this should be documented as an Enum.
@tombuildsstuff tombuildsstuff force-pushed the b/hdinsight-kind-should-be-documented branch from 56e95aa to 2005e96 Compare November 24, 2023 10:45
@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 resource-manager labels Nov 24, 2023
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.

tombuildsstuff added a commit to hashicorp/terraform-provider-azurerm that referenced this pull request Nov 24, 2023
… lower-cased due to an issue in the API Spec

The API Specification defines `tier` as a Constant which can be recased - however the `kind` is defined as a string, thus
can't be. I've opened hashicorp/pandora#3404 (to workaround it) and Azure/azure-rest-api-specs#26838
(to fix it) - once those are threaded through both of these should be normalized.
tombuildsstuff added a commit to hashicorp/terraform-provider-azurerm that referenced this pull request Nov 30, 2023
… lower-cased due to an issue in the API Spec

The API Specification defines `tier` as a Constant which can be recased - however the `kind` is defined as a string, thus
can't be. I've opened hashicorp/pandora#3404 (to workaround it) and Azure/azure-rest-api-specs#26838
(to fix it) - once those are threaded through both of these should be normalized.
tombuildsstuff added a commit to hashicorp/terraform-provider-azurerm that referenced this pull request Dec 14, 2023
… lower-cased due to an issue in the API Spec

The API Specification defines `tier` as a Constant which can be recased - however the `kind` is defined as a string, thus
can't be. I've opened hashicorp/pandora#3404 (to workaround it) and Azure/azure-rest-api-specs#26838
(to fix it) - once those are threaded through both of these should be normalized.
tombuildsstuff added a commit to hashicorp/terraform-provider-azurerm that referenced this pull request Dec 14, 2023
… lower-cased due to an issue in the API Spec

The API Specification defines `tier` as a Constant which can be recased - however the `kind` is defined as a string, thus
can't be. I've opened hashicorp/pandora#3404 (to workaround it) and Azure/azure-rest-api-specs#26838
(to fix it) - once those are threaded through both of these should be normalized.
tombuildsstuff added a commit to hashicorp/terraform-provider-azurerm that referenced this pull request Dec 14, 2023
… lower-cased due to an issue in the API Spec

The API Specification defines `tier` as a Constant which can be recased - however the `kind` is defined as a string, thus
can't be. I've opened hashicorp/pandora#3404 (to workaround it) and Azure/azure-rest-api-specs#26838
(to fix it) - once those are threaded through both of these should be normalized.
tombuildsstuff added a commit to hashicorp/terraform-provider-azurerm that referenced this pull request Jan 25, 2024
… lower-cased due to an issue in the API Spec

The API Specification defines `tier` as a Constant which can be recased - however the `kind` is defined as a string, thus
can't be. I've opened hashicorp/pandora#3404 (to workaround it) and Azure/azure-rest-api-specs#26838
(to fix it) - once those are threaded through both of these should be normalized.
tombuildsstuff added a commit to hashicorp/terraform-provider-azurerm that referenced this pull request Jan 26, 2024
… lower-cased due to an issue in the API Spec

The API Specification defines `tier` as a Constant which can be recased - however the `kind` is defined as a string, thus
can't be. I've opened hashicorp/pandora#3404 (to workaround it) and Azure/azure-rest-api-specs#26838
(to fix it) - once those are threaded through both of these should be normalized.
rizkybiz pushed a commit to rizkybiz/terraform-provider-azurerm that referenced this pull request Jan 30, 2024
… lower-cased due to an issue in the API Spec

The API Specification defines `tier` as a Constant which can be recased - however the `kind` is defined as a string, thus
can't be. I've opened hashicorp/pandora#3404 (to workaround it) and Azure/azure-rest-api-specs#26838
(to fix it) - once those are threaded through both of these should be normalized.
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 BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-BreakingChange-JavaScript customer-reported Issues that are reported by GitHub users external to the Azure organization. resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants