Skip to content

Comments

release 2023-04-01 swagger to public repo #25959

Merged
raosuhas merged 2 commits intoAzure:mainfrom
zaowang-ms:main
Sep 29, 2023
Merged

release 2023-04-01 swagger to public repo #25959
raosuhas merged 2 commits intoAzure:mainfrom
zaowang-ms:main

Conversation

@zaowang-ms
Copy link
Contributor

@zaowang-ms zaowang-ms commented Sep 25, 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, per this wiki doc.)
  • 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 Sep 25, 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 Sep 25, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 2 Errors, 4 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
swagger.json 2023-04-01(155f9ab) 2022-08-01(main)
swagger.json 2023-04-01(155f9ab) 2021-05-01-preview(main)

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

Rule Message
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'tags' renamed or removed?
New: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L861:7
Old: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L861:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'tags' renamed or removed?
New: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L957:7
Old: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L956:7


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

Rule Message
⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'Certificates_Create' to 'Certificates_CreateOrUpdate'. This will impact generated code.
New: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L80:7
Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L80:7
⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'Deployments_Create' to 'Deployments_CreateOrUpdate'. This will impact generated code.
New: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L523:7
Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L523:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'tags' renamed or removed?
New: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L861:7
Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L861:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'tags' renamed or removed?
New: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L957:7
Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L956:7
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v2.1.5) new version base version
default default(155f9ab) default(main)
️❌Avocado: 17 Errors, 0 Warnings failed [Detail]
Rule Message
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Certificates_CreateOrUpdate.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Certificates_Delete.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Certificates_Get.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Certificates_List.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Configurations_CreateOrUpdate.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Configurations_Delete.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Configurations_Get.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Configurations_List.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Deployments_Create.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Deployments_Delete.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Deployments_Get.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Deployments_List.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Deployments_ListByResourceGroup.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Deployments_Update.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/nginx/resource-manager/readme.md
json: stable/2023-04-01/examples/Operations_List.json
UNREFERENCED_JSON_FILE The swagger JSON file is not referenced from the readme file.
readme: specification/nginx/resource-manager/readme.md
json: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json
NOT_LATEST_API_VERSION_IN_DEFAULT_TAG The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag.
readme: specification/nginx/resource-manager/readme.md
json: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json
️️✔️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 Sep 25, 2023

Swagger Generation Artifacts

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

Breaking Changes Tracking



️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from dadb393. 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]  [Release SDK Changes]
    warn	Skip artifact folder because it doesn't exist: artifacts/packages
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from dadb393. 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: 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]  notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.6.7 -> 10.1.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.1.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-nginx [View full logs]  [Release SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from dadb393. 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.2.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.2.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]  [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from dadb393. 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]  [Release 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]
  • ️✔️Succeeded [Logs]Release - Generate from dadb393. 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
    cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
  • ️✔️@azure/arm-nginx [View full logs]  [Release SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from dadb393. 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]  notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.1.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.1.0` 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
  • ️✔️nginx [View full logs
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from dadb393. 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 Sep 25, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/nginx/armnginx https://apiview.dev/Assemblies/Review/ed164cf3a3e042dc8fccd15759d76266
Java azure-resourcemanager-nginx https://apiview.dev/Assemblies/Review/961fb32e4dd94bb1839ddb077551d68b
JavaScript @azure/arm-nginx https://apiview.dev/Assemblies/Review/34f82ad6ab5d4d5a84e60ba4a6c4f60d

@zaowang-ms
Copy link
Contributor Author

This is publishing a previously used but not published api version 2023-04-01. As discussed in today's breaking change review office hour, that's the reason we got some breaking change tags on the 2023-09-01 PR. This is required to be done. I'll ping the breaking change reviewers about this PR if there are any breaking change identified.

@openapi-pipeline-app
Copy link

Swagger Validation Report

️⌛BreakingChange pending [Detail]
️⌛Breaking Change(Cross-Version) pending [Detail]
️⌛CredScan pending [Detail]
️⌛LintDiff pending [Detail]
️⌛Avocado pending [Detail]
️⌛SwaggerAPIView pending [Detail]
️⌛TypeSpecAPIView pending [Detail]
️⌛ModelValidation pending [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⌛PoliCheck pending [Detail]
️🔄PrettierCheck inProgress [Detail]
️⌛SpellCheck pending [Detail]
️🔄Lint(RPaaS) inProgress [Detail]
️⌛PR Summary pending [Detail]
️⌛Automated merging requirements met pending [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

Swagger Generation Artifacts

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

Breaking Changes Tracking

️⌛ azure-sdk-for-net pending [Detail]
️⌛ azure-sdk-for-python-track2 pending [Detail]
️⌛ azure-sdk-for-java pending [Detail]
️⌛ azure-sdk-for-go pending [Detail]
️⌛ azure-sdk-for-js pending [Detail]
️⌛ azure-resource-manager-schemas pending [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
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.

@openapi-workflow-bot
Copy link

Hi @zaowang-ms! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

@zaowang-ms
Copy link
Contributor Author

Base commit is not missing. The diff can be viewed here: 155f9ab

@zaowang-ms
Copy link
Contributor Author

The identified breaking change is already approved here https://github.com/Azure/azure-rest-api-specs-pr/pull/12762 .

@zaowang-ms
Copy link
Contributor Author

The initial 2023-04-01 PR approved in azure-rest-api-specs-pr : https://github.com/Azure/azure-rest-api-specs-pr/pull/11959

@mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 25, 2023
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 25, 2023
@zaowang-ms
Copy link
Contributor Author

Hi @rkmanda , it would be muchly appreciated if anyone from your side can review this sooner. This 2023-04-01 is an already in-use version for a few months and should be all good from all aspects.

@raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 28, 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 Sep 28, 2023
@zaowang-ms
Copy link
Contributor Author

/pr RequestMerge

@raosuhas
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@raosuhas raosuhas merged commit dadb393 into Azure:main Sep 29, 2023
@openapi-pipeline-app
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-MissingBaseCommit new-api-version resource-manager RPaaS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants