add x-ms-identifiers for hybridnetwork by j-zhong-ms · Pull Request #19966 · Azure/azure-rest-api-specs

j-zhong-ms · 2022-07-26T19:47:12Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
  About this Change
  APIs will need to start indicating item uniqueness in arrays. By default, uniqueness is the string property called "id" of items in an array. When that property does not exist, the x-ms-identifiers extension property must be used to specify the identifying property(s) or lack thereof. This pull request is my best guess effort to ease resource providers into the new requirement before it becomes enforced. Compliance and accuracy will need to be owned and maintained by the resource provider going forward.

See https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-identifiers.

You can also make changes after this PR is checked in. At this point, this annotation is only used by Change Analysis for change computation, so making changes afterwards shouldn’t be a breaking change.
2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- [ ] SDK of .NET (need service team to ensure code readiness)
- [ ] SDK of Python
- [ ] SDK of Java
- [ ] SDK of Js
- [ ] SDK of Go
- [ ] PowerShell
- [ ] CLI
- [ ] Terraform
- [x] No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-07-26T19:47:15Z

Hi, @j-zhong-ms Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2022-07-26T19:47:16Z

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.9.6)]	new version	base version
2022-01-01-preview	2022-01-01-preview(6ac686e)	2022-01-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: 0 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-01-01-preview	package-2022-01-01-preview(6ac686e)	package-2022-01-01-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2015 - ParameterNotDefinedInGlobalParameters	Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.HybridNetwork/preview/2022-01-01-preview/common.json#L1
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: customDataRequired Location: Microsoft.HybridNetwork/preview/2022-01-01-preview/common.json#L223
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: preview Location: Microsoft.HybridNetwork/preview/2022-01-01-preview/vendor.json#L842

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck 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.

️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/6ac686e3486581d6d62f425ff1dff723a0fc0715/specification/hybridnetwork/resource-manager/readme.md#tag-package-2022-01-01-preview">hybridnetwork/resource-manager/readme.md#package-2022-01-01-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"hybridnetwork/resource-manager/readme.md", "tag":"package-2022-01-01-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

️️✔️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).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-07-26T19:47:17Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - armhybridnetwork - Approved - 2.0.0-beta.2

+	Field `Parameters` of struct `VendorsClientBeginCreateOrUpdateOptions` has been removed
+	Function `*VendorsClient.BeginCreateOrUpdate` parameter(s) have been changed from `(context.Context, string, *VendorsClientBeginCreateOrUpdateOptions)` to `(context.Context, string, Vendor, *VendorsClientBeginCreateOrUpdateOptions)`

❌azure-sdk-for-python-track2 - track2_azure-mgmt-hybridnetwork - Approved - 1.0.0

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 66fcf8b. 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] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.

️✔️track2_azure-mgmt-hybridnetwork [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation NetworkFunctionsOperations.begin_execute_request
info	[Changelog]   - Added operation VendorSkusOperations.list_credential
info	[Changelog]   - Model Operation has a new parameter action_type
info	[Changelog]   - Model Operation has a new parameter is_data_action
info	[Changelog]   - Model Operation has a new parameter origin
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model Device no longer has parameter azure_stack_edge
info	[Changelog]   - Model DevicePropertiesFormat no longer has parameter azure_stack_edge

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 66fcf8b. 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
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-hybridnetwork [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 66fcf8b. 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

️✔️armhybridnetwork [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `*VendorsClient.BeginCreateOrUpdate` parameter(s) have been changed from `(context.Context, string, *VendorsClientBeginCreateOrUpdateOptions)` to `(context.Context, string, Vendor, *VendorsClientBeginCreateOrUpdateOptions)`
info	[Changelog] - Field `Parameters` of struct `VendorsClientBeginCreateOrUpdateOptions` has been removed
info	[Changelog]
info	[Changelog] Total 2 breaking change(s), 0 additive change(s).

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

⚠️Warning [Logs]Release - Generate from 66fcf8b. 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
warn	No file changes detected after generation
warn	No package detected after generation

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 66fcf8b. 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]  old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
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

️✔️hybridnetwork [View full logs]

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 66fcf8b. 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

️✔️Az.HybridNetwork [View full logs] [Release SDK Changes]
- Az.HybridNetwork.0.1.0.nupkg

_{Posted by Swagger Pipeline | How to fix these errors?}

tadelesh · 2022-07-27T12:13:36Z

@msyyc Could you help to review the Python breaking?

j-zhong-ms · 2022-08-03T17:12:06Z

Hello @tadelesh this change shouldn't be a breaking change.

tadelesh · 2022-08-04T02:31:36Z

Hello @tadelesh this change shouldn't be a breaking change.

The SDK breaking is not from this PR.

add x-ms-identifiers for hybridnetwork

6ac686e

openapi-assignment-bot bot assigned tadelesh Jul 26, 2022

azure-sdk mentioned this pull request Jul 26, 2022

[AutoPR armhybridnetwork] add x-ms-identifiers for hybridnetwork azure-sdk/azure-sdk-for-go#1852

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jul 26, 2022

azure-sdk mentioned this pull request Jul 26, 2022

[AutoPR track2_azure-mgmt-hybridnetwork] add x-ms-identifiers for hybridnetwork azure-sdk/azure-sdk-for-python#921

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Jul 26, 2022

This was referenced Jul 26, 2022

[AutoPR azure-resourcemanager-hybridnetwork] add x-ms-identifiers for hybridnetwork azure-sdk/azure-sdk-for-java#1077

Closed

[AutoPR Az.HybridNetwork] add x-ms-identifiers for hybridnetwork azure-sdk/azure-powershell#1470

Closed

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Jul 27, 2022

msyyc added the Approved-SdkBreakingChange-Python label Jul 28, 2022

j-zhong-ms requested a review from congl-microsoft August 3, 2022 17:11

tadelesh approved these changes Aug 4, 2022

View reviewed changes

tadelesh merged commit 66fcf8b into Azure:main Aug 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add x-ms-identifiers for hybridnetwork#19966

add x-ms-identifiers for hybridnetwork#19966
tadelesh merged 1 commit intoAzure:mainfrom
j-zhong-ms:juliet-hybridnetwork-annotation

j-zhong-ms commented Jul 26, 2022

Uh oh!

openapi-workflow-bot bot commented Jul 26, 2022

Uh oh!

openapi-pipeline-app bot commented Jul 26, 2022 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Jul 26, 2022 •

edited

Loading

Breaking Changes Tracking

Uh oh!

tadelesh commented Jul 27, 2022

Uh oh!

j-zhong-ms commented Aug 3, 2022

Uh oh!

tadelesh commented Aug 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

j-zhong-ms commented Jul 26, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Jul 26, 2022

Uh oh!

openapi-pipeline-app bot commented Jul 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Jul 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

tadelesh commented Jul 27, 2022

Uh oh!

j-zhong-ms commented Aug 3, 2022

Uh oh!

tadelesh commented Aug 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

openapi-pipeline-app bot commented Jul 26, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jul 26, 2022 •

edited

Loading