Swagger changes for Edge Order Service #12142

sashanm · 2020-12-16T11:19:38Z

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.

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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
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
- 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 API 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 version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

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 · 2020-12-16T11:19:40Z

Hi, @sashanm 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 cross api-version diff. See OpenAPI Hub Diff

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-pipeline-app · 2020-12-16T11:19:42Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️LintDiff: 29 Warnings warning [Detail]

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

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

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. New: resource-manager/Microsoft.EdgeOrder/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. New: resource-manager/Microsoft.EdgeOrder/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. New: resource-manager/Microsoft.EdgeOrder/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. New: resource-manager/Microsoft.EdgeOrder/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. New: resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json#L254
⚠️ R1003 - ListInOperationName	Since operation 'ListOrderCollectionsAtSubscriptionLevel' 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. New: resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json#L306
⚠️ R1003 - ListInOperationName	Since operation 'ListOrdersAtSubscriptionLevel' 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. New: resource-manager/Microsoft.EdgeOrder/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. New: resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json#L417
⚠️ R1003 - ListInOperationName	Since operation 'ListOrderCollectionsAtResourceGroupLevel' 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. New: resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json#L702
⚠️ R1003 - ListInOperationName	Since operation 'ListOrdersAtResourceGroupLevel' 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. New: resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json#L980

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

Validation passes for Avocado.

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

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

openapi-pipeline-app · 2020-12-16T11:19:42Z

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

ghost · 2020-12-16T11:19:43Z

Thank you for your contribution sashanm! We will review the pull request and get back to you soon.

openapi-workflow-bot · 2020-12-16T11:20:29Z

Hi, @sashanm 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 · 2020-12-16T11:22:12Z

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

swagger changes for Edge ordering

into ordering_swagger_changes

varunkumta · 2020-12-22T20:27:08Z

