Updated required and default fields in Action Groups spec #13677
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
added 10 commits
January 27, 2021 13:53
|
Hi, @ritwik8119 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 |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-2020-03 |
️️✔️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.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
- monitor/resource-manager/readme.md#package-2020-03
- monitor/resource-manager/readme.md#package-2019-11
- monitor/resource-manager/readme.md#package-2019-06
- monitor/resource-manager/readme.md#package-2019-03
- monitor/resource-manager/readme.md#package-2019-06-01-only
- monitor/resource-manager/readme.md#package-2019-03-01-only
| Rule | Message |
|---|---|
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2020-03", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, "$ref":"#/components/schemas/schemas:653", properties.etag: undefined => "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true, "$ref":"#/components/schemas/schemas:654" ; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2020-03", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-11", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, "$ref":"#/components/schemas/schemas:674", properties.etag: undefined => "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true, "$ref":"#/components/schemas/schemas:675" ; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-11", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-06", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, "$ref":"#/components/schemas/schemas:653", properties.etag: undefined => "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true, "$ref":"#/components/schemas/schemas:654" ; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-06", "details":"Error: Plugin prechecker reported failure." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-03", "details":"Duplicate Schema named Resource -- properties.kind: undefined => "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true, "$ref":"#/components/schemas/schemas:650", properties.etag: undefined => "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true, "$ref":"#/components/schemas/schemas:651" ; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2019-03", "details":"Error: Plugin prechecker reported failure." |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi @ritwik8119, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Mar 26, 2021
|
Hi @ritwik8119, 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 Mar 26, 2021
kairu-ms
approved these changes
Mar 29, 2021
kairu-ms
requested changes
Mar 29, 2021
...fication/monitor/resource-manager/Microsoft.Insights/stable/2019-06-01/actionGroups_API.json
Outdated
Show resolved
Hide resolved
...fication/monitor/resource-manager/Microsoft.Insights/stable/2019-06-01/actionGroups_API.json
Outdated
Show resolved
Hide resolved
...fication/monitor/resource-manager/Microsoft.Insights/stable/2019-06-01/actionGroups_API.json
Outdated
Show resolved
Hide resolved
...fication/monitor/resource-manager/Microsoft.Insights/stable/2019-06-01/actionGroups_API.json
Outdated
Show resolved
Hide resolved
|
@ritwik8119 Please fix CI issues. And this PR has breaking changes. Please create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki. |
|
@kairu-ms The changes being added here have already been in the the service implementation since the beginning, and we are only updating the spec now to bring it in line with the actual API response. Can this still be considered a breaking change? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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
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.