update etag and kind type #18652
Merged
update etag and kind type #18652
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
|
Hi, @vutran01 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. vscswagger@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 |
|---|---|
| 'GET' operation 'Workbooks_RevisionsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L337 |
|
| 'GET' operation 'Workbooks_RevisionGet' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L379 |
|
| The child tracked resource, 'revisions' with immediate parent 'Workbook', must have a list by immediate parent operation. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L472 |
|
| 'nextLink' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L466 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbooksList2 Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L75 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbooksList Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L129 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookGet Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L174 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookDelete Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L217 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookAdd Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L272 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbookUpdate Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L324 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/applicationinsights/resource-manager/readme.md tag: specification/applicationinsights/resource-manager/readme.md#tag-package-2022-04-01 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 6 Errors, 26 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.5)
- current:stable/2022-04-01/workbooks_API.json compared with base:stable/2021-08-01/workbooks_API.json
- current:stable/2022-04-01/workbooks_API.json compared with base:preview/2018-06-17-preview/workbooks_API.json
The following breaking changes are detected by comparison with latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
Hi @vutran01, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Apr 11, 2022
Closed
|
how can there be a LintDiff error on changing the description on a new api-version? does this means that the description can never be changed? |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @vutran01 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
Hi @vutran01, 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. |
It may caused by different model definition which has same name. @jianyexi to confirm |
|
@akning-ms and @jianyexi, anything we can do to push this along? |
jianyexi
reviewed
Apr 29, 2022
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the resource.", |
There was a problem hiding this comment.
To keep the description consistent, we should use the same description for the same parameter definition and avoid conflict. The lintDiff conflict is because the current description conflicts with below.
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json#L552 #Resolved
There was a problem hiding this comment.
@jianyexi, ah that makes sense, thanks
There was a problem hiding this comment.
@jianyexi and @akning-ms, please review this now that changes are made and the backend has been checked in and deployed
|
Hi, @vutran01. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove In reply to: 1126970112 |
ghost
added
JeffreyRichter
added
the
Approved-BreakingChange
NetRock
approved these changes
May 25, 2022
NetRock
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
This was referenced May 26, 2022
Merged
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
May 26, 2022
gargankit-microsoft
pushed a commit
that referenced
this pull request
May 26, 2022
* initial expected changes * remove additionalProperties from etag * rename property name
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
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 are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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.