-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
BugFix: Set readonly flag to false for non-read only properties in Guest Configuration #14999
Conversation
Hi, @aashish1987 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. |
Swagger Validation Report
|
Rule | Message |
---|---|
R2020 - RequiredPropertiesMissingInResourceModel |
Model definition 'GuestConfigurationAssignment' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L768 |
R2020 - RequiredPropertiesMissingInResourceModel |
Model definition 'GuestConfigurationAssignment' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json#L1047 |
R2020 - RequiredPropertiesMissingInResourceModel |
Model definition 'GuestConfigurationAssignment' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json#L768 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'GuestConfigurationAssignments_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L99 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'GuestConfigurationHCRPAssignments_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L440 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'GuestConfigurationAssignments_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L31 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'GuestConfigurationHCRPAssignments_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L372 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L184 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L525 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json#L184 |
️️✔️
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
|:speech_balloon: AutorestCore/Exception|"readme":"guestconfiguration/resource-manager/readme.md",
"tag":"package-2021-01-25",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"guestconfiguration/resource-manager/readme.md",
"tag":"package-2021-01-25",
"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":"guestconfiguration/resource-manager/readme.md",
"tag":"package-2021-01-25",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"guestconfiguration/resource-manager/readme.md",
"tag":"package-2020-06-25",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"guestconfiguration/resource-manager/readme.md",
"tag":"package-2020-06-25",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"guestconfiguration/resource-manager/readme.md",
"tag":"package-2018-11-20",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"guestconfiguration/resource-manager/readme.md",
"tag":"package-2018-11-20",
"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
|
Hi @aashish1987, 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. |
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2021-01-25/guestconfiguration.json
Outdated
Show resolved
Hide resolved
NewApiVersionRequired reason: |
"type": "string", | ||
"description": "Combined hash of the guest configuration package and configuration parameters." | ||
}, | ||
"assignmentType": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this assignmentType
property is same with the configurationMode
property, does it mean the configurationMode
property needs to be removed in this PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We never used configurationMode.
But since we already have it in swagger spec - we cannot delete it. BreakingChange team wont allow us to remove it.
I will work with my team and come up with a plan to remove the configurationMode section. Right now it wont harm it.
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json
Outdated
Show resolved
Hide resolved
...tion/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json
Show resolved
Hide resolved
…est Configuration (Azure#14999) * Bug-Fix: Remove read-only properties from Guest Configuration objects * Resolved PR comments. Updated examples * Add Assignment Type * Fix Prettier check Co-authored-by: Aashish Rajaram Salokhe <aasalokh@microsoft.com>
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.
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.