Added service name parameter annotation. #25344

azaslonov · 2023-08-16T19:48:27Z

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.

[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:
- An update required for initial SDK generation.

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:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.

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.

Getting help

For general PR approval workflow, see the diagram at the top of this comment.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-workflow-bot · 2023-08-16T19:48:30Z

Hi, @azaslonov! Thank you for your pull request. To help get your PR merged:

Ensure you reviewed the checklists in the PR description.

Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.

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.

openapi-pipeline-app · 2023-08-16T19:48:30Z

Next Steps to Merge

⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️

✔️ 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 · 2023-08-16T19:48:31Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
apicenter.json	2023-07-01-preview(25354ce)	2023-07-01-preview(main)

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail]

compared tags (via openapi-validator v2.1.4)	new version	base version
package-2023-07-01-preview	package-2023-07-01-preview(25354ce)	package-2023-07-01-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` PatchIdentityProperty	The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.ApiCenter/preview/2023-07-01-preview/apicenter.json#L281

️️✔️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 · 2023-08-16T19:48:32Z

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-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from c2e836c. 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] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.6.7 -> 9.8.1
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
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] [Release SDK Changes]
- azure_mgmt_apicenter-1.0.0b1-py3-none-any.whl
- azure-mgmt-apicenter-1.0.0b1.zip
```
info	[Changelog]   - Initial Release
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from c2e836c. 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-apicenter [View full logs] [Release SDK Changes]

️❌ azure-sdk-for-go failed [Detail]

❌Code Generator Failed [Logs]Release - Generate from c2e836c. 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
error	Script return with result [failed] code [2] 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]Release - Generate from c2e836c. 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] [Release SDK Changes]
- azure-arm-apicenter-1.0.0-beta.1.tgz
```
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 c2e836c. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
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

️✔️apicenter [View full logs]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from c2e836c. 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]

Az.ApiCenter.0.1.0.nupkg

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?}

openapi-pipeline-app · 2023-08-16T19:48:33Z

Generated ApiView

Language	Package Name	ApiView Link
Java	azure-resourcemanager-apicenter	https://apiview.dev/Assemblies/Review/3ddb8668974148249a169fdee396b318
JavaScript	@azure/arm-apicenter	https://apiview.dev/Assemblies/Review/71f7fa81745d4f8ea3f7f50abe452ef3

MaryGao

LGTM and wait for ARM feedback.

MaryGao · 2023-08-22T09:08:51Z

@rkmanda could you help review this pr? It may block the Aug SDK release.

lirenhe · 2023-08-23T07:32:37Z

This change would only impact the SDK so remove the required review from ARM team.
Merge this PR directly as it would block our SDK monthly release.

openapi-pipeline-app · 2023-08-23T07:33:06Z

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

Added service name parameter annotation.

25354ce

openapi-assignment-bot bot assigned rkmanda Aug 16, 2023

azure-sdk mentioned this pull request Aug 16, 2023

[AutoPR sdk/resourcemanager/apicenter/armapicenter] Added service name parameter annotation. azure-sdk/azure-sdk-for-go#6887

Closed

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 Aug 16, 2023

azaslonov mentioned this pull request Aug 16, 2023

Added Azure API Center resource manager. #24130

Merged

11 tasks

MaryGao approved these changes Aug 17, 2023

View reviewed changes

MaryGao self-requested a review August 17, 2023 00:55

msyyc approved these changes Aug 17, 2023

View reviewed changes

lirenhe removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 23, 2023

lirenhe approved these changes Aug 23, 2023

View reviewed changes

lirenhe removed the ARMReview label Aug 23, 2023

lirenhe merged commit c2e836c into Azure:main Aug 23, 2023

azure-sdk mentioned this pull request Aug 23, 2023

[ReleasePR azure-resourcemanager-apicenter] Added new version 2024-03-01 of API Center resource manager. Azure/azure-sdk-for-java#35267

Closed

azaslonov deleted the alzaslon-apicenter-Microsoft.ApiCenter-2023-07-01-preview branch September 26, 2023 19:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added service name parameter annotation. #25344

Added service name parameter annotation. #25344

azaslonov commented Aug 16, 2023

openapi-workflow-bot bot commented Aug 16, 2023

openapi-pipeline-app bot commented Aug 16, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 16, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 16, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Aug 16, 2023 •

edited

Loading

MaryGao left a comment •

edited

Loading

MaryGao commented Aug 22, 2023

lirenhe commented Aug 23, 2023

openapi-pipeline-app bot commented Aug 23, 2023

Added service name parameter annotation. #25344

Added service name parameter annotation. #25344

Conversation

azaslonov commented Aug 16, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Breaking changes review (Step 1)

ARM API changes review (Step 2)

Getting help

openapi-workflow-bot bot commented Aug 16, 2023

openapi-pipeline-app bot commented Aug 16, 2023 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Aug 16, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Aug 16, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Aug 16, 2023 • edited Loading

Generated ApiView

MaryGao left a comment • edited Loading

Choose a reason for hiding this comment

MaryGao commented Aug 22, 2023

lirenhe commented Aug 23, 2023

openapi-pipeline-app bot commented Aug 23, 2023

openapi-pipeline-app bot commented Aug 16, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 16, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 16, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 16, 2023 •

edited

Loading

MaryGao left a comment •

edited

Loading