"Resource": {

consider re-using/ref'ing TrackedResource / ProxyResource from /common-types/resource-management/v2/types.json instead of duplicating

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:3159 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

...dgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/examples/AddressCreate.json

varunkumta · 2020-12-22T20:34:33Z

"ApiError": {

you can instead re-use ErrorResponse from common-types

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:1706 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

varunkumta · 2020-12-22T20:45:14Z

"Operation": {

also available in common-types

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:2431 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

varunkumta · 2020-12-22T20:52:57Z

          "$ref": "#/definitions/AddressResource"

I assume you have considered making this tracked vs proxy as per https://armwiki.azurewebsites.net/rp_onboarding/tracked_vs_proxy_resources.html?q=tracked - I don't see a need to make this tracked but making it proxy will mean it needs to be global since it is a top-level resource

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:513 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

varunkumta · 2020-12-22T20:54:19Z

        "description": "Address object."

specify schema for 200 response

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:566 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

varunkumta · 2020-12-22T20:58:30Z

    "contactDetails"

shippingAddress is not required?

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:1607 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

varunkumta · 2020-12-22T21:02:16Z

    "streetAddress1",

consider if you want to add other fields here like postalCode

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:3234 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

varunkumta · 2020-12-22T21:07:00Z

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/productFamiliesMetadata": {

as discussed you probably don't need the rg level api for this, since this is a read-only resource and depends only on sublevel properties, the rbac limitation (when user has access to only 1 rg in a sub) can be handled via the allowedUnauthorizedActions in your manifest

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:846 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

sashanm · 2020-12-29T04:23:14Z

    "error": {
Why error is part of OrderDetails?

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:2756 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

If we want to expose any service error details to customer

sashanm · 2020-12-29T04:24:13Z

      "description": "Customer address and contact details. It should be address resource"
This should be the resource Id rather then embedding the whole resource here, same for returnAddress.

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:1595 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

Yeah. Since we are supporting edit/delete of address resource. We might lose the address details if customer deletes it

sashanm · 2021-01-04T05:51:59Z

    "contactDetails"
shippingAddress is not required?

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:1607 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

In Airgap cloud, customer cannot disclose shipping address. Hence we made shipping address as option

sashanm · 2021-01-04T05:56:36Z

    "streetAddress1",
consider if you want to add other fields here like postalCode

Refers to: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json:3234 in 1d524fb. [](commit_id = 1d524fb, deletion_comment = False)

We are supporting countries without postal code like HongKong hence making postal code as optional

openapi-workflow-bot · 2021-01-11T08:40:59Z

Hi @sashanm, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

...dgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/examples/AddressCreate.json

openapi-workflow-bot · 2021-01-12T09:37:34Z

Hi @sashanm, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json

first commit for swagger

2401d9e

sashanm requested a review from lirenhe as a code owner December 16, 2020 11:19

openapi-assignment-bot bot assigned ruowan Dec 16, 2020

ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Dec 16, 2020

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 16, 2020

sashanm marked this pull request as draft December 16, 2020 11:23

sashanm and others added 9 commits December 16, 2020 17:00

Merge pull request #1 from sashanm/ordering_swagger_changes

2cbe693

swagger changes for Edge ordering

moved swagger to 2020-12-01-preview

799ad3f

updated readme

bf44211

fixed readme

992dc34

added missing examples

49f4618

updated readme

a59eecd

fixed prettier issues

80de99f

Merge branch 'master' of https://github.com/sashanm/azure-rest-api-specs

35511f3

into ordering_swagger_changes

minor fixes

1d524fb

varunkumta reviewed Dec 22, 2020

View reviewed changes

...dgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/examples/AddressCreate.json Outdated Show resolved Hide resolved

sashanm closed this Jan 4, 2021

sashanm reopened this Jan 4, 2021

Fixed ARM review comments

bfc45dd

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jan 11, 2021

sashanm marked this pull request as ready for review January 11, 2021 09:02

ruowan reviewed Jan 12, 2021

View reviewed changes

...dgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/examples/AddressCreate.json Show resolved Hide resolved

sashanm added 2 commits January 12, 2021 14:54

spell check fix

7afd58e

prettier check fix

4dc5fda

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 12, 2021

j5lim self-requested a review January 13, 2021 01:18

j5lim requested changes Jan 13, 2021

View reviewed changes

specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json Show resolved Hide resolved

specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json Show resolved Hide resolved

j5lim added the ARMChangesRequested label Jan 13, 2021

j5lim reviewed Jan 13, 2021

View reviewed changes

specification/edgeorder/resource-manager/Microsoft.EdgeOrder/2020-12-01-preview/edgeorder.json Outdated Show resolved Hide resolved

changed productfamily metadata Api to post

e4bd825

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Jan 13, 2021

j5lim approved these changes Jan 13, 2021

View reviewed changes

j5lim added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 13, 2021

ruowan removed the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Jan 18, 2021

ruowan merged commit 1ef3366 into Azure:master Jan 18, 2021

leniatgh mentioned this pull request Jan 20, 2021

correct swagger path #12510

Merged

25 tasks

Swagger changes for Edge Order Service #12142

Swagger changes for Edge Order Service #12142

Uh oh!

Conversation

sashanm commented Dec 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Dec 16, 2020

Uh oh!

openapi-pipeline-app bot commented Dec 16, 2020 • 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 Dec 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Dec 16, 2020

Uh oh!

openapi-workflow-bot bot commented Dec 16, 2020

Uh oh!

openapi-workflow-bot bot commented Dec 16, 2020

Uh oh!

varunkumta commented Dec 22, 2020

Uh oh!

Uh oh!

varunkumta commented Dec 22, 2020

Uh oh!

varunkumta commented Dec 22, 2020

Uh oh!

varunkumta commented Dec 22, 2020

Uh oh!

varunkumta commented Dec 22, 2020

Uh oh!

varunkumta commented Dec 22, 2020

Uh oh!

varunkumta commented Dec 22, 2020

Uh oh!

varunkumta commented Dec 22, 2020

Uh oh!

sashanm commented Dec 29, 2020

Uh oh!

sashanm commented Dec 29, 2020

Uh oh!

sashanm commented Jan 4, 2021

Uh oh!

sashanm commented Jan 4, 2021

Uh oh!

openapi-workflow-bot bot commented Jan 11, 2021

Uh oh!

Uh oh!

openapi-workflow-bot bot commented Jan 12, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

sashanm commented Dec 16, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 16, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 16, 2020 •

edited

Loading