Skip to content

Add new tag v2023-04-01 to Nginx Autorest configs#26570

Closed
SpencerOfwiti wants to merge 1 commit intoAzure:mainfrom
SpencerOfwiti:sofwiti/update-nginx-autorest-readme-v2023-04-01
Closed

Add new tag v2023-04-01 to Nginx Autorest configs#26570
SpencerOfwiti wants to merge 1 commit intoAzure:mainfrom
SpencerOfwiti:sofwiti/update-nginx-autorest-readme-v2023-04-01

Conversation

@SpencerOfwiti
Copy link
Member

@SpencerOfwiti SpencerOfwiti commented Nov 6, 2023

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. (Such PR should have been generated with 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:
    • Add new tag for Swagger version 2023-04-01 to Autorest configs

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 6, 2023

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR is in purview of ARM review (label: ARMReview). Please ensure your PR is on the ARM PR review queue - see instructions in steps 1 and 2 in the PR description diagram.
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it. In addition, 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 6, 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
package-2023-04-01 package-2023-04-01(e760b94) 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 6, 2023

Swagger Generation Artifacts

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

Breaking Changes Tracking

azure-sdk-for-go - sdk/resourcemanager/nginx/armnginx - 3.0.0
+	Field `Tags` of struct `Certificate` has been removed
+	Field `Tags` of struct `Configuration` has been removed
azure-sdk-for-python-track2 - track2_azure-mgmt-nginx - 2.1.0
+	Model NginxCertificate no longer has parameter tags
+	Model NginxConfiguration no longer has parameter tags
azure-sdk-for-js - @azure/arm-nginx - 3.0.0
+	Interface NginxCertificate no longer has parameter tags
+	Interface NginxConfiguration no longer has parameter tags
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from bf1b826bd3c8a060d0ee012676bcf96727b9fbea. 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	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.101 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/nginx/resource-manager/readme.md
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
  • ️✔️Microsoft.Azure.Management.Nginx [View full logs]  [Preview SDK Changes]
    warn	Skip artifact folder because it doesn't exist: artifacts/packages
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from bf1b826bd3c8a060d0ee012676bcf96727b9fbea. 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.3
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.3` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-nginx [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Model NginxConfigurationPackage has a new parameter protected_files
    info	[Changelog]   - Model NginxDeploymentProperties has a new parameter scaling_properties
    info	[Changelog]   - Model NginxDeploymentProperties has a new parameter user_profile
    info	[Changelog]   - Model NginxDeploymentUpdateProperties has a new parameter scaling_properties
    info	[Changelog]   - Model NginxDeploymentUpdateProperties has a new parameter user_profile
    info	[Changelog]
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog]   - Model NginxCertificate no longer has parameter tags
    info	[Changelog]   - Model NginxConfiguration no longer has parameter tags
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from bf1b826bd3c8a060d0ee012676bcf96727b9fbea. 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-nginx [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from bf1b826bd3c8a060d0ee012676bcf96727b9fbea. 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/nginx/armnginx [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Field `Tags` of struct `Certificate` has been removed
    info	[Changelog] - Field `Tags` of struct `Configuration` has been removed
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New struct `DeploymentScalingProperties`
    info	[Changelog] - New struct `DeploymentUserProfile`
    info	[Changelog] - New field `ProtectedFiles` in struct `ConfigurationPackage`
    info	[Changelog] - New field `ScalingProperties`, `UserProfile` in struct `DeploymentProperties`
    info	[Changelog] - New field `ScalingProperties`, `UserProfile` in struct `DeploymentUpdateProperties`
    info	[Changelog]
    info	[Changelog] Total 2 breaking change(s), 7 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from bf1b826bd3c8a060d0ee012676bcf96727b9fbea. 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-nginx [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added Interface NginxDeploymentScalingProperties
    info	[Changelog]   - Added Interface NginxDeploymentUserProfile
    info	[Changelog]   - Interface NginxConfigurationPackage has a new optional parameter protectedFiles
    info	[Changelog]   - Interface NginxDeploymentProperties has a new optional parameter scalingProperties
    info	[Changelog]   - Interface NginxDeploymentProperties has a new optional parameter userProfile
    info	[Changelog]   - Interface NginxDeploymentUpdateProperties has a new optional parameter scalingProperties
    info	[Changelog]   - Interface NginxDeploymentUpdateProperties has a new optional parameter userProfile
    info	[Changelog]
    info	[Changelog] **Breaking Changes**
    info	[Changelog]
    info	[Changelog]   - Interface NginxCertificate no longer has parameter tags
    info	[Changelog]   - Interface NginxConfiguration no longer has parameter tags
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from bf1b826bd3c8a060d0ee012676bcf96727b9fbea. 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.3
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.2.3` 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
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from bf1b826bd3c8a060d0ee012676bcf96727b9fbea. 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.nginx.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.nginx.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 6, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/nginx/armnginx https://apiview.dev/Assemblies/Review/2e11a353df9449b7add212182af3d385
Java azure-resourcemanager-nginx https://apiview.dev/Assemblies/Review/9dc2941eacd94b9a8b07e34ca300cbd2
JavaScript @azure/arm-nginx https://apiview.dev/Assemblies/Review/67a6d067e94d4831a81c9273f236a5e1

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 6, 2023
@SpencerOfwiti SpencerOfwiti changed the title Add Swagger v2023-04-01 to Nginx Autorest configs Add new tag v2023-04-01 to Nginx Autorest configs Nov 6, 2023
@SpencerOfwiti
Copy link
Member Author

Closed due to a similar change already in progress. #26534

@SpencerOfwiti SpencerOfwiti deleted the sofwiti/update-nginx-autorest-readme-v2023-04-01 branch November 6, 2023 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMReview CI-BreakingChange-Go CI-BreakingChange-JavaScript ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants