Edge order GA api version changes and S360 fixes #16694

GovardhanaDK · 2021-11-08T05:19:34Z

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
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific langauge 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
- 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 apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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 · 2021-11-08T05:19:36Z

Hi, @GovardhanaDK 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. vsswagger@microsoft.com

openapi-workflow-bot · 2021-11-08T05:19:37Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2021-11-08T05:19:37Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- edgeorder/resource-manager/readme.md tag:package-2021-12
Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- edgeorder/resource-manager/readme.md tag:default

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R1003 - ListInOperationName	Since operation 'ListOperations' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L24
⚠️ R1003 - ListInOperationName	Since operation 'ListAddressesAtSubscriptionLevel' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L66
⚠️ R1003 - ListInOperationName	Since operation 'ListProductFamilies' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L125
⚠️ R1003 - ListInOperationName	Since operation 'ListConfigurations' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L193
⚠️ R1003 - ListInOperationName	Since operation 'ListProductFamiliesMetadata' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L254
⚠️ R1003 - ListInOperationName	Since operation 'ListOrderAtSubscriptionLevel' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L306
⚠️ R1003 - ListInOperationName	Since operation 'ListOrderItemsAtSubscriptionLevel' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L358
⚠️ R1003 - ListInOperationName	Since operation 'ListAddressesAtResourceGroupLevel' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L424
⚠️ R1003 - ListInOperationName	Since operation 'ListOrderAtResourceGroupLevel' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L709
⚠️ R1003 - ListInOperationName	Since operation 'ListOrderItemsAtResourceGroupLevel' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L815
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: sendNotification Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L2235
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: shippingBoxRequired Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L3098
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: common-types/resource-management/v2/types.json#L359
⚠️ R3027 - TrackedResourceListByResourceGroup	The tracked resource, 'AddressResource', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L1288
⚠️ R3027 - TrackedResourceListByResourceGroup	The tracked resource, 'OrderItemResource', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L2522
⚠️ R3028 - TrackedResourceListBySubscription	The tracked resource, 'AddressResource', must have a list by subscriptions operation. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L1288
⚠️ R3028 - TrackedResourceListBySubscription	The tracked resource, 'OrderItemResource', must have a list by subscriptions operation. Location: Microsoft.EdgeOrder/stable/2021-12-01/edgeorder.json#L2522

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

Validation passes for Avocado.

️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

Compared Swaggers (Based on Oad v0.9.1)
- current:stable/2021-12-01/edgeorder.json compared with base:preview/2020-12-01-preview/edgeorder.json

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

There is no credential detected.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

edgeorder/resource-manager/readme.md#package-2021-12

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

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

openapi-pipeline-app · 2021-11-08T05:19:38Z

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 - edgeorder/mgmt/2021-12-01/edgeorder - Approved - v59.1.0
❌azure-sdk-for-go - preview/edgeorder/mgmt/2020-12-01-preview/edgeorder - Approved - v59.1.0

+	Function `BaseClient.ListOrderItemsAtSubscriptionLevelComplete` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, string)`
+	Function `BaseClient.ListOrderItemsAtSubscriptionLevelPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, string)`
+	Function `BaseClient.ListOrderItemsAtSubscriptionLevel` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, string)`
+	Type of `OrderItemDetails.ForwardShippingDetails` has been changed from `*ShippingDetails` to `*ForwardShippingDetails`
+	Type of `OrderItemDetails.ManagementRpDetails` has been changed from `interface{}` to `*ResourceProviderDetails`
+	Type of `OrderItemDetails.ReverseShippingDetails` has been changed from `*ShippingDetails` to `*ReverseShippingDetails`

❌azure-sdk-for-python-track2 - track2_azure-mgmt-edgeorder - Approved - 1.0.0b1

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

️✔️Succeeded [Logs]Release - Generate from 3401892. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/edgeorder/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.EdgeOrder [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 3401892. 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

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

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model DeviceDetails has a new parameter management_resource_tenant_id
info	[Changelog]   - Model ReturnOrderItemDetails has a new parameter service_tag
info	[Changelog]   - Model ReturnOrderItemDetails has a new parameter shipping_box_required
info	[Changelog]   - Model ProductFamily has a new parameter resource_provider_details
info	[Changelog]   - Model ProductFamilyProperties has a new parameter resource_provider_details
info	[Changelog]   - Model ProductFamiliesMetadataDetails has a new parameter resource_provider_details
info	[Changelog]   - Model AddressProperties has a new parameter address_validation_status
info	[Changelog]   - Model AddressResource has a new parameter address_validation_status
info	[Changelog]   - Model ProductDetails has a new parameter product_double_encryption_status
info	[Changelog]   - Model OrderItemDetails has a new parameter management_rp_details_list
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Operation EdgeOrderManagementClientOperationsMixin.list_order_items_at_subscription_level has a new signature

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

️✔️Succeeded [Logs]Release - Generate from 3401892. SDK Automation 14.0.0

command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️edgeorder/mgmt/2021-12-01/edgeorder [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
```

️✔️preview/edgeorder/mgmt/2020-12-01-preview/edgeorder [View full logs] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `BaseClient.ListOrderItemsAtSubscriptionLevel` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, string)`
info	[Changelog] - Function `BaseClient.ListOrderItemsAtSubscriptionLevelComplete` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, string)`
info	[Changelog] - Function `BaseClient.ListOrderItemsAtSubscriptionLevelPreparer` parameter(s) have been changed from `(context.Context, string, string)` to `(context.Context, string, string, string)`
info	[Changelog] - Type of `OrderItemDetails.ForwardShippingDetails` has been changed from `*ShippingDetails` to `*ForwardShippingDetails`
info	[Changelog] - Type of `OrderItemDetails.ManagementRpDetails` has been changed from `interface{}` to `*ResourceProviderDetails`
info	[Changelog] - Type of `OrderItemDetails.ReverseShippingDetails` has been changed from `*ShippingDetails` to `*ReverseShippingDetails`
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New function `ReverseShippingDetails.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `ResourceProviderDetails.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `ForwardShippingDetails.MarshalJSON() ([]byte, error)`
info	[Changelog] - New struct `ForwardShippingDetails`
info	[Changelog] - New struct `ResourceProviderDetails`
info	[Changelog] - New struct `ReverseShippingDetails`
info	[Changelog] - New field `ResourceProviderDetails` in struct `ProductFamilyProperties`
info	[Changelog] - New field `ManagementResourceTenantID` in struct `DeviceDetails`
info	[Changelog] - New field `ProductDoubleEncryptionStatus` in struct `ProductDetails`
info	[Changelog] - New field `ManagementRpDetailsList` in struct `OrderItemDetails`
info	[Changelog] - New field `ServiceTag` in struct `ReturnOrderItemDetails`
info	[Changelog] - New field `ShippingBoxRequired` in struct `ReturnOrderItemDetails`
info	[Changelog]
info	[Changelog] Total 4 breaking change(s), 14 additive change(s).
info	[Changelog]

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

openapi-workflow-bot · 2021-11-08T05:21:13Z

Hi, @GovardhanaDK your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

msyyc · 2021-11-08T08:28:16Z

approve for python breaking change.

* Existing version into new directory structure * API version change and S360 fixes * read me file changes * minor correction Co-authored-by: Govardhana D K <govardhanadk@microsoft.com>

GovardhanaD-K added 3 commits November 8, 2021 10:44

Existing version into new directory structure

dd760fe

API version change and S360 fixes

18266a0

read me file changes

4e6076a

GovardhanaDK requested review from ArcturusZhang, BigCat20196, msyyc and RAY-316 as code owners November 8, 2021 05:19

openapi-assignment-bot bot assigned ruowan Nov 8, 2021

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 8, 2021

openapi-pipeline-app bot added the CI-BreakingChange-Go label Nov 8, 2021

openapi-sdkautomation bot mentioned this pull request Nov 8, 2021

[AutoPR track2_azure-mgmt-edgeorder] Edge order GA api version changes and S360 fixes AzureSDKAutomation/azure-sdk-for-python#8021

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Nov 8, 2021

openapi-sdkautomation bot mentioned this pull request Nov 8, 2021

[AutoPR Microsoft.Azure.Management.EdgeOrder] Edge order GA api version changes and S360 fixes AzureSDKAutomation/azure-sdk-for-net#6536

Closed

minor correction

918f4bf

ArcturusZhang added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Nov 8, 2021

msyyc added the Approved-SdkBreakingChange-Python label Nov 8, 2021

mentat9 added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 8, 2021

mentat9 mentioned this pull request Nov 8, 2021

Govi/ga api changes #16522

Closed

25 tasks

ruowan approved these changes Nov 11, 2021

View reviewed changes

ruowan merged commit 3401892 into Azure:main Nov 11, 2021

openapi-sdkautomation bot mentioned this pull request Nov 11, 2021

[ReleasePR Microsoft.Azure.Management.EdgeOrder] [digitaltwins storage edgeorder] Config readme.python Azure/azure-sdk-for-net#22404

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Edge order GA api version changes and S360 fixes #16694

Edge order GA api version changes and S360 fixes #16694

GovardhanaDK commented Nov 8, 2021 •

edited

Loading

openapi-workflow-bot bot commented Nov 8, 2021

openapi-workflow-bot bot commented Nov 8, 2021

openapi-pipeline-app bot commented Nov 8, 2021 •

edited

Loading

openapi-pipeline-app bot commented Nov 8, 2021 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Nov 8, 2021

msyyc commented Nov 8, 2021

Edge order GA api version changes and S360 fixes #16694

Edge order GA api version changes and S360 fixes #16694

Conversation

GovardhanaDK commented Nov 8, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Nov 8, 2021

openapi-workflow-bot bot commented Nov 8, 2021

openapi-pipeline-app bot commented Nov 8, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Nov 8, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Nov 8, 2021

msyyc commented Nov 8, 2021

GovardhanaDK commented Nov 8, 2021 •

edited

Loading

openapi-pipeline-app bot commented Nov 8, 2021 •

edited

Loading

openapi-pipeline-app bot commented Nov 8, 2021 •

edited

Loading