Move RestorePoint properties into new properties bag for restore point #14638
Conversation
This file contains 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
roipmsft
requested review from
dkulkarni-ms,
grizzlytheodore,
haagha,
hyonholee,
madewithsmiles,
MS-syh2qs and
Sandido
as code owners
|
Hi, @roipmsft 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. vsswagger@microsoft.com |
|
[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. |
ghost
added
the
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2021-03-01 |
️️✔️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: 1 Errors, 0 Warnings failed [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: undefined => "$ref":"#/components/schemas/schemas:1443", "description":"The Offer Promotion Code." ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
| 💬 AutorestCore/Exception | "readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"Error: Plugin prechecker reported failure." |
| 💬 AutorestCore/Exception | "readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
| 💬 AutorestCore/Exception | "readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01-only", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01-only", "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).
Swagger Generation Artifacts
|
This was referenced Jun 2, 2021
|
Hi @roipmsft, 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. |
This was referenced Jun 21, 2021
smotwani
approved these changes
Jun 22, 2021
|
Sign off on the breaking changes for Go since it is inevitable |
ArcturusZhang
added
the
Approved-SdkBreakingChange-Go
yungezz
reviewed
Jul 1, 2021
| @@ -7657,6 +7661,28 @@ | |||
| }, | |||
| "RestorePoint": { | |||
| "properties": { | |||
| "properties": { | |||
| "x-ms-client-flatten": true, | |||
There was a problem hiding this comment.
just curious, why this property need x-ms-client-flatten true? this extension will impact sdk and cli generation
There was a problem hiding this comment.
@yungezz this is the pattern followed in the compute.json file
x-ms-client-flatten
https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md
This extension allows to flatten deeply nested payloads into a more user friendly object.
Can you please elaborate, what do you mean by 'impact sdk and cli generation'?
Does using "x-ms-client-flatten"=true break something?
There was a problem hiding this comment.
Customers are not using RestorePoint yet, so we dont have to worry about breaking changes for restore points
There was a problem hiding this comment.
what I mean is the extension will cause different generation logic in sdk/cli genertor, thus different interface.
There was a problem hiding this comment.
still not sure I understand, sorry.
Are you saying "x-ms-client-flatten"=true should never be used?
Am I using "x-ms-client-flatten"=true incorrectly?
Are there some cases, where it can be used, and other cases where it should not be used? What are those cases?
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
yungezz
approved these changes
Jul 1, 2021
|
From CI https://dev.azure.com/azure-sdk/internal/_build/results?buildId=975772&view=logs&j=f06b4322-f7bf-57ee-ecc5-6d0feac67556&t=7af1345c-d4bb-5f1b-a588-9fdc46884407, Swagger APIDocPreview task succeeded. |
This was referenced Jul 1, 2021
11 tasks
26 tasks
11 tasks
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Technically this PR has a breaking change for Restore Points. However, RestorePoint is only in private preview at the moment. No customer is relying on this API.
We will communicate to private preview customers that we will be making this breaking change.
Please ensure to add changelog with 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
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.
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.
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.