[EdgeOrder] Update 2020-12-01-preview swagger with swagger correctness fix and other changes #15962
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* new api changes * referer url change
* readme changes * Swagger refresh and update examples * Change examples as per oav validations * Minor swagger modifications * Minor spacing adjustments * Set ModelAsString to true for enums and modify examples * Fix swagger lint validation error * Modify readme and examples * Modify readme.go.md * Update swagger * Minor prettier fix * Change python package version in readme * Fix spell check error
…tem call using odata filter
changes to enable forward and reverse shipping details in get order i…
* Swagger correctness fix with other changes * Return api field additions * Change expand description for listOrderItem calls Co-authored-by: Vaishnavi Janardhan <[email protected]>
|
Hi, @vaishnavi-janardhan Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
|
[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. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| 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/preview/2020-12-01-preview/edgeorder.json#L3070 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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#L424 |
|
| 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#L709 |
|
| 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#L815 |
|
| 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/preview/2020-12-01-preview/edgeorder.json#L2207 |
|
| 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 |
|
| The tracked resource, 'AddressResource', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1260 |
|
| The tracked resource, 'OrderItemResource', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L2494 |
|
| The tracked resource, 'AddressResource', must have a list by subscriptions operation. Location: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L1260 |
|
| The tracked resource, 'OrderItemResource', must have a list by subscriptions operation. Location: Microsoft.EdgeOrder/preview/2020-12-01-preview/edgeorder.json#L2494 |
️️✔️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
️️✔️[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).
Swagger Generation Artifacts
|
|
Hi @vaishnavi-janardhan, 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. |
|
NewApiVersionRequired reason: |
|
Hi @vaishnavi-janardhan, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Sep 8, 2021
vaishnavi-janardhan
force-pushed
the
master
branch
from
ea58058 to
8d27682
Compare
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
Contributor
Author
|
Our service is currently in public preview. The modification of readonly parameters and optional parameters in the swagger and SDKs doesn't affect any customer. @jianyexi Please do needful for "BreakingChange review". |
Contributor
@vaishnavi-janardhan could u follow the action to get approval for the breaking change ? |
JeffreyRichter
added
the
Approved-BreakingChange
jianyexi
approved these changes
Oct 11, 2021
This was referenced Oct 12, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.
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.