Skip to content

mgmt, java, flatten-models=false for non-GA TypeSpec libs#26687

Merged
weidongxu-microsoft merged 2 commits into
Azure:mainfrom
weidongxu-microsoft:mgmt_java-disable-flatten
Nov 24, 2023
Merged

mgmt, java, flatten-models=false for non-GA TypeSpec libs#26687
weidongxu-microsoft merged 2 commits into
Azure:mainfrom
weidongxu-microsoft:mgmt_java-disable-flatten

Conversation

@weidongxu-microsoft
Copy link
Copy Markdown
Member

@weidongxu-microsoft weidongxu-microsoft commented Nov 14, 2023

Configure in Java codegen: disable flatten-models for non-GA lib (from TypeSpec).

No change to other SDK.

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

[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
Copy Markdown

openapi-pipeline-app Bot commented Nov 14, 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
Copy Markdown

openapi-pipeline-app Bot commented Nov 14, 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(28cc407) default(main)
default default(28cc407) default(main)
default default(28cc407) default(main)
default default(28cc407) default(main)
default default(28cc407) default(main)
default default(28cc407) default(main)
default default(28cc407) default(main)
default default(28cc407) default(main)
default default(28cc407) default(main)
default default(28cc407) 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.
️️✔️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
Copy Markdown

openapi-pipeline-app Bot commented Nov 14, 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]
️⚠️ azure-sdk-for-java warning [Detail]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from fbe4398ae86a84231e7b9bc5026c393975883d34. 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
    warn		specification/iotoperationsmq/resource-manager/readme.md skipped due to azure-sdk-for-go not found in swagger-to-sdk
    warn		specification/iotoperationsorchestrator/resource-manager/readme.md skipped due to azure-sdk-for-go not found in swagger-to-sdk
    warn		specification/liftrastronomer/resource-manager/readme.md skipped due to azure-sdk-for-go not found in swagger-to-sdk
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/communitytraining/armcommunitytraining [View full logs]  [Preview SDK Changes]
    info	[Changelog] This is a new package
    info	[Changelog]
  • ️✔️sdk/resourcemanager/containerstorage/armcontainerstorage [View full logs]  [Preview SDK Changes]
    info	[Changelog] This is a new package
    info	[Changelog]
  • ️✔️sdk/resourcemanager/mobilepacketcore/armmobilepacketcore [View full logs]  [Preview SDK Changes]
    info	[Changelog] This is a new package
    info	[Changelog]
  • ️✔️sdk/resourcemanager/networkanalytics/armnetworkanalytics [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
  • ️✔️sdk/resourcemanager/playwrighttesting/armplaywrighttesting [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
  • ️✔️sdk/resourcemanager/servicenetworking/armservicenetworking [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
  • ️✔️sdk/resourcemanager/sphere/armsphere [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from fbe4398ae86a84231e7b9bc5026c393975883d34. 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
  • ️✔️communitytraining [View full logs]  [Preview Schema Changes]
  • ️✔️containerstorage [View full logs]  [Preview Schema Changes]
  • ️✔️networkanalytics [View full logs]  [Preview Schema Changes]
  • ️✔️playwrighttesting [View full logs]  [Preview Schema Changes]
  • ️✔️sphere [View full logs]  [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from fbe4398ae86a84231e7b9bc5026c393975883d34. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    warn		specification/containerstorage/resource-manager/readme.md skipped due to azure-powershell not found in swagger-to-sdk
    warn		specification/iotoperationsmq/resource-manager/readme.md skipped due to azure-powershell not found in swagger-to-sdk
    warn		specification/iotoperationsorchestrator/resource-manager/readme.md skipped due to azure-powershell not found in swagger-to-sdk
    warn		specification/liftrastronomer/resource-manager/readme.md skipped due to azure-powershell not found in swagger-to-sdk
    warn		specification/mpcnetworkfunction/resource-manager/readme.md skipped due to azure-powershell not found in swagger-to-sdk
    warn		specification/servicenetworking/resource-manager/readme.md skipped due to azure-powershell not found in swagger-to-sdk
    warn		specification/sphere/resource-manager/readme.md skipped due to azure-powershell not found in swagger-to-sdk
    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.communitytraining.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.communitytraining.DefaultTag
    error		Az.networkanalytics.DefaultTag
    error		Az.playwrighttesting.DefaultTag
  • ️✔️Az.networkanalytics.DefaultTag
  • ⚠️Az.playwrighttesting.DefaultTag
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning [Logs] Generate from fbe4398ae86a84231e7b9bc5026c393975883d34. 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.
    warn		specification/communitytraining/resource-manager/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    warn		specification/iotoperationsmq/resource-manager/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    warn		specification/iotoperationsorchestrator/resource-manager/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    warn		specification/liftrastronomer/resource-manager/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    warn		specification/networkanalytics/resource-manager/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    warn		specification/playwrighttesting/resource-manager/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    warn		specification/servicenetworking/resource-manager/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh] 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-containerstorage [View full logs]  [Preview SDK Changes]
    info	[Changelog]   - Initial Release
  • ️✔️track2_azure-mgmt-sphere [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from fbe4398ae86a84231e7b9bc5026c393975883d34. 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
    warn		specification/communitytraining/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    warn		specification/containerstorage/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    warn		specification/iotoperationsmq/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    warn		specification/iotoperationsorchestrator/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    warn		specification/liftrastronomer/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    warn		specification/mpcnetworkfunction/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    warn		specification/networkanalytics/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    warn		specification/playwrighttesting/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    warn		specification/servicenetworking/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  • ️✔️Azure.ResourceManager.Sphere [View full logs]  [Preview SDK Changes]
    info	[Changelog]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link
Copy Markdown

openapi-pipeline-app Bot commented Nov 14, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/communitytraining/armcommunitytraining https://apiview.dev/Assemblies/Review/e79a84d3402c4c98b377ffa17f8f7782
Go sdk/resourcemanager/containerstorage/armcontainerstorage https://apiview.dev/Assemblies/Review/d495351440d74f6db909b6c00badc3ab
Go sdk/resourcemanager/mobilepacketcore/armmobilepacketcore https://apiview.dev/Assemblies/Review/d1890eeeaf6e477cbd033905aba55f44
Go sdk/resourcemanager/networkanalytics/armnetworkanalytics https://apiview.dev/Assemblies/Review/42ae06c6b6c44b05b2391dc8e0c53035
Go sdk/resourcemanager/playwrighttesting/armplaywrighttesting https://apiview.dev/Assemblies/Review/d6120401bf7f47cc811b5ed848a407a8
Go sdk/resourcemanager/servicenetworking/armservicenetworking https://apiview.dev/Assemblies/Review/512b8d87b8c24b94bb5fac65570565ab
.Net Azure.ResourceManager.Sphere Create ApiView timeout. Package is too large and we cannot create ApiView for it.
Java azure-resourcemanager-communitytraining https://apiview.dev/Assemblies/Review/d1da82dae33940d5a442de326a6b2993
Java azure-resourcemanager-mpcnetworkfunction https://apiview.dev/Assemblies/Review/40b4d04fee8e4023a8d4e37de99bcc5f
Java azure-resourcemanager-networkanalytics https://apiview.dev/Assemblies/Review/2b169bc6402a4995bd5f58d7e56ad6ae
Java azure-resourcemanager-playwrighttesting https://apiview.dev/Assemblies/Review/999e05c611ab4244a97fdec0229a945b
Java azure-resourcemanager-sphere https://apiview.dev/Assemblies/Review/52f78d30156c433081a9ea1520101504
JavaScript @azure/arm-communitytraining https://apiview.dev/Assemblies/Review/4059e6eef5584ca9b45463f54f145060
JavaScript @azure/arm-mobilecore https://apiview.dev/Assemblies/Review/d0bab912a4e14925a6c840bac523698c
JavaScript @azure/arm-networkanalytics https://apiview.dev/Assemblies/Review/1b2ba6c425404d1f90b5a314d69e0425
JavaScript @azure/arm-playwrighttesting There is no API change compared with the previous version
JavaScript @azure/arm-sphere There is no API change compared with the previous version

@weidongxu-microsoft weidongxu-microsoft changed the title skip flatten for non-GA TypeSpec libs mgmt, java, skip flatten for non-GA TypeSpec libs Nov 14, 2023
@weidongxu-microsoft weidongxu-microsoft changed the title mgmt, java, skip flatten for non-GA TypeSpec libs mgmt, java, skip model-flatten for non-GA TypeSpec libs Nov 14, 2023
@weidongxu-microsoft weidongxu-microsoft changed the title mgmt, java, skip model-flatten for non-GA TypeSpec libs mgmt, java, flatten-models=false for non-GA TypeSpec libs Nov 14, 2023
@weidongxu-microsoft weidongxu-microsoft added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Nov 14, 2023
@weidongxu-microsoft weidongxu-microsoft marked this pull request as ready for review November 23, 2023 06:47
@weidongxu-microsoft
Copy link
Copy Markdown
Member Author

/azp run

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 3 pipeline(s).

@weidongxu-microsoft weidongxu-microsoft added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 23, 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 23, 2023
@weidongxu-microsoft
Copy link
Copy Markdown
Member Author

/azp run

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 3 pipeline(s).

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required and removed ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels Nov 24, 2023
@openapi-workflow-bot
Copy link
Copy Markdown

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.

@AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Nov 24, 2023
@weidongxu-microsoft weidongxu-microsoft added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 24, 2023
@weidongxu-microsoft weidongxu-microsoft merged commit 8d68a1d into Azure:main Nov 24, 2023
@weidongxu-microsoft weidongxu-microsoft deleted the mgmt_java-disable-flatten branch November 24, 2023 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go 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.

4 participants