Skip to content

[Test] Added new version 2024-04-01 of API Center resource manager. #3103

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

Open
wants to merge 29 commits into
base: main
Choose a base branch
from

Conversation

ankhyk
Copy link

@ankhyk ankhyk commented Nov 30, 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. (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

raych1 and others added 28 commits September 13, 2023 06:39
* Rename bug.md to bug_report.md

* Create config.yml
[Internal testing] testing openapi-alps PR 510778 - Test 11/14/2023 / 1
[Internal testing] testing openapi-alps PR 510778 - Test 11/14/2023 / 2
[Internal testing] testing openapi-alps PR 510778 - Test 11/15/2023 / 1
[Internal testing] testing openapi-alps PR 511346 - Test 1
Copy link

openapi-pipeline-app-test bot commented Nov 30, 2023

Next Steps to merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes in the generated SDK for python (label: CI-BreakingChange-Python-Track2). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).
  • ❌ The required check named Swagger LintDiff has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

Copy link

openapi-pipeline-app-test bot commented Nov 30, 2023

Swagger Generation Artifacts

️🔄~[NotRequired_Staging] ApiDocPreview inProgress [Detail]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from 7f551ebece2cc350d9eb35424fbabac033ebaf7e. 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]
    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 [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-apicenter [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation ServicesOperations.export_metadata_schema
    info	[Changelog]   - Added operation group ApiDefinitionsOperations
    info	[Changelog]   - Added operation group ApiVersionsOperations
    info	[Changelog]   - Added operation group ApisOperations
    info	[Changelog]   - Added operation group DeploymentsOperations
    info	[Changelog]   - Added operation group EnvironmentsOperations
    info	[Changelog]   - Added operation group MetadataSchemasOperations
    info	[Changelog]   - Added operation group WorkspacesOperations
    info	[Changelog]   - Operation ServicesOperations.create_or_update has a new optional parameter payload
    info	[Changelog]   - Operation ServicesOperations.update has a new optional parameter payload
    info	[Changelog]
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog]   - Operation ServicesOperations.create_or_update no longer has parameter resource
    info	[Changelog]   - Operation ServicesOperations.update no longer has parameter parameters
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from 7f551ebece2cc350d9eb35424fbabac033ebaf7e. 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-apicenter [View full logs]  [Preview SDK Changes]
️❌ azure-sdk-for-go failed [Detail]
  • Code Generator Failed [Logs] Generate from 7f551ebece2cc350d9eb35424fbabac033ebaf7e. 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
    cmderr	[generator automation-v2] [ERROR] total 1 error(s):
    cmderr	[generator automation-v2] [ERROR] failed to execute `go generate` '�[33;1mWARNING: Unable to find version for /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apicenter/armapicenter�[0m
    cmderr	[generator automation-v2] [ERROR] Cannot find go module under resourcemanager/apicenter/armapicenter, try to build in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apicenter/armapicenter
    cmderr	[generator automation-v2] [ERROR] ##[command]Cleaning auto-generated files in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apicenter/armapicenter
    cmderr	[generator automation-v2] [ERROR] ##[command]Executing autorest.go in  /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apicenter/armapicenter
    cmderr	[generator automation-v2] [ERROR] autorest --use=@autorest/[email protected] --go --track2 --output-folder=/mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apicenter/armapicenter --clear-output-folder=false --go.clear-output-folder=false --honor-body-placement=false --remove-unreferenced-types=true ./autorest.md
    cmderr	[generator automation-v2] [ERROR] AutoRest code generation utility [cli version: 3.6.1; node: v16.20.2]
    cmderr	[generator automation-v2] [ERROR] (C) 2018 Microsoft Corporation.
    cmderr	[generator automation-v2] [ERROR] https://aka.ms/autorest
    cmderr	[generator automation-v2] [ERROR] There is a new version of AutoRest available (3.7.1).
    cmderr	[generator automation-v2] [ERROR] > You can install the newer version with with npm install -g autorest@latest
    cmderr	[generator automation-v2] [ERROR] info    |    Loading AutoRest core      '/home/cloudtest/.autorest/@[email protected]/nodemodules/@autorest/core/dist' (3.10.1)
    cmderr	[generator automation-v2] [ERROR] info    |    Installing AutoRest extension '@autorest/go' (4.0.0-preview.60 -> 4.0.0-preview.60)
    cmderr	[generator automation-v2] [ERROR] info    |    Installed AutoRest extension '@autorest/go' (4.0.0-preview.60->4.0.0-preview.60)
    cmderr	[generator automation-v2] [ERROR] info    |    Installing AutoRest extension '@autorest/modelerfour' (4.26.2 -> 4.26.2)
    cmderr	[generator automation-v2] [ERROR] info    |    Installed AutoRest extension '@autorest/modelerfour' (4.26.2->4.26.2)
    cmderr	[generator automation-v2] [ERROR] warning | PreCheck/CheckDuplicateSchemas | Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
    cmderr	[generator automation-v2] [ERROR] warning | UsingTemporaryFlag | modelerfour.treat-type-object-as-anything options is a temporary flag. It WILL be removed in the future.
    cmderr	[generator automation-v2] [ERROR] warning | SecurityDefinedSpecAndConfig | OpenAPI spec has a security definition but autorest security config is defined. Security config from autorest will be used.
    cmderr	[generator automation-v2] [ERROR] fatal   | Error: optional client parameters for ARM is not supported
    cmderr	[generator automation-v2] [ERROR] fatal   | Process() cancelled due to failure
    cmderr	[generator automation-v2] [ERROR] error   |   Error: Plugin go-codegen reported failure.
    cmderr	[generator automation-v2] [ERROR] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
    cmderr	[generator automation-v2] [ERROR] ##[error]Error running autorest.go
    cmderr	[generator automation-v2] [ERROR] build.go:5: running "pwsh": exit status 1
    cmderr	[generator automation-v2] [ERROR] ': exit status 1
    error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2
    warn	Skip package processing as generation is failed
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 7f551ebece2cc350d9eb35424fbabac033ebaf7e. 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-apicenter [View full logs]  [Preview 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] Generate from 7f551ebece2cc350d9eb35424fbabac033ebaf7e. 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 [email protected]` 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
  • ️✔️apicenter [View full logs]  [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from 7f551ebece2cc350d9eb35424fbabac033ebaf7e. 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.apicenter.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.apicenter.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app-test bot commented Nov 30, 2023

Generated ApiView

Language Package Name ApiView Link
Java azure-resourcemanager-apicenter There is no API change compared with the previous version
JavaScript @azure/arm-apicenter There is no API change compared with the previous version

Copy link

openapi-pipeline-app-test bot commented Nov 30, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 15 Warnings warning [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
apicenter.json 2024-04-01(fd00e82) 2024-03-01(main)
apicenter.json 2024-04-01(fd00e82) 2023-07-01-preview(main)

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

Rule Message
⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ServiceName' removed or renamed?
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L3028:3
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L430:3
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: common-types/resource-management/v5/types.json#L413:9
Old: common-types/resource-management/v3/types.json#L411:9
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L115:9
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L93:9
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L154:9
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L132:9
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L197:9
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L174:9
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L238:9
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L214:9
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L293:9
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L268:9
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L342:9
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L316:9
⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
New: common-types/resource-management/v5/types.json#L632:5
Old: common-types/resource-management/v3/types.json#L622:5
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L197:9
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L174:9
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L238:9
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L214:9
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L293:9
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L268:9
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.ApiCenter/stable/2024-04-01/apicenter.json#L342:9
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L316:9
⚠️ 1046 - RemovedOptionalParameter The optional parameter 'resource' was removed in the new version.
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L227:11
⚠️ 1046 - RemovedOptionalParameter The optional parameter 'parameters' was removed in the new version.
Old: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L281:11
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-2024-04 package-2024-04(fd00e82) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
FATAL spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-04-01/apicenter.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined')
Location: azure-rest-api-specs/blob/fd00e82eeb45ee86311e18d061110edd53d8578a/#L1
️️✔️~[NotRequired_Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️~[NotRequired_Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

Hi @keryul! 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.

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

Successfully merging this pull request may close these issues.

4 participants