Skip to content

Create readme.java.md to rename wait property#26730

Merged
haolingdong-msft merged 1 commit intomainfrom
haolingdong-msft-patch-2
Nov 17, 2023
Merged

Create readme.java.md to rename wait property#26730
haolingdong-msft merged 1 commit intomainfrom
haolingdong-msft-patch-2

Conversation

@haolingdong-msft
Copy link
Member

@haolingdong-msft haolingdong-msft commented Nov 16, 2023

ARM (Control Plane) API Specification Update Pull Request

Generated code looks fine:
https://github.com/azure-sdk/azure-sdk-for-java/blob/0880ca78b71106e50c5e5f245014c6646ae55db9/sdk/hybridnetwork/azure-resourcemanager-hybridnetwork/src/main/java/com/azure/resourcemanager/hybridnetwork/models/HelmInstallOptions.java#L64-L66

PR review workflow diagram

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

diagram

[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:
    • 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:

Breaking changes review (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.

ARM API changes review (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.

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 16, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 16, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v2.1.6) new version base version
default default(9834953) default(main)
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️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?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 16, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from b456e86. 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-hybridnetwork [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation NetworkFunctionsOperations.begin_execute_request
    info	[Changelog]   - Added operation group ArtifactManifestsOperations
    info	[Changelog]   - Added operation group ArtifactStoresOperations
    info	[Changelog]   - Added operation group ComponentsOperations
    info	[Changelog]   - Added operation group ConfigurationGroupSchemasOperations
    info	[Changelog]   - Added operation group ConfigurationGroupValuesOperations
    info	[Changelog]   - Added operation group NetworkFunctionDefinitionGroupsOperations
    info	[Changelog]   - Added operation group NetworkFunctionDefinitionVersionsOperations
    info	[Changelog]   - Added operation group NetworkServiceDesignGroupsOperations
    info	[Changelog]   - Added operation group NetworkServiceDesignVersionsOperations
    info	[Changelog]   - Added operation group ProxyArtifactOperations
    info	[Changelog]   - Added operation group PublishersOperations
    info	[Changelog]   - Added operation group SiteNetworkServicesOperations
    info	[Changelog]   - Added operation group SitesOperations
    info	[Changelog]   - Model NetworkFunction has a new parameter identity
    info	[Changelog]   - Model NetworkFunction has a new parameter properties
    info	[Changelog]   - Model Operation has a new parameter action_type
    info	[Changelog]   - Model Operation has a new parameter is_data_action
    info	[Changelog]   - Model Operation has a new parameter origin
    info	[Changelog]   - Model ProxyResource has a new parameter system_data
    info	[Changelog]   - Model Resource has a new parameter system_data
    info	[Changelog]   - Model TrackedResource has a new parameter system_data
    info	[Changelog]
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog]   - Model NetworkFunction no longer has parameter device
    info	[Changelog]   - Model NetworkFunction no longer has parameter managed_application
    info	[Changelog]   - Model NetworkFunction no longer has parameter managed_application_parameters
    info	[Changelog]   - Model NetworkFunction no longer has parameter network_function_container_configurations
    info	[Changelog]   - Model NetworkFunction no longer has parameter network_function_user_configurations
    info	[Changelog]   - Model NetworkFunction no longer has parameter provisioning_state
    info	[Changelog]   - Model NetworkFunction no longer has parameter service_key
    info	[Changelog]   - Model NetworkFunction no longer has parameter sku_name
    info	[Changelog]   - Model NetworkFunction no longer has parameter sku_type
    info	[Changelog]   - Model NetworkFunction no longer has parameter vendor_name
    info	[Changelog]   - Model NetworkFunction no longer has parameter vendor_provisioning_state
    info	[Changelog]   - Removed operation group DevicesOperations
    info	[Changelog]   - Removed operation group NetworkFunctionVendorSkusOperations
    info	[Changelog]   - Removed operation group NetworkFunctionVendorsOperations
    info	[Changelog]   - Removed operation group RoleInstancesOperations
    info	[Changelog]   - Removed operation group VendorNetworkFunctionsOperations
    info	[Changelog]   - Removed operation group VendorSkuPreviewOperations
    info	[Changelog]   - Removed operation group VendorSkusOperations
    info	[Changelog]   - Removed operation group VendorsOperations
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from b456e86. 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-hybridnetwork [View full logs]  [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from b456e86. 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/hybridnetwork/armhybridnetwork [View full logs]  [Release SDK Changes] Breaking Change Detected
    Only show 120 items here, please refer to log for details.
    info	[Changelog] - New struct `ArtifactManifest`
    info	[Changelog] - New struct `ArtifactManifestListResult`
    info	[Changelog] - New struct `ArtifactManifestPropertiesFormat`
    info	[Changelog] - New struct `ArtifactManifestUpdateState`
    info	[Changelog] - New struct `ArtifactProfile`
    info	[Changelog] - New struct `ArtifactStore`
    info	[Changelog] - New struct `ArtifactStoreListResult`
    info	[Changelog] - New struct `ArtifactStorePropertiesFormat`
    info	[Changelog] - New struct `ArtifactStorePropertiesFormatManagedResourceGroupConfiguration`
    info	[Changelog] - New struct `AzureArcK8SClusterNFVIDetails`
    info	[Changelog] - New struct `AzureArcKubernetesArtifactProfile`
    info	[Changelog] - New struct `AzureArcKubernetesDeployMappingRuleProfile`
    info	[Changelog] - New struct `AzureArcKubernetesHelmApplication`
    info	[Changelog] - New struct `AzureArcKubernetesNetworkFunctionTemplate`
    info	[Changelog] - New struct `AzureContainerRegistryScopedTokenCredential`
    info	[Changelog] - New struct `AzureCoreArmTemplateArtifactProfile`
    info	[Changelog] - New struct `AzureCoreArmTemplateDeployMappingRuleProfile`
    info	[Changelog] - New struct `AzureCoreNFVIDetails`
    info	[Changelog] - New struct `AzureCoreNetworkFunctionArmTemplateApplication`
    info	[Changelog] - New struct `AzureCoreNetworkFunctionTemplate`
    info	[Changelog] - New struct `AzureCoreNetworkFunctionVhdApplication`
    info	[Changelog] - New struct `AzureCoreVhdImageArtifactProfile`
    info	[Changelog] - New struct `AzureCoreVhdImageDeployMappingRuleProfile`
    info	[Changelog] - New struct `AzureOperatorNexusArmTemplateArtifactProfile`
    info	[Changelog] - New struct `AzureOperatorNexusArmTemplateDeployMappingRuleProfile`
    info	[Changelog] - New struct `AzureOperatorNexusClusterNFVIDetails`
    info	[Changelog] - New struct `AzureOperatorNexusImageArtifactProfile`
    info	[Changelog] - New struct `AzureOperatorNexusImageDeployMappingRuleProfile`
    info	[Changelog] - New struct `AzureOperatorNexusNetworkFunctionArmTemplateApplication`
    info	[Changelog] - New struct `AzureOperatorNexusNetworkFunctionImageApplication`
    info	[Changelog] - New struct `AzureOperatorNexusNetworkFunctionTemplate`
    info	[Changelog] - New struct `AzureStorageAccountContainerCredential`
    info	[Changelog] - New struct `AzureStorageAccountCredential`
    info	[Changelog] - New struct `Component`
    info	[Changelog] - New struct `ComponentListResult`
    info	[Changelog] - New struct `ComponentProperties`
    info	[Changelog] - New struct `ConfigurationGroupSchema`
    info	[Changelog] - New struct `ConfigurationGroupSchemaListResult`
    info	[Changelog] - New struct `ConfigurationGroupSchemaPropertiesFormat`
    info	[Changelog] - New struct `ConfigurationGroupSchemaVersionUpdateState`
    info	[Changelog] - New struct `ConfigurationGroupValue`
    info	[Changelog] - New struct `ConfigurationGroupValueListResult`
    info	[Changelog] - New struct `ConfigurationValueWithSecrets`
    info	[Changelog] - New struct `ConfigurationValueWithoutSecrets`
    info	[Changelog] - New struct `ContainerizedNetworkFunctionDefinitionVersion`
    info	[Changelog] - New struct `CustomLocationResourceID`
    info	[Changelog] - New struct `DaemonSet`
    info	[Changelog] - New struct `DependsOnProfile`
    info	[Changelog] - New struct `Deployment`
    info	[Changelog] - New struct `DeploymentStatusProperties`
    info	[Changelog] - New struct `ExecuteRequestParameters`
    info	[Changelog] - New struct `HelmArtifactProfile`
    info	[Changelog] - New struct `HelmInstallOptions`
    info	[Changelog] - New struct `HelmMappingRuleProfile`
    info	[Changelog] - New struct `HelmMappingRuleProfileOptions`
    info	[Changelog] - New struct `HelmUpgradeOptions`
    info	[Changelog] - New struct `ImageArtifactProfile`
    info	[Changelog] - New struct `ImageMappingRuleProfile`
    info	[Changelog] - New struct `ManagedResourceGroupConfiguration`
    info	[Changelog] - New struct `ManagedServiceIdentity`
    info	[Changelog] - New struct `ManifestArtifactFormat`
    info	[Changelog] - New struct `MappingRuleProfile`
    info	[Changelog] - New struct `NSDArtifactProfile`
    info	[Changelog] - New struct `NetworkFunctionApplication`
    info	[Changelog] - New struct `NetworkFunctionDefinitionGroup`
    info	[Changelog] - New struct `NetworkFunctionDefinitionGroupListResult`
    info	[Changelog] - New struct `NetworkFunctionDefinitionGroupPropertiesFormat`
    info	[Changelog] - New struct `NetworkFunctionDefinitionResourceElementTemplateDetails`
    info	[Changelog] - New struct `NetworkFunctionDefinitionVersion`
    info	[Changelog] - New struct `NetworkFunctionDefinitionVersionListResult`
    info	[Changelog] - New struct `NetworkFunctionDefinitionVersionUpdateState`
    info	[Changelog] - New struct `NetworkFunctionValueWithSecrets`
    info	[Changelog] - New struct `NetworkFunctionValueWithoutSecrets`
    info	[Changelog] - New struct `NetworkServiceDesignGroup`
    info	[Changelog] - New struct `NetworkServiceDesignGroupListResult`
    info	[Changelog] - New struct `NetworkServiceDesignGroupPropertiesFormat`
    info	[Changelog] - New struct `NetworkServiceDesignVersion`
    info	[Changelog] - New struct `NetworkServiceDesignVersionListResult`
    info	[Changelog] - New struct `NetworkServiceDesignVersionPropertiesFormat`
    info	[Changelog] - New struct `NetworkServiceDesignVersionUpdateState`
    info	[Changelog] - New struct `NfviDetails`
    info	[Changelog] - New struct `OpenDeploymentResourceReference`
    info	[Changelog] - New struct `OperationListResult`
    info	[Changelog] - New struct `Pod`
    info	[Changelog] - New struct `PodEvent`
    info	[Changelog] - New struct `ProxyArtifactListOverview`
    info	[Changelog] - New struct `ProxyArtifactOverview`
    info	[Changelog] - New struct `ProxyArtifactOverviewListResult`
    info	[Changelog] - New struct `ProxyArtifactOverviewPropertiesFormat`
    info	[Changelog] - New struct `ProxyArtifactOverviewPropertiesValue`
    info	[Changelog] - New struct `ProxyArtifactVersionsListOverview`
    info	[Changelog] - New struct `ProxyArtifactVersionsOverviewListResult`
    info	[Changelog] - New struct `Publisher`
    info	[Changelog] - New struct `PublisherListResult`
    info	[Changelog] - New struct `PublisherPropertiesFormat`
    info	[Changelog] - New struct `ReferencedResource`
    info	[Changelog] - New struct `ReplicaSet`
    info	[Changelog] - New struct `RequestMetadata`
    info	[Changelog] - New struct `Resources`
    info	[Changelog] - New struct `SKU`
    info	[Changelog] - New struct `SecretDeploymentResourceReference`
    info	[Changelog] - New struct `Site`
    info	[Changelog] - New struct `SiteListResult`
    info	[Changelog] - New struct `SiteNetworkService`
    info	[Changelog] - New struct `SiteNetworkServiceListResult`
    info	[Changelog] - New struct `SiteNetworkServicePropertiesFormat`
    info	[Changelog] - New struct `SitePropertiesFormat`
    info	[Changelog] - New struct `StatefulSet`
    info	[Changelog] - New struct `UserAssignedIdentity`
    info	[Changelog] - New struct `VhdImageArtifactProfile`
    info	[Changelog] - New struct `VhdImageMappingRuleProfile`
    info	[Changelog] - New struct `VirtualNetworkFunctionDefinitionVersion`
    info	[Changelog] - New field `Identity` in struct `NetworkFunction`
    info	[Changelog] - New field `ActionType`, `IsDataAction`, `Origin` in struct `Operation`
    info	[Changelog] - New anonymous field `OperationListResult` in struct `OperationsClientListResponse`
    info	[Changelog] - New field `SystemData` in struct `ProxyResource`
    info	[Changelog] - New field `SystemData` in struct `Resource`
    info	[Changelog] - New field `SystemData` in struct `TrackedResource`
    info	[Changelog]
    info	[Changelog] Total 157 breaking change(s), 522 additive change(s).
️⚠️ azure-sdk-for-js warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from b456e86. 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
    warn	No file changes detected after generation
    warn	No package detected after generation
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from b456e86. 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
    warn	No file changes detected after generation
  • ️✔️hybridnetwork [View full logs
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from b456e86. 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.hybridnetwork.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.hybridnetwork.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 16, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/hybridnetwork/armhybridnetwork https://apiview.dev/Assemblies/Review/397a87aba68b4139b447857c6e8a1377
Java azure-resourcemanager-hybridnetwork https://apiview.dev/Assemblies/Review/8cc47d3616bf401e9b60b222debf16ae

@openapi-pipeline-app
Copy link

Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

@haolingdong-msft haolingdong-msft changed the title Create readme.java.md to rename HelmInstallOptions.wait Create readme.java.md to rename wait property Nov 17, 2023
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 17, 2023
@XiaofeiCao XiaofeiCao added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 17, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants