[EdgeOrder] Update 2020-12-01-preview swagger and add readme files

[t-vjanardhan]

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

Changelog

Please ensure to add changelog with this PR by answering the following questions.

1. 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
   • minor swagger updates and add readme files
2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

• Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

  • Adding new API(s)
  • Adding a new API version
  • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
  • Adding a new service

• Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

• Removing API(s) in stable version
• Removing properties in stable version
• Removing API version(s) in stable version
• Updating API in 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]

Hi, @t-vjanardhan 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. [email protected]

[openapi-workflow-bot]

[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]

Swagger Validation Report

️❌BreakingChange: 24 Errors, 0 Warnings failed [Detail]

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

Only 10 items are listed, please refer to log for more details.

Rule	Message
❌ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'ManagementResourceDetails' removed or renamed? New: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1217:3 Old: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1203:3
❌ 1019 - RemovedEnumValue	The new version is removing enum value(s) 'DeviceOrdered, DevicePrepared, PickedUp, AtAzureDC, DataCopy, Completed, CompletedWithErrors, Aborted, CompletedWithWarnings, ReadyToDispatchFromAzureDC, ReadyToReceiveAtAzureDC, ReadyForDispatch' from the old version. New: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L2538:9 Old: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L2455:9
❌ 1019 - RemovedEnumValue	The new version is removing enum value(s) 'DevicePrepared, PickedUp, AtAzureDC, DataCopy' from the old version. New: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L2148:9 Old: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L2041:9
❌ 1027 - DefaultValueChanged	The new version has a different default value than the previous one. New: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1889:9 Old: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1782:9
❌ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L2086:9 Old: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1978:9
❌ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L2086:9 Old: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1978:9
❌ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L2086:9 Old: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1978:9
❌ 1030 - DifferentDiscriminator	The new version has a different discriminator than the previous one. New: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1670:9 Old: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1662:9
❌ 1030 - DifferentDiscriminator	The new version has a different discriminator than the previous one. New: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L2079:5 Old: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1974:5
❌ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'deviceHistory' renamed or removed? New: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1774:7 Old: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1761:7

️⚠️LintDiff: 0 Warnings warning [Detail]

• Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
  • edgeorder/resource-manager/readme.md tag:package-2020-12-preview
• Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
  • edgeorder/resource-manager/readme.md tag:package-2020-12-preview

The following errors/warnings exist before current PR submission:

Only 10 items are listed, please refer to log for more details.

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/preview/2020-12-01-preview/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/preview/2020-12-01-preview/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/preview/2020-12-01-preview/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/preview/2020-12-01-preview/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/preview/2020-12-01-preview/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/preview/2020-12-01-preview/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/preview/2020-12-01-preview/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/preview/2020-12-01-preview/edgeorder.json#L417
⚠️ 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/preview/2020-12-01-preview/edgeorder.json#L702
⚠️ 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/preview/2020-12-01-preview/edgeorder.json#L808

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

Validation passes for Avocado.

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

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

There is no credential detected.

️️✔️[Staging] 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-2020-12-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"edgeorder/resource-manager/readme.md",
"tag":"package-2020-12-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"edgeorder/resource-manager/readme.md",
"tag":"package-2020-12-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|

The following errors/warnings exist before current PR submission:

|:speech_balloon: AutorestCore/Exception|"readme":"edgeorder/resource-manager/readme.md",
"tag":"package-2020-12-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

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

[openapi-pipeline-app]

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account. 

️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-go - preview/edgeorder/mgmt/2020-12-01-preview/edgeorder - v55.3.0
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-edgeorder - first release

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

• ️✔️Succeeded [Logs]Release - Generate from f985f05. 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 [email protected]/[email protected] --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 f985f05. 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]
  • azure_mgmt_edgeorder-1.0.0b1-py2.py3-none-any.whl
  • azure-mgmt-edgeorder-1.0.0b1.zip

  info	[Changelog]   - Initial Release

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

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

  command	sh ./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

• ️✔️preview/edgeorder/mgmt/2020-12-01-preview/edgeorder [View full logs]  [Release SDK Changes]

  info	[Changelog] This is a new package

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

[openapi-workflow-bot]

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

[openapi-workflow-bot]

Hi @t-vjanardhan, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

[t-vjanardhan]

We are relatively new service in Azure. The addition and removal of enum values and properties in the swagger doesn't affect any customer as we are still in development phase. We are deployed only in our internal BVT/Testing environment. Please do needful for "BreakingChange review"

[openapi-workflow-bot]

Hi, @t-vjanardhan your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